Download OpenAPI specification:Download
Fetch all exchanges and their corresponding working schedules that your account has access to
OK
Bad API key
Scope( metadata ) missing for API key
Timed-out
Limited: 1 / 30s
[- {
- "id": 0,
- "name": "string",
- "workingSchedules": [
- {
- "id": 0,
- "timeEvents": [
- {
- "date": "2019-08-24T14:15:22Z",
- "type": "OPEN"
}
]
}
]
}
]
Fetch all instruments that your account has access to
OK
Bad API key
Scope( metadata ) missing for API key
Timed-out
Limited: 1 / 50s
[- {
- "addedOn": "2019-08-24T14:15:22Z",
- "currencyCode": "USD",
- "isin": "string",
- "maxOpenQuantity": 0,
- "minTradeQuantity": 0,
- "name": "string",
- "shortName": "string",
- "ticker": "AAPL_US_EQ",
- "type": "ETF",
- "workingScheduleId": 0
}
]
Fetches all pies for the account
OK
Bad API key
Scope( pies:read ) missing for API key
Timed-out
Limited: 1 / 30s
[- {
- "cash": 0,
- "dividendDetails": {
- "gained": 0,
- "inCash": 0,
- "reinvested": 0
}, - "id": 0,
- "progress": 0.5,
- "result": {
- "priceAvgInvestedValue": 0,
- "priceAvgResult": 0,
- "priceAvgResultCoef": 0,
- "priceAvgValue": 0
}, - "status": "AHEAD"
}
]
Creates a pie for the account by given params
OK
Bad create request
Bad API key
Scope( pies:write ) missing for API key
Timed-out
Limited: 1 / 5s
{- "dividendCashAction": "REINVEST",
- "endDate": "2019-08-24T14:15:22Z",
- "goal": 0,
- "icon": "string",
- "instrumentShares": {
- "AAPL_US_EQ": 0.5,
- "MSFT_US_EQ": 0.5
}, - "name": "string"
}
{- "instruments": [
- {
- "currentShare": 0,
- "expectedShare": 0,
- "issues": [
- {
- "name": "DELISTED",
- "severity": "IRREVERSIBLE"
}
], - "ownedQuantity": 0,
- "result": {
- "priceAvgInvestedValue": 0,
- "priceAvgResult": 0,
- "priceAvgResultCoef": 0,
- "priceAvgValue": 0
}, - "ticker": "string"
}
], - "settings": {
- "creationDate": "2019-08-24T14:15:22Z",
- "dividendCashAction": "REINVEST",
- "endDate": "2019-08-24T14:15:22Z",
- "goal": 0,
- "icon": "string",
- "id": 0,
- "initialInvestment": 0,
- "instrumentShares": {
- "property1": 0,
- "property2": 0
}, - "name": "string",
- "publicUrl": "string"
}
}
Fetches a pies for the account with detailed information
OK
Bad API key
Scope( pies:read ) missing for API key
Timed-out
Limited: 1 / 5s
{- "instruments": [
- {
- "currentShare": 0,
- "expectedShare": 0,
- "issues": [
- {
- "name": "DELISTED",
- "severity": "IRREVERSIBLE"
}
], - "ownedQuantity": 0,
- "result": {
- "priceAvgInvestedValue": 0,
- "priceAvgResult": 0,
- "priceAvgResultCoef": 0,
- "priceAvgValue": 0
}, - "ticker": "string"
}
], - "settings": {
- "creationDate": "2019-08-24T14:15:22Z",
- "dividendCashAction": "REINVEST",
- "endDate": "2019-08-24T14:15:22Z",
- "goal": 0,
- "icon": "string",
- "id": 0,
- "initialInvestment": 0,
- "instrumentShares": {
- "property1": 0,
- "property2": 0
}, - "name": "string",
- "publicUrl": "string"
}
}
Updates a pie for the account by given params
OK
Bad update request
Bad API key
Scope( pies:write ) missing for API key
Timed-out
Limited: 1 / 5s
{- "dividendCashAction": "REINVEST",
- "endDate": "2019-08-24T14:15:22Z",
- "goal": 0,
- "icon": "string",
- "instrumentShares": {
- "AAPL_US_EQ": 0.5,
- "MSFT_US_EQ": 0.5
}, - "name": "string"
}
{- "instruments": [
- {
- "currentShare": 0,
- "expectedShare": 0,
- "issues": [
- {
- "name": "DELISTED",
- "severity": "IRREVERSIBLE"
}
], - "ownedQuantity": 0,
- "result": {
- "priceAvgInvestedValue": 0,
- "priceAvgResult": 0,
- "priceAvgResultCoef": 0,
- "priceAvgValue": 0
}, - "ticker": "string"
}
], - "settings": {
- "creationDate": "2019-08-24T14:15:22Z",
- "dividendCashAction": "REINVEST",
- "endDate": "2019-08-24T14:15:22Z",
- "goal": 0,
- "icon": "string",
- "id": 0,
- "initialInvestment": 0,
- "instrumentShares": {
- "property1": 0,
- "property2": 0
}, - "name": "string",
- "publicUrl": "string"
}
}
Duplicates a pie for the account
OK
Bad update request
Bad API key
Scope( pies:write ) missing for API key
Timed-out
Limited: 1 / 5s
{- "icon": "string",
- "name": "string"
}
{- "instruments": [
- {
- "currentShare": 0,
- "expectedShare": 0,
- "issues": [
- {
- "name": "DELISTED",
- "severity": "IRREVERSIBLE"
}
], - "ownedQuantity": 0,
- "result": {
- "priceAvgInvestedValue": 0,
- "priceAvgResult": 0,
- "priceAvgResultCoef": 0,
- "priceAvgValue": 0
}, - "ticker": "string"
}
], - "settings": {
- "creationDate": "2019-08-24T14:15:22Z",
- "dividendCashAction": "REINVEST",
- "endDate": "2019-08-24T14:15:22Z",
- "goal": 0,
- "icon": "string",
- "id": 0,
- "initialInvestment": 0,
- "instrumentShares": {
- "property1": 0,
- "property2": 0
}, - "name": "string",
- "publicUrl": "string"
}
}
OK
Bad API key
Scope( orders:read ) missing for API key
Timed-out
Limited: 1 / 5s
[- {
- "creationTime": "2019-08-24T14:15:22Z",
- "filledQuantity": 0,
- "filledValue": 0,
- "id": 0,
- "limitPrice": 0,
- "quantity": 0,
- "status": "LOCAL",
- "stopPrice": 0,
- "strategy": "QUANTITY",
- "ticker": "AAPL_US_EQ",
- "type": "LIMIT",
- "value": 0
}
]
OK
Failed validation
Bad API key
Scope( orders:execute ) missing for API key
Timed-out
Limited: 1 / 2s
{- "limitPrice": 100.23,
- "quantity": 0.1,
- "ticker": "AAPL_US_EQ",
- "timeValidity": "DAY"
}
{- "creationTime": "2019-08-24T14:15:22Z",
- "filledQuantity": 0,
- "filledValue": 0,
- "id": 0,
- "limitPrice": 0,
- "quantity": 0,
- "status": "LOCAL",
- "stopPrice": 0,
- "strategy": "QUANTITY",
- "ticker": "AAPL_US_EQ",
- "type": "LIMIT",
- "value": 0
}
OK
Failed validation
Bad API key
Scope( orders:execute ) missing for API key
Timed-out
Limited: 1 / 1s
{- "quantity": 0.1,
- "ticker": "AAPL_US_EQ"
}
{- "creationTime": "2019-08-24T14:15:22Z",
- "filledQuantity": 0,
- "filledValue": 0,
- "id": 0,
- "limitPrice": 0,
- "quantity": 0,
- "status": "LOCAL",
- "stopPrice": 0,
- "strategy": "QUANTITY",
- "ticker": "AAPL_US_EQ",
- "type": "LIMIT",
- "value": 0
}
OK
Failed validation
Bad API key
Scope( orders:execute ) missing for API key
Timed-out
Limited: 1 / 2s
{- "quantity": 0.1,
- "stopPrice": 100.23,
- "ticker": "AAPL_US_EQ",
- "timeValidity": "DAY"
}
{- "creationTime": "2019-08-24T14:15:22Z",
- "filledQuantity": 0,
- "filledValue": 0,
- "id": 0,
- "limitPrice": 0,
- "quantity": 0,
- "status": "LOCAL",
- "stopPrice": 0,
- "strategy": "QUANTITY",
- "ticker": "AAPL_US_EQ",
- "type": "LIMIT",
- "value": 0
}
OK
Failed validation
Bad API key
Scope( orders:execute ) missing for API key
Timed-out
Limited: 1 / 2s
{- "limitPrice": 100.23,
- "quantity": 0.1,
- "stopPrice": 100.23,
- "ticker": "AAPL_US_EQ",
- "timeValidity": "DAY"
}
{- "creationTime": "2019-08-24T14:15:22Z",
- "filledQuantity": 0,
- "filledValue": 0,
- "id": 0,
- "limitPrice": 0,
- "quantity": 0,
- "status": "LOCAL",
- "stopPrice": 0,
- "strategy": "QUANTITY",
- "ticker": "AAPL_US_EQ",
- "type": "LIMIT",
- "value": 0
}
Order found
Bad API key
Scope( orders:read ) missing for API key
Order not found
Timed-out
Limited: 1 / 1s
{- "creationTime": "2019-08-24T14:15:22Z",
- "filledQuantity": 0,
- "filledValue": 0,
- "id": 0,
- "limitPrice": 0,
- "quantity": 0,
- "status": "LOCAL",
- "stopPrice": 0,
- "strategy": "QUANTITY",
- "ticker": "AAPL_US_EQ",
- "type": "LIMIT",
- "value": 0
}
OK
Bad API key
Scope( account ) missing for API key
Timed-out
Limited: 1 / 2s
{- "blocked": 0,
- "free": 0,
- "invested": 0,
- "pieCash": 0,
- "ppl": 0,
- "result": 0,
- "total": 0
}
Fetch an open positions for your account
OK
Bad API key
Scope( portfolio ) missing for API key
Timed-out
Limited: 1 / 5s
[- {
- "averagePrice": 0,
- "currentPrice": 0,
- "frontend": "API",
- "fxPpl": 0,
- "initialFillDate": "2019-08-24T14:15:22Z",
- "maxBuy": 0,
- "maxSell": 0,
- "pieQuantity": 0,
- "ppl": 0,
- "quantity": 0,
- "ticker": "AAPL_US_EQ"
}
]
Search for a open position by ticker
OK
Invalid ticker supplied
Bad API key
Scope( portfolio ) missing for API key
No open position with that ticker
Timed-out
Limited: 1 / 1s
{- "ticker": "string"
}
{- "averagePrice": 0,
- "currentPrice": 0,
- "frontend": "API",
- "fxPpl": 0,
- "initialFillDate": "2019-08-24T14:15:22Z",
- "maxBuy": 0,
- "maxSell": 0,
- "pieQuantity": 0,
- "ppl": 0,
- "quantity": 0,
- "ticker": "AAPL_US_EQ"
}
Fetch an open position by ticker
OK
Invalid ticker supplied
Bad API key
Scope( portfolio ) missing for API key
No open position with that ticker
Timed-out
Limited: 1 / 1s
{- "averagePrice": 0,
- "currentPrice": 0,
- "frontend": "API",
- "fxPpl": 0,
- "initialFillDate": "2019-08-24T14:15:22Z",
- "maxBuy": 0,
- "maxSell": 0,
- "pieQuantity": 0,
- "ppl": 0,
- "quantity": 0,
- "ticker": "AAPL_US_EQ"
}
OK
Bad filtering arguments
Bad API key
Scope( history:orders ) missing for API key
Timed-out
Limited: 6 / 1m0s
{- "items": [
- {
- "dateCreated": "2019-08-24T14:15:22Z",
- "dateExecuted": "2019-08-24T14:15:22Z",
- "dateModified": "2019-08-24T14:15:22Z",
- "executor": "API",
- "fillCost": 0,
- "fillId": 0,
- "fillPrice": 0,
- "fillResult": 0,
- "fillType": "TOTV",
- "filledQuantity": 0,
- "filledValue": 0,
- "id": 0,
- "limitPrice": 0,
- "orderedQuantity": 0,
- "orderedValue": 0,
- "parentOrder": 0,
- "status": "LOCAL",
- "stopPrice": 0,
- "taxes": [
- {
- "fillId": "string",
- "name": "COMMISSION_TURNOVER",
- "quantity": 0,
- "timeCharged": "2019-08-24T14:15:22Z"
}
], - "ticker": "string",
- "timeValidity": "DAY",
- "type": "LIMIT"
}
], - "nextPagePath": "string"
}
OK
Bad filtering arguments
Bad API key
Scope( history:dividends ) missing for API key
Timed-out
Limited: 6 / 1m0s
{- "items": [
- {
- "amount": 0,
- "amountInEuro": 0,
- "grossAmountPerShare": 0,
- "paidOn": "2019-08-24T14:15:22Z",
- "quantity": 0,
- "reference": "string",
- "ticker": "string",
- "type": "string"
}
], - "nextPagePath": "string"
}
Lists detailed information about all csv account exports
OK
Bad filtering arguments
Bad API key
Missing Permissions
Timed-out
Limited: 1 / 1m0s
[- {
- "dataIncluded": {
- "includeDividends": true,
- "includeInterest": true,
- "includeOrders": true,
- "includeTransactions": true
}, - "downloadLink": "string",
- "reportId": 0,
- "status": "Queued",
- "timeFrom": "2019-08-24T14:15:22Z",
- "timeTo": "2019-08-24T14:15:22Z"
}
]
Request a csv export of the account's orders, dividends and transactions history
OK
Bad filtering arguments
Bad API key
Missing Permissions
Timed-out
Limited: 1 / 30s
{- "dataIncluded": {
- "includeDividends": true,
- "includeInterest": true,
- "includeOrders": true,
- "includeTransactions": true
}, - "timeFrom": "2019-08-24T14:15:22Z",
- "timeTo": "2019-08-24T14:15:22Z"
}
{- "reportId": 0
}
Fetch superficial information about movements to and from your account
OK
Bad filtering arguments
Bad API key
Scope( history:transactions ) missing for API key
Timed-out
Limited: 6 / 1m0s
{- "items": [
- {
- "amount": 0,
- "dateTime": "2019-08-24T14:15:22Z",
- "reference": "string",
- "type": "WITHDRAW"
}
], - "nextPagePath": "string"
}