BinckBank.OpenApi API Reference
BinckBank OpenAPI is an API Platform to access BinckBank's trading services.
Curious? Request your access key after reading the documentation on Github: https://github.com/binckbank-api/client-js#binck-openapi-documentation
API Endpoint
http://api.sandbox.binckbank.nvSchemes: http
Version: v1
Authentication
oauth2
OAuth2 Authorization Code Grant
Read access to account(s) with portfolio.
writeAccess to ordering.
internalInternal use.
newsAccess to news.
quotesAccess to quotes.
Accounts
All
Get all the active accounts of the customer. If there is no account, the collection will be empty.
[OK] A list of the accounts.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"accountsCollection": {
"accounts": [
{
"name": "string",
"iban": "string",
"number": "string",
"type": "string",
"isReadOnly": "boolean"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Account info
Get the specific account details. Only active accounts are returned.
The account number.
[OK] The account is successfully retrieved.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[NotFound] The account is not found.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"accountsCollection": {
"accounts": [
{
"name": "string",
"iban": "string",
"number": "string",
"type": "string",
"isReadOnly": "boolean"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (404 Not Found)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Balances
Balance info
Get the balance for a specific account. This call can be used to get the spending limit and total asset value.
The account number.
[OK] The balance is successfully retrieved.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[NotFound] The account is not found.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"balancesCollection": {
"balances": [
{
"assetsTotalValue": "number (double)",
"cashBalance": "number (double)",
"portfolioValue": "number (double)",
"availableSpendingLimit": "number (double)",
"availableSpendingLimitSrd": "number (double)",
"cashBalancesCollection": {
"cashBalances": [
{
"currency": "string",
"cashBalance": "number (double)"
}
]
}
}
],
"currency": "string"
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (404 Not Found)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Instruments
Find instrument
Get instrument information. Parameter 'SearchText', or 'Isin' is required. 'Type' is optional, 'Mic' can only be used together with 'Isin'.
When set to true, the response will include a table with the TickSizes for the instrument, default = false
Mandatory account number
Additional optional filter on instrument type. Cannot be used alone.
Case insensitive search text, minimum length 2. Cannot be used in combination with 'Isin'.
Selection on isinCode. Cannot be used in combination with 'SearchText'.
Additional optional selection on Market Identification Code, to be used only in combination with 'Isin'
Paging parameter to retrieve a subset of the complete collection. Format is <offset>-<limit>. Both values are an offset from the first entry of the complete collection. The first entry has offset '0'. (e.g. 12-21)
[OK] A list of 1 or more instruments.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"instrumentsCollection": {
"instruments": [
{
"id": "string",
"name": "string",
"symbol": "string",
"isincode": "string",
"type": "string",
"marketIdentificationCode": "string",
"derivativesInfo": {
"underlyingInstrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
},
"srdInfo": {
"underlyingInstrumentId": "string"
},
"bondInfo": {},
"leveragedProduct": {
"bonus": "number (double)",
"cap": "number (double)",
"endedDateTime": "string (date-time)",
"exchangeRatio": "number (double)",
"financingLevel": "number (double)",
"leverage": "number (double)",
"remainingValue": "number (double)",
"stopLossLevel": "number (double)",
"stopLossLevel2": "number (double)",
"strike": "number (double)"
},
"currency": "string",
"priceDecimals": "integer (int64)",
"tickerSymbol": "string",
"isTradable": "boolean",
"isKidApplicable": "boolean",
"tickSizeCollection": {
"tickSizes": [
{
"from": "number (double)",
"size": "number (double)"
}
]
},
"hasOptions": "boolean",
"hasFutures": "boolean",
"hasSrd": "boolean",
"hasLeveragedProducts": "boolean",
"hasOrderModifications": "boolean"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Instrument info
Get instrument information for a specific instrument. Multiple instruments can be retrieved if separated by comma, for example to get the instrument data from the positions (GET /instruments/{id1,id2}).
Ids of the equity to retrieve. If there are multiple ids, separate them by commas.
When set to true, the response will include a table with the TickSizes for the instrument, default = false
Mandatory account number
[OK] The instrument information is successfully retrieved.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[NotFound] The instrument is not found.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"instrumentsCollection": {
"instruments": [
{
"id": "string",
"name": "string",
"symbol": "string",
"isincode": "string",
"type": "string",
"marketIdentificationCode": "string",
"derivativesInfo": {
"underlyingInstrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
},
"srdInfo": {
"underlyingInstrumentId": "string"
},
"bondInfo": {},
"leveragedProduct": {
"bonus": "number (double)",
"cap": "number (double)",
"endedDateTime": "string (date-time)",
"exchangeRatio": "number (double)",
"financingLevel": "number (double)",
"leverage": "number (double)",
"remainingValue": "number (double)",
"stopLossLevel": "number (double)",
"stopLossLevel2": "number (double)",
"strike": "number (double)"
},
"currency": "string",
"priceDecimals": "integer (int64)",
"tickerSymbol": "string",
"isTradable": "boolean",
"isKidApplicable": "boolean",
"tickSizeCollection": {
"tickSizes": [
{
"from": "number (double)",
"size": "number (double)"
}
]
},
"hasOptions": "boolean",
"hasFutures": "boolean",
"hasSrd": "boolean",
"hasLeveragedProducts": "boolean",
"hasOrderModifications": "boolean"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (404 Not Found)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Instrument list
Get a predefined list of instruments. List are a fast way to retrieve a group of instruments. Count in the response might be an 'educated guess'.
id of the list
When set to true, the response will include a table with the TickSizes for the instrument, default = false
If specified, the response contains only instruments with this MarketIdentificationCode
Mandatory account number
Paging parameter to retrieve a subset of the complete collection. Format is <offset>-<limit>. Both values are an offset from the first entry of the complete collection. The first entry has offset '0'. (e.g. 12-21)
[OK] A list of 1 or more instruments.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[NotFound] The list is not found.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"instrumentsCollection": {
"instruments": [
{
"id": "string",
"name": "string",
"symbol": "string",
"isincode": "string",
"type": "string",
"marketIdentificationCode": "string",
"derivativesInfo": {
"underlyingInstrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
},
"srdInfo": {
"underlyingInstrumentId": "string"
},
"bondInfo": {},
"leveragedProduct": {
"bonus": "number (double)",
"cap": "number (double)",
"endedDateTime": "string (date-time)",
"exchangeRatio": "number (double)",
"financingLevel": "number (double)",
"leverage": "number (double)",
"remainingValue": "number (double)",
"stopLossLevel": "number (double)",
"stopLossLevel2": "number (double)",
"strike": "number (double)"
},
"currency": "string",
"priceDecimals": "integer (int64)",
"tickerSymbol": "string",
"isTradable": "boolean",
"isKidApplicable": "boolean",
"tickSizeCollection": {
"tickSizes": [
{
"from": "number (double)",
"size": "number (double)"
}
]
},
"hasOptions": "boolean",
"hasFutures": "boolean",
"hasSrd": "boolean",
"hasLeveragedProducts": "boolean",
"hasOrderModifications": "boolean"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (404 Not Found)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Leveraged products
Get instrument information for leveraged products like Turbo's. Provide one or more filter criteria in the query parameters. When a filter value is not specified, the default value is used.
When set to true, the response will include a table with the TickSizes for the instrument, default = false
Mandatory account number
Name of the publishing company, default is 'binckBank'
Long or short, default is 'all' (both long and short)
Category, default is 'indices'
Specifies type (Turbo or XL), default is 'all' (both Turbo and XL)
Specifies minimum stop loss
Specifies maximum stop loss
Paging parameter to retrieve a subset of the complete collection. Format is <offset>-<limit>. Both values are an offset from the first entry of the complete collection. The first entry has offset '0'. (e.g. 12-21)
[OK] A list of instruments.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"instrumentsCollection": {
"instruments": [
{
"id": "string",
"name": "string",
"symbol": "string",
"isincode": "string",
"type": "string",
"marketIdentificationCode": "string",
"derivativesInfo": {
"underlyingInstrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
},
"srdInfo": {
"underlyingInstrumentId": "string"
},
"bondInfo": {},
"leveragedProduct": {
"bonus": "number (double)",
"cap": "number (double)",
"endedDateTime": "string (date-time)",
"exchangeRatio": "number (double)",
"financingLevel": "number (double)",
"leverage": "number (double)",
"remainingValue": "number (double)",
"stopLossLevel": "number (double)",
"stopLossLevel2": "number (double)",
"strike": "number (double)"
},
"currency": "string",
"priceDecimals": "integer (int64)",
"tickerSymbol": "string",
"isTradable": "boolean",
"isKidApplicable": "boolean",
"tickSizeCollection": {
"tickSizes": [
{
"from": "number (double)",
"size": "number (double)"
}
]
},
"hasOptions": "boolean",
"hasFutures": "boolean",
"hasSrd": "boolean",
"hasLeveragedProducts": "boolean",
"hasOrderModifications": "boolean"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Certificates
Get certificate information. Provide a name for the Exchange, when no name is specified, the default (SeDeX) will be used
When set to true, the response will include a table with the TickSizes for the instrument, default = false
Mandatory account number
Name of the Exchange, default is 'certificatesSeDeX'
Paging parameter to retrieve a subset of the complete collection. Format is <offset>-<limit>. Both values are an offset from the first entry of the complete collection. The first entry has offset '0'. (e.g. 12-21)
[OK] A list of 1 or more instruments.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"instrumentsCollection": {
"instruments": [
{
"id": "string",
"name": "string",
"symbol": "string",
"isincode": "string",
"type": "string",
"marketIdentificationCode": "string",
"derivativesInfo": {
"underlyingInstrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
},
"srdInfo": {
"underlyingInstrumentId": "string"
},
"bondInfo": {},
"leveragedProduct": {
"bonus": "number (double)",
"cap": "number (double)",
"endedDateTime": "string (date-time)",
"exchangeRatio": "number (double)",
"financingLevel": "number (double)",
"leverage": "number (double)",
"remainingValue": "number (double)",
"stopLossLevel": "number (double)",
"stopLossLevel2": "number (double)",
"strike": "number (double)"
},
"currency": "string",
"priceDecimals": "integer (int64)",
"tickerSymbol": "string",
"isTradable": "boolean",
"isKidApplicable": "boolean",
"tickSizeCollection": {
"tickSizes": [
{
"from": "number (double)",
"size": "number (double)"
}
]
},
"hasOptions": "boolean",
"hasFutures": "boolean",
"hasSrd": "boolean",
"hasLeveragedProducts": "boolean",
"hasOrderModifications": "boolean"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Bonds
Get Bonds information. Provide a name for the Type
When set to true, the response will include a table with the TickSizes for the instrument, default = false
Mandatory account number
Name of the Bonds type
Paging parameter to retrieve a subset of the complete collection. Format is <offset>-<limit>. Both values are an offset from the first entry of the complete collection. The first entry has offset '0'. (e.g. 12-21)
[OK] A list of 1 or more instruments.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"instrumentsCollection": {
"instruments": [
{
"id": "string",
"name": "string",
"symbol": "string",
"isincode": "string",
"type": "string",
"marketIdentificationCode": "string",
"derivativesInfo": {
"underlyingInstrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
},
"srdInfo": {
"underlyingInstrumentId": "string"
},
"bondInfo": {},
"leveragedProduct": {
"bonus": "number (double)",
"cap": "number (double)",
"endedDateTime": "string (date-time)",
"exchangeRatio": "number (double)",
"financingLevel": "number (double)",
"leverage": "number (double)",
"remainingValue": "number (double)",
"stopLossLevel": "number (double)",
"stopLossLevel2": "number (double)",
"strike": "number (double)"
},
"currency": "string",
"priceDecimals": "integer (int64)",
"tickerSymbol": "string",
"isTradable": "boolean",
"isKidApplicable": "boolean",
"tickSizeCollection": {
"tickSizes": [
{
"from": "number (double)",
"size": "number (double)"
}
]
},
"hasOptions": "boolean",
"hasFutures": "boolean",
"hasSrd": "boolean",
"hasLeveragedProducts": "boolean",
"hasOrderModifications": "boolean"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Derivatives
Get the series for a derivatives class (options/futures). This endpoint can be used to get an option or future sheet. If there are two classes with the same symbol, mic and currency but different contract size (due to a corporate action), there are two sheets in the response.
Mandatory account number
Selection on symbol. Cannot be used in combination with 'UnderlyingInstrumentId'.
Selection on the ID of the underlying equity. Cannot be used in combination with 'symbol'.
Can be used in combination with symbol to specify the market.
Can be used in combination with symbol to specify the currency.
Paging parameter to retrieve a subset of the complete collection. Format is <offset>-<limit>. Both values are an offset from the first entry of the complete collection. The first entry has offset '0'. (e.g. 12-21)
[OK] A list of derivative series information.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"derivativesCollection": {
"classes": [
{
"underlyingInstrumentId": "string",
"name": "string",
"symbol": "string",
"isincode": "string",
"marketIdentificationCode": "string",
"currency": "string",
"type": "string",
"contractSize": "number (double)",
"series": [
{
"instrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
}
]
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
KID availability
Get KID document information for an instrument. Use this for instruments which have the isKidApplicable flag set to true. This endpoint searches for documentation. Still, it might be the case there is no documentation for a specific instrument, in the language of the customer. It can also be the case there are multiple documents for a certain instrument.
Id of the instrument.
Mandatory account number
[OK] The instrument information is successfully retrieved.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[NotFound] The instrument or KID document is not found.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"kidCollection": {
"kids": [
{
"name": "string",
"kidId": "string"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (404 Not Found)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
KID document
Get KID document. The document is a PDF file.
Id of the equity to retrieve.
Id of the Kid document.
Mandatory account number
[OK] The instrument information is successfully retrieved.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[NotFound] The instrument or KID document is not found.
Response Content-Types: attachment/PDF
Response Example (200 OK)
"string (byte)"
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (404 Not Found)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
News
All
Get news for the specified selection. The first 250 news messages for the selection in the news history are available.
Mandatory account number
Optional start date, if left out, fromDate will be today. If no instrument ids are supplied, only dates from the last month are accepted, otherwise only dates from the last week are accepted.
Optional end date, do not combine with instruments.
Optional ids of the instruments to retrieve. If there are multiple ids, separate them by commas.
Paging parameter to retrieve a subset of the complete collection. Format is <offset>-<limit>. Both values are an offset from the first entry of the complete collection. The first entry has offset '0'. (e.g. 12-21)
[OK] A list of the news messages.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[NotFound] The account is not found.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"newsCollection": {
"news": [
{
"culture": "string",
"headline": "string",
"body": "string",
"format": "string",
"publishedDateTime": "string (date-time)",
"instrumentIds": [
"string"
]
}
]
},
"newsSubscriptionCollection": {
"subscriptions": [
{
"newsSubscription": "string"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (404 Not Found)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Orders
Recent
Get all active/recent orders of an account. The response contains the active, cancelled and recent orders. If there is no order, the collection will be empty.
The account number.
Status 'all' will select all the orders. Other possible values are 'open', 'executed' and 'canceled'.
When set to True, orders will include a detailed status history overview. When set to false the response doesn't contain the status history, but the request will be handled faster. Default is True.
Paging parameter to retrieve a subset of the complete collection. Format is <offset>-<limit>. Both values are an offset from the first entry of the complete collection. The first entry has offset '0'. (e.g. 12-21)
[OK] A list of the orders.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"ordersCollection": {
"orders": [
{
"number": "integer (int64)",
"instrument": {
"id": "string",
"name": "string"
},
"type": "string",
"statusHistory": [
{
"dateTime": "string (date-time)",
"status": "string",
"executedQuantity": "number (double)",
"executionPrice": "number (double)"
}
],
"currency": "string",
"duration": "string",
"line": "integer (int64)",
"side": "string",
"executedQuantity": "number (double)",
"limitPrice": "number (double)",
"averagePrice": "number (double)",
"quantity": "number (double)",
"expirationDate": "string (date-time)",
"lastStatus": "string",
"lastStatusDateTime": "string (date-time)",
"stopPrice": "number (double)",
"fixingPrice": "number (double)",
"condition": "string",
"referenceId": "string"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
New
Register an order to sent to the market. This order will be sent to the market and executed according to the specifications. Something to be aware of: the response of this call might arrive after the order event from the realtime feed.
Specifications to be used for the order.
An account number to register the order.
Request Content-Types: application/json, text/json
Request Example
{
"type": "string",
"quantity": "number (double)",
"duration": "string",
"expirationDate": "string (date-time)",
"limitPrice": "number (double)",
"stopPrice": "number (double)",
"cash": {
"side": "string",
"instrumentId": "string"
},
"srd": {
"side": "string",
"instrumentId": "string"
},
"option": {
"condition": "string",
"leg1": {
"side": "string",
"instrumentId": "string"
},
"leg2": {
"side": "string",
"instrumentId": "string"
}
},
"future": {
"side": "string",
"instrumentId": "string"
},
"validationCode": "string",
"referenceId": "string"
}
[Created] Order is successfully registered.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[Unprocessable Entity] The request is valid but the order can not be validated. See response body for more detail.
Response Content-Types: application/json, text/json
Response Example (201 Created)
{
"ordersCollection": {
"orders": [
{
"number": "integer (int64)",
"instrument": {
"id": "string",
"name": "string"
},
"type": "string",
"statusHistory": [
{
"dateTime": "string (date-time)",
"status": "string",
"executedQuantity": "number (double)",
"executionPrice": "number (double)"
}
],
"currency": "string",
"duration": "string",
"line": "integer (int64)",
"side": "string",
"executedQuantity": "number (double)",
"limitPrice": "number (double)",
"averagePrice": "number (double)",
"quantity": "number (double)",
"expirationDate": "string (date-time)",
"lastStatus": "string",
"lastStatusDateTime": "string (date-time)",
"stopPrice": "number (double)",
"fixingPrice": "number (double)",
"condition": "string",
"referenceId": "string"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (422 Unprocessable Entity)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
History
Get all the historical orders of an account. The response contains the historical orders of the requested month. If there is no order yet, the collection will be empty.
The account number.
The year for which the historical orders should be retrieved
The month for which the historical orders should be retrieved
Paging parameter to retrieve a subset of the complete collection. Format is <offset>-<limit>. Both values are an offset from the first entry of the complete collection. The first entry has offset '0'. (e.g. 12-21)
[OK] A list of the orders.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"ordersCollection": {
"orders": [
{
"number": "integer (int64)",
"instrument": {
"id": "string",
"name": "string"
},
"type": "string",
"statusHistory": [
{
"dateTime": "string (date-time)",
"status": "string",
"executedQuantity": "number (double)",
"executionPrice": "number (double)"
}
],
"currency": "string",
"duration": "string",
"line": "integer (int64)",
"side": "string",
"executedQuantity": "number (double)",
"limitPrice": "number (double)",
"averagePrice": "number (double)",
"quantity": "number (double)",
"expirationDate": "string (date-time)",
"lastStatus": "string",
"lastStatusDateTime": "string (date-time)",
"stopPrice": "number (double)",
"fixingPrice": "number (double)",
"condition": "string",
"referenceId": "string"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Order info
Get a specific order for an account. If the order has multiple legs, multiple order objects are returned.
The account number used to register the order.
The order number for this account.
When set to True, order will include a detailed status history overview. When set to False, the response doesn't contain the status history, but the request will be handled faster. Default is True.
[OK] The order is successfully retrieved.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"ordersCollection": {
"orders": [
{
"number": "integer (int64)",
"instrument": {
"id": "string",
"name": "string"
},
"type": "string",
"statusHistory": [
{
"dateTime": "string (date-time)",
"status": "string",
"executedQuantity": "number (double)",
"executionPrice": "number (double)"
}
],
"currency": "string",
"duration": "string",
"line": "integer (int64)",
"side": "string",
"executedQuantity": "number (double)",
"limitPrice": "number (double)",
"averagePrice": "number (double)",
"quantity": "number (double)",
"expirationDate": "string (date-time)",
"lastStatus": "string",
"lastStatusDateTime": "string (date-time)",
"stopPrice": "number (double)",
"fixingPrice": "number (double)",
"condition": "string",
"referenceId": "string"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Cancellation
Cancel an order. Allowed for open orders.
The account number used to register the order.
The order number for this account.
[OK] The cancellation request is successfully created.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[Unprocessable Entity] The request is valid but the order can not be validated. See response body for more detail.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"ordersCollection": {
"orders": [
{
"number": "integer (int64)",
"instrument": {
"id": "string",
"name": "string"
},
"type": "string",
"statusHistory": [
{
"dateTime": "string (date-time)",
"status": "string",
"executedQuantity": "number (double)",
"executionPrice": "number (double)"
}
],
"currency": "string",
"duration": "string",
"line": "integer (int64)",
"side": "string",
"executedQuantity": "number (double)",
"limitPrice": "number (double)",
"averagePrice": "number (double)",
"quantity": "number (double)",
"expirationDate": "string (date-time)",
"lastStatus": "string",
"lastStatusDateTime": "string (date-time)",
"stopPrice": "number (double)",
"fixingPrice": "number (double)",
"condition": "string",
"referenceId": "string"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (422 Unprocessable Entity)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Modification
Modify an existing order. First, make sure the modification is valid by doing a preview.
Modifications to be used for the order.
An account number.
The order number.
Request Content-Types: application/json, text/json
Request Example
{
"orderNumber": "integer (int64)",
"limitPrice": "number (double)",
"validationCode": "string"
}
OK
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"ordersCollection": {
"orders": [
{
"number": "integer (int64)",
"instrument": {
"id": "string",
"name": "string"
},
"type": "string",
"statusHistory": [
{
"dateTime": "string (date-time)",
"status": "string",
"executedQuantity": "number (double)",
"executionPrice": "number (double)"
}
],
"currency": "string",
"duration": "string",
"line": "integer (int64)",
"side": "string",
"executedQuantity": "number (double)",
"limitPrice": "number (double)",
"averagePrice": "number (double)",
"quantity": "number (double)",
"expirationDate": "string (date-time)",
"lastStatus": "string",
"lastStatusDateTime": "string (date-time)",
"stopPrice": "number (double)",
"fixingPrice": "number (double)",
"condition": "string",
"referenceId": "string"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Costs
Preview the costs for an order. This allows you to check costs for an order without sending it to the market.
Specifications to be used for the order.
The account number to register the order.
Request Content-Types: application/json, text/json
Request Example
{
"type": "string",
"quantity": "number (double)",
"duration": "string",
"expirationDate": "string (date-time)",
"limitPrice": "number (double)",
"stopPrice": "number (double)",
"cash": {
"side": "string",
"instrumentId": "string"
},
"srd": {
"side": "string",
"instrumentId": "string"
},
"option": {
"condition": "string",
"leg1": {
"side": "string",
"instrumentId": "string"
},
"leg2": {
"side": "string",
"instrumentId": "string"
}
},
"future": {
"side": "string",
"instrumentId": "string"
},
"validationCode": "string",
"referenceId": "string"
}
[OK] The order cost request is successful. For more information about the costs, check the response.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[Unprocessable Entity] The request is valid but the order can not be validated. See response body for more detail.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"costsCollection": {
"legs": [
{
"categories": [
{
"subCategories": [
{
"name": "string",
"percentage": "number (double)",
"valueInEuro": "number (double)",
"extraInfo": "string"
}
],
"name": "string",
"percentage": "number (double)",
"valueInEuro": "number (double)",
"extraInfo": "string"
}
]
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (422 Unprocessable Entity)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Validate new
Preview an order. This allows you to validate an order without sending it to the market. The order will not be created. The response will contain information about if the order can be processed. It also includes warnings to show to the customer. And confirmations, which are warnings to be approved by the customer, before placing the order.
Specifications to be used for the order.
The account number to register the order.
Request Content-Types: application/json, text/json
Request Example
{
"type": "string",
"quantity": "number (double)",
"duration": "string",
"expirationDate": "string (date-time)",
"limitPrice": "number (double)",
"stopPrice": "number (double)",
"cash": {
"side": "string",
"instrumentId": "string"
},
"srd": {
"side": "string",
"instrumentId": "string"
},
"option": {
"condition": "string",
"leg1": {
"side": "string",
"instrumentId": "string"
},
"leg2": {
"side": "string",
"instrumentId": "string"
}
},
"future": {
"side": "string",
"instrumentId": "string"
},
"validationCode": "string",
"referenceId": "string"
}
[OK] The preview is successful. For more information about the order, check the response.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"previewOrder": {
"orderCanBeRegistered": "boolean",
"expectedExpirationDate": "string (date-time)",
"positionEffect": "string",
"effectOnSpendingLimit": "number (double)",
"currentSpendingLimit": "number (double)",
"newSpendingLimit": "number (double)",
"currency": "string",
"oldRiskNumber": "integer (int32)",
"newRiskNumber": "integer (int32)",
"recommendedRiskNumber": "integer (int32)",
"warningsToBeShown": [
"string"
],
"warningsToBeConfirmed": [
"string"
],
"validationCode": "string"
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Validate modification
Validate the modification of an order. This allows you to validate an order modification without sending it to the market. The order will not be created. The response will contain information about if the order can be processed. It also might include warnings to show to the customer. And confirmations, which are warnings to be approved by the customer, before placing the order modification.
Modifications to be used for the order.
An account number.
The order number.
Request Content-Types: application/json, text/json
Request Example
{
"orderNumber": "integer (int64)",
"limitPrice": "number (double)",
"validationCode": "string"
}
[OK] The preview is successful. For more information about the order, check the response.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"previewOrder": {
"orderCanBeRegistered": "boolean",
"expectedExpirationDate": "string (date-time)",
"positionEffect": "string",
"effectOnSpendingLimit": "number (double)",
"currentSpendingLimit": "number (double)",
"newSpendingLimit": "number (double)",
"currency": "string",
"oldRiskNumber": "integer (int32)",
"newRiskNumber": "integer (int32)",
"recommendedRiskNumber": "integer (int32)",
"warningsToBeShown": [
"string"
],
"warningsToBeConfirmed": [
"string"
],
"validationCode": "string"
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Performances
All
Get the financial performance information for an account.
The account number.
[OK] The performance information is successfully retrieved.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[NotFound] The account is not found.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"performancesCollection": {
"performances": [
{
"currency": "string",
"instrument": {
"id": "string",
"name": "string"
},
"year": "string",
"realized": "number (double)",
"unrealized": "number (double)",
"annual": "number (double)",
"previousYearsTotal": "number (double)",
"total": "number (double)"
}
]
},
"summary": {
"year": "string",
"currency": "string",
"realized": "number (double)",
"unrealized": "number (double)",
"annual": "number (double)",
"previousYearsTotal": "number (double)",
"total": "number (double)"
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (404 Not Found)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Year
Get the financial performance information for an account, per year. Only applicable for the years the account was active.
The year for the performance information.
The account number.
Performances can be calculated on position level or on instrument level. When 'onPosition' set to true, the performance of all individual instruments will be reported. If set to false, the performance of derivative instruments is included in the performance of the underlying instrument.
[OK] The performance information is successfully retrieved.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[NotFound] The account is not found.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"performancesCollection": {
"performances": [
{
"currency": "string",
"instrument": {
"id": "string",
"name": "string"
},
"year": "string",
"realized": "number (double)",
"unrealized": "number (double)",
"annual": "number (double)",
"previousYearsTotal": "number (double)",
"total": "number (double)"
}
]
},
"summary": {
"year": "string",
"currency": "string",
"realized": "number (double)",
"unrealized": "number (double)",
"annual": "number (double)",
"previousYearsTotal": "number (double)",
"total": "number (double)"
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (404 Not Found)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Positions
All
Get the instrument positions of an account (portfolio). If there is no position, the collection will be empty.
An account number.
Paging parameter to retrieve a subset of the complete collection. Format is <offset>-<limit>. Both values are an offset from the first entry of the complete collection. The first entry has offset '0'. (e.g. 12-21)
[OK] A list of the positions.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"positionsCollection": {
"positions": [
{
"instrument": {
"id": "string",
"name": "string"
},
"quantity": "integer (int64)",
"currency": "string",
"accruedInterest": {
"value": "number (double)",
"rate": "number (double)"
},
"averageHistoricalPrice": "number (double)",
"valueInEuro": "number (double)",
"margin": {
"value": "number (double)",
"factor": "number (double)"
},
"result": {
"currency": "string",
"unrealized": "number (double)",
"realized": "number (double)",
"total": "number (double)",
"unrealizedPercentage": "number (double)",
"purchaseValue": "number (double)"
},
"resultInEuro": {
"currency": "string",
"unrealized": "number (double)",
"realized": "number (double)",
"total": "number (double)",
"unrealizedPercentage": "number (double)",
"purchaseValue": "number (double)"
},
"value": "number (double)"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Position info
Get a specific position. Positions are identified by the instrument.
An account number.
The id of the requested instrument.
[OK] The position is successfully retrieved.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"positionsCollection": {
"positions": [
{
"instrument": {
"id": "string",
"name": "string"
},
"quantity": "integer (int64)",
"currency": "string",
"accruedInterest": {
"value": "number (double)",
"rate": "number (double)"
},
"averageHistoricalPrice": "number (double)",
"valueInEuro": "number (double)",
"margin": {
"value": "number (double)",
"factor": "number (double)"
},
"result": {
"currency": "string",
"unrealized": "number (double)",
"realized": "number (double)",
"total": "number (double)",
"unrealizedPercentage": "number (double)",
"purchaseValue": "number (double)"
},
"resultInEuro": {
"currency": "string",
"unrealized": "number (double)",
"realized": "number (double)",
"total": "number (double)",
"unrealizedPercentage": "number (double)",
"purchaseValue": "number (double)"
},
"value": "number (double)"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Quotes
Latest
Get current quotes and quote subscription (realtime/delayed) for one or more instruments.
Mandatory account number
Ids of the instruments to retrieve. If there are multiple ids, separate them by commas.
The maximal quote level returned
Paging parameter to retrieve a subset of the complete collection. Format is <offset>-<limit>. Both values are an offset from the first entry of the complete collection. The first entry has offset '0'. (e.g. 12-21)
[OK] The quote information is successfully retrieved.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[NotFound] The account is not found.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"quotesCollection": {
"quotes": [
{
"instrumentId": "string",
"subscriptionLevel": "string",
"open": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"last": {
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"close": {
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"high": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"low": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"implVol": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"implDiv": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"settlement": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"openInterest": {
"volume": "integer (int64)",
"tags": "string"
},
"theoreticalPrice": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"implIr": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"cumVol": {
"volume": "integer (int64)",
"tags": "string"
},
"bid": [
{
"orderCount": "integer (int64)",
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
}
],
"ask": [
{
"orderCount": "integer (int64)",
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
}
]
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (404 Not Found)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
History
Get historical quotes for an instrument over a period. The different intervals each have different maximum period lengths, ranging from five days for one minute, to 10 years for one week.
The Id of the instrument for which the historical quotes will be retrieved
Mandatory account number
The start moment of historical quotes
The end moment of historical quotes, defaulting to the Current date and time according to UTC time standard
Interval for historical quotes Depending on the interval, the historical quotes collection returned will be limited to a certain period: Max. number of days for one minute interval is 5. Max. number of days for five minute interval is 20. Max. number of days for ten minute interval is 20. Max. number of days for fifteen minute interval is 60. Max. number of days for one hour interval is 120. Max. number of years for one day interval is 10. Max. number of years for one week interval is 10.
[OK] The historical quote information is successfully retrieved.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[NotFound] The account or instrument is not found.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"historicalQuotesCollection": {
"historicalQuotes": [
{
"dateTime": "string (date-time)",
"last": "number (double)",
"low": "number (double)",
"high": "number (double)",
"first": "number (double)",
"cumVol": "integer (int64)"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (404 Not Found)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Sessions
All
Get the current active sessions. Only for internal use.
[OK] The sessions are returned.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"sessionsCollection": {
"sessions": [
{
"accountNumber": "string",
"internalSessionId": "string"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Sign out
Close the active session. Sessions must be closed before starting a new one, because there is a limit on the number of active sessions.
[OK] The session is ended.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"message": "string",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Settings
All
Get the trading settings for the specified account. If the settings return an empty list, trading is not allowed. This can be the case for a savings account, or if the account is not fully activated yet.
The account number.
[OK] A list of the settings.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
[NotFound] The account is not found.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"settingsCollection": {
"settings": [
{
"tradingAllowed": [
{
"tradingType": "string"
}
]
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (404 Not Found)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Transactions
All
Get the transactions for an account. The response not only includes the executed orders, but also withdrawals and deposits.
An account number
Paging parameter to retrieve a subset of the complete collection. Format is <offset>-<limit>. Both values are an offset from the first entry of the complete collection. The first entry has offset '0'. (e.g. 12-21)
Date from which to filter. Format YYYY-MM-DD
Date to which to filter. Format YYYY-MM-DD
Mutation groups (with enums)
BuyAndSell includes :
AssignmentCall
AssignmentPut
ExcerciseCall
ExcercisePut
Buy
OpeningBuy
OpeningBuyFutures
Sell
OpeningSell
OpeningSellFutures
ClosingBuy
ClosingBuyFutures
ClosingSell
ClosingSellFutures
Cost includes :
SettlementCosts
CouponPayment includes :
SecuritiesLendingCouponPayment
CouponPayment
DividendPayment includes :
SecuritiesLendingDividendPayment
DividendPayment
InterestPayment includes :
CreditInterest
DebitInterest
MoneyTransfer includes :
ExternalTransfer
InternalTransfer
OnlineMoneyTransfer
Regulation
PositionMutation includes :
Buy
Sell
3-letter currency code (ISO 4217)
[OK] A list of the transactions.
[Bad Request] The request is not valid. See response body for more detail.
[Unauthorized] Authorization has been denied for this request.
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"transactionsCollection": {
"transactions": [
{
"accountCurrency": "string",
"number": "integer (int64)",
"transactionDate": "string (date-time)",
"settlementDate": "string (date-time)",
"mutationType": "string",
"balanceMutation": "number (double)",
"mutatedBalance": "number (double)",
"instrument": {
"id": "string",
"name": "string"
},
"price": "number (double)",
"quantity": "number (double)",
"exchange": "string",
"totalCosts": "number (double)",
"currency": "string",
"netAmount": "number (double)",
"currencyRate": "number (double)",
"transactionCostComponents": [
{
"cost": "number (double)",
"currency": "string",
"costTypeCategory": "string",
"amountPercentage": "number (double)"
}
]
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Response Example (400 Bad Request)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Response Example (401 Unauthorized)
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
Version
API version
Get the version and the date of build of the API-service. This is the only call available without Bearer token.
OK
Response Content-Types: application/json, text/json
Response Example (200 OK)
{
"currentVersion": "string",
"buildDate": "string",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
Schema Definitions
AccountsResponse: object
Accounts API response
- accountsCollection: AccountsCollectionModel
-
Collection of zero, one or more accounts
- metadata: MetadataModel
-
API response meta data
Example
{
"accountsCollection": {
"accounts": [
{
"name": "string",
"iban": "string",
"number": "string",
"type": "string",
"isReadOnly": "boolean"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
AccountsCollectionModel: object
Collection of zero, one or more accounts
- accounts: AccountModel
-
Collection of zero, one or more accounts
-
AccountModel
Example
{
"accounts": [
{
"name": "string",
"iban": "string",
"number": "string",
"type": "string",
"isReadOnly": "boolean"
}
]
}
MetadataModel: object
API response meta data
- version: string
-
Version information
- timestamp: string (date-time)
-
Date and time the response is created
Example
{
"version": "string",
"timestamp": "string (date-time)"
}
AccountModel: object
Account model
- name: string
-
The name of the account
- iban: string
-
The IBAN of the account
- number: string
-
Accountnumber
- type: string savings, binckComplete, fundCoach, planEpargneAction, planEpargneActionPme, assetManagement, savingsBroker, assetManagementSelect
-
Type of account
- isReadOnly: boolean
-
Scope for the account
Example
{
"name": "string",
"iban": "string",
"number": "string",
"type": "string",
"isReadOnly": "boolean"
}
ErrorMessageModel: object
Error message model
- developerMessage: string
-
The message that should be used by the developer
- endUserMessage: string
-
The message that can be shown to the end user
- errorCode: string
-
The error code
- errorId: string initial, unknown, notFound, conversionError, functionalError, validationError, orderCancellationNotPossible, orderModificationRefused, orderNotValid, logonFailure, mediumBlocked, noAuthorization, noMatchingAccountInfoFound, sessionExpiredMaxDuration, sessionExpiredMaxInactivity, sessionInvalid, faildToCreateAmSession, orderNumberIsIncorrect, hashIdError, productNotEnabled, sessionMaxActivityExceeded, tooManyRequests, notImplemented
-
The id of the error
Example
{
"developerMessage": "string",
"endUserMessage": "string",
"errorCode": "string",
"errorId": "string"
}
BalancesResponse: object
Balances API response
- balancesCollection: BalancesCollectionModel
-
Collection of zero, one or more balances
- metadata: MetadataModel
-
API response meta data
Example
{
"balancesCollection": {
"balances": [
{
"assetsTotalValue": "number (double)",
"cashBalance": "number (double)",
"portfolioValue": "number (double)",
"availableSpendingLimit": "number (double)",
"availableSpendingLimitSrd": "number (double)",
"cashBalancesCollection": {
"cashBalances": [
{
"currency": "string",
"cashBalance": "number (double)"
}
]
}
}
],
"currency": "string"
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
BalancesCollectionModel: object
Collection of zero, one or more balances
- balances: BalanceModel
-
Collection of zero, one or more balances
-
BalanceModel - currency: string
-
The base currency
Example
{
"balances": [
{
"assetsTotalValue": "number (double)",
"cashBalance": "number (double)",
"portfolioValue": "number (double)",
"availableSpendingLimit": "number (double)",
"availableSpendingLimitSrd": "number (double)",
"cashBalancesCollection": {
"cashBalances": [
{
"currency": "string",
"cashBalance": "number (double)"
}
]
}
}
],
"currency": "string"
}
BalanceModel: object
Balance model
- assetsTotalValue: number (double)
-
Assets total value in Euro
- cashBalance: number (double)
-
Total cash balance in Euro
- portfolioValue: number (double)
-
Portfolio value
- availableSpendingLimit: number (double)
-
Spending power
- availableSpendingLimitSrd: number (double)
-
Spending power for SRD
- cashBalancesCollection: CashBalancesCollectionModel
-
Collection of one or more cash accounts per currency
Example
{
"assetsTotalValue": "number (double)",
"cashBalance": "number (double)",
"portfolioValue": "number (double)",
"availableSpendingLimit": "number (double)",
"availableSpendingLimitSrd": "number (double)",
"cashBalancesCollection": {
"cashBalances": [
{
"currency": "string",
"cashBalance": "number (double)"
}
]
}
}
CashBalancesCollectionModel: object
Collection of one or more money accounts - always the cash of the base currency and if available Dollar, and/or other money accounts.
- cashBalances: CashBalanceModel
-
CashBalances collection
-
CashBalanceModel
Example
{
"cashBalances": [
{
"currency": "string",
"cashBalance": "number (double)"
}
]
}
CashBalanceModel: object
Cash balance containing the balance for the Euro account, and if available, other cash balances
- currency: string
-
The currency
- cashBalance: number (double)
-
Cash balance
Example
{
"currency": "string",
"cashBalance": "number (double)"
}
InstrumentsQueryParams: object
GetInstruments query parameters model
- accountNumber: string (3 to 15 chars)
-
Mandatory account number
- instrumentType: string bond, cashDividend, certificate, choiceDividend, claim, coupon, discounter, equity, future, futureClass, index, investmentFund, ipo, option, optionClass, otherLeveragedProduct, speeder, sprinter, srd, srdClass, stockDividend, structuredProduct, tracker, turbo, unclassified, warrant
-
Additional optional filter on instrument type. Cannot be used alone.
- searchText: string (2 to 50 chars)
-
Case insensitive search text, minimum length 2. Cannot be used in combination with 'Isin'.
- isin: string (5 to 15 chars)
-
Selection on isinCode. Cannot be used in combination with 'SearchText'.
- mic: string (1 to 4 chars)
-
Additional optional selection on Market Identification Code, to be used only in combination with 'Isin'
Example
{
"accountNumber": "string",
"instrumentType": "string",
"searchText": "string",
"isin": "string",
"mic": "string"
}
PaginationQueryParam: object
Pagination parameters
- range: string
-
Paging parameter to retrieve a subset of the complete collection. Format is <offset>-<limit>. Both values are an offset from the first entry of the complete collection. The first entry has offset '0'. (e.g. 12-21)
Example
{
"range": "string"
}
InstrumentsResponseModel: object
Instruments API response (includes paging)
- instrumentsCollection: InstrumentsCollectionModel
-
Collection of zero, one or more instruments
- paging: PagingModel
-
Paging information
- count: integer (int64)
-
Number of entries in the complete collection
- metadata: MetadataModel
-
API response meta data
Example
{
"instrumentsCollection": {
"instruments": [
{
"id": "string",
"name": "string",
"symbol": "string",
"isincode": "string",
"type": "string",
"marketIdentificationCode": "string",
"derivativesInfo": {
"underlyingInstrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
},
"srdInfo": {
"underlyingInstrumentId": "string"
},
"bondInfo": {},
"leveragedProduct": {
"bonus": "number (double)",
"cap": "number (double)",
"endedDateTime": "string (date-time)",
"exchangeRatio": "number (double)",
"financingLevel": "number (double)",
"leverage": "number (double)",
"remainingValue": "number (double)",
"stopLossLevel": "number (double)",
"stopLossLevel2": "number (double)",
"strike": "number (double)"
},
"currency": "string",
"priceDecimals": "integer (int64)",
"tickerSymbol": "string",
"isTradable": "boolean",
"isKidApplicable": "boolean",
"tickSizeCollection": {
"tickSizes": [
{
"from": "number (double)",
"size": "number (double)"
}
]
},
"hasOptions": "boolean",
"hasFutures": "boolean",
"hasSrd": "boolean",
"hasLeveragedProducts": "boolean",
"hasOrderModifications": "boolean"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
InstrumentsCollectionModel: object
Collection of instruments
- instruments: InstrumentModel
-
Collection of instruments
-
InstrumentModel
Example
{
"instruments": [
{
"id": "string",
"name": "string",
"symbol": "string",
"isincode": "string",
"type": "string",
"marketIdentificationCode": "string",
"derivativesInfo": {
"underlyingInstrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
},
"srdInfo": {
"underlyingInstrumentId": "string"
},
"bondInfo": {},
"leveragedProduct": {
"bonus": "number (double)",
"cap": "number (double)",
"endedDateTime": "string (date-time)",
"exchangeRatio": "number (double)",
"financingLevel": "number (double)",
"leverage": "number (double)",
"remainingValue": "number (double)",
"stopLossLevel": "number (double)",
"stopLossLevel2": "number (double)",
"strike": "number (double)"
},
"currency": "string",
"priceDecimals": "integer (int64)",
"tickerSymbol": "string",
"isTradable": "boolean",
"isKidApplicable": "boolean",
"tickSizeCollection": {
"tickSizes": [
{
"from": "number (double)",
"size": "number (double)"
}
]
},
"hasOptions": "boolean",
"hasFutures": "boolean",
"hasSrd": "boolean",
"hasLeveragedProducts": "boolean",
"hasOrderModifications": "boolean"
}
]
}
PagingModel: object
Paging model for offset base pagination
- limit: integer (int64)
-
Offset of the last entry in this subset
- max: integer (int64)
-
Maximum number of entries per subset
- offset: integer (int64)
-
Offset of the first entry in this subset
- next: string
-
Parameter and value to add to the request to retrieve the next subset
- previous: string
-
Parameter and value to add to the request to retrieve the previous subset
- refresh: string
-
Parameter and value to add to the request to retrieve the same subset
Example
{
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
}
InstrumentModel: object
Instrument model
- id: string
-
Identification of the instrument
- name: string
-
Name of the instrument
- symbol: string
-
Symbol of the instrument
- isincode: string
-
ISIN-code of the instrument
- type: string bond, cashDividend, certificate, choiceDividend, claim, coupon, discounter, equity, future, futureClass, index, investmentFund, ipo, option, optionClass, otherLeveragedProduct, speeder, sprinter, srd, srdClass, stockDividend, structuredProduct, tracker, turbo, unclassified, warrant
-
OptionType of the instrument
- marketIdentificationCode: string
-
Market Identification Code of the instrument
- derivativesInfo: DerivativesInfoModel
-
Derivative serie information
- srdInfo: SrdInfoModel
-
Srd or Srd class information: Searching for an Srd will return a class. Ordering can done on both this class or the underlying equity. Positions and transactions report the SRD class. To get information about the underlying equity, the SRD can be retrieved using the instruments endpoint.
- bondInfo: BondInfoModel
-
Bond only information
- leveragedProduct: LeveragedProductInfoModel
-
Leveraged Product information
- currency: string
-
Currency of the instrument
- priceDecimals: integer (int64)
-
Number of decimals used to format the price - this is the maximum number of decimals, price can come with less, if higher than a certain limit
- tickerSymbol: string
-
Ticker symbol of the instrument
- isTradable: boolean
-
Indicates if orders for this instrument can be processed
- isKidApplicable: boolean
-
Indicates whether KID document must be shown before placing an order
- tickSizeCollection: TickSizesModel
-
Table containing tick sizes for minimal prize movement
- hasOptions: boolean
-
Indicates whether there exists at least one non-cancelled, non-expired, tradable option for this security, either an underlying value or an option class, with a valid listing (for the company/label) for which the account is allowed to trade
- hasFutures: boolean
-
Indicates whether there exists at least one non-cancelled, non-expired, tradable future for this instrument , either an underlying value or a future class, with a valid listing (for the company/label) for which the account is allowed to trade.
- hasSrd: boolean
-
Indicates whether there exists at least one non-cancelled, non-expired, tradable srd for this security, either an underlying value or an srd class, with a valid listing (for the company/label) for which the account is allowed to trade.
- hasLeveragedProducts: boolean
-
Indicates whether there exists at least one non-cancelled, non-expired, tradable, visible leveraged product for which the account is allowed to trade.
- hasOrderModifications: boolean
-
Indicates if orders for the instrument can be modified
Example
{
"id": "string",
"name": "string",
"symbol": "string",
"isincode": "string",
"type": "string",
"marketIdentificationCode": "string",
"derivativesInfo": {
"underlyingInstrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
},
"srdInfo": {
"underlyingInstrumentId": "string"
},
"bondInfo": {},
"leveragedProduct": {
"bonus": "number (double)",
"cap": "number (double)",
"endedDateTime": "string (date-time)",
"exchangeRatio": "number (double)",
"financingLevel": "number (double)",
"leverage": "number (double)",
"remainingValue": "number (double)",
"stopLossLevel": "number (double)",
"stopLossLevel2": "number (double)",
"strike": "number (double)"
},
"currency": "string",
"priceDecimals": "integer (int64)",
"tickerSymbol": "string",
"isTradable": "boolean",
"isKidApplicable": "boolean",
"tickSizeCollection": {
"tickSizes": [
{
"from": "number (double)",
"size": "number (double)"
}
]
},
"hasOptions": "boolean",
"hasFutures": "boolean",
"hasSrd": "boolean",
"hasLeveragedProducts": "boolean",
"hasOrderModifications": "boolean"
}
DerivativesInfoModel: object
Derivatives series model
- underlyingInstrumentId: string
-
Instrument Id
- strike: number (double)
-
Strike price
- strikeDecimals: integer (int32)
-
Maximum number of decimals in strike price
- optionType: string put, call
-
Option type (put or call)
- contractSize: number (double)
-
Contract size
- expirationDate: string (date-time)
-
Expiration date
Example
{
"underlyingInstrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
}
SrdInfoModel: object
SRD information model
- underlyingInstrumentId: string
-
The id of the equity
Example
{
"underlyingInstrumentId": "string"
}
LeveragedProductInfoModel: object
Leveraged product information
- bonus: number (double)
-
Bonus
- cap: number (double)
-
Cap
- endedDateTime: string (date-time)
-
Enddate and time
- exchangeRatio: number (double)
-
Exchange ratio
- financingLevel: number (double)
-
Financing level
- leverage: number (double)
-
Leverage
- remainingValue: number (double)
-
Remaining Value
- stopLossLevel: number (double)
-
Stoploss minimum
- stopLossLevel2: number (double)
-
Stoploss maximum
- strike: number (double)
-
Strike value
Example
{
"bonus": "number (double)",
"cap": "number (double)",
"endedDateTime": "string (date-time)",
"exchangeRatio": "number (double)",
"financingLevel": "number (double)",
"leverage": "number (double)",
"remainingValue": "number (double)",
"stopLossLevel": "number (double)",
"stopLossLevel2": "number (double)",
"strike": "number (double)"
}
TickSizesModel: object
Collection of TickSize steps used in the Instrument Model
- tickSizes: TickSizeStepModel
-
TickSizeStep collection
-
TickSizeStepModel
Example
{
"tickSizes": [
{
"from": "number (double)",
"size": "number (double)"
}
]
}
TickSizeStepModel: object
A tick size is the minimum price movement of a trading instrument. The price movements of different trading instruments vary, with their tick sizes representing the minimum amount they can move up or down on an exchange. Table might consist of only one row.
- from: number (double)
-
From value for tick size
- size: number (double)
-
Tick size
Example
{
"from": "number (double)",
"size": "number (double)"
}
AccountNumberQueryParam: object
Parameters class to validate query parameters.
- accountNumber: string (3 to 15 chars)
-
Mandatory account number
Example
{
"accountNumber": "string"
}
LeveragedProductsQueryParams: object
GetLeveragedProducts query parameters model
- accountNumber: string (3 to 15 chars)
-
Mandatory account number
- publisher: string all, binckBank, bnpParibas, citigroup, commerzBank, goldmanSachs, ing, unicredit, vontobelFinancialProducts, socGen
-
Name of the publishing company, default is 'binckBank'
- longShort: string all, long, short
-
Long or short, default is 'all' (both long and short)
- category: string bonds, commodities, currencies, equities, indices
-
Category, default is 'indices'
- type: string all, regular, xl
-
Specifies type (Turbo or XL), default is 'all' (both Turbo and XL)
- stoplossMin: number (float)
-
Specifies minimum stop loss
- stoplossMax: number (float)
-
Specifies maximum stop loss
Example
{
"accountNumber": "string",
"publisher": "string",
"longShort": "string",
"category": "string",
"type": "string",
"stoplossMin": "number (float)",
"stoplossMax": "number (float)"
}
CertificatesQueryParams: object
GetCertificates query parameters model
- accountNumber: string (3 to 15 chars)
-
Mandatory account number
- exchange: string certificatesSeDeX, certificatesEuroTLX, certificatesEuronext
-
Name of the Exchange, default is 'certificatesSeDeX'
Example
{
"accountNumber": "string",
"exchange": "string"
}
BondsQueryParams: object
GetBonds query parameters model
- accountNumber: string (3 to 15 chars)
-
Mandatory account number
- type: string bondsAmsterdamConvertible, bondsAmsterdamCorporate, bondsAmsterdamGovernment, bondsAmsterdamReverseConvertible, bondsBNPParibas, bondsBorsaItalianaEuroMotCorporate, bondsBorsaItalianaEuroMotGovernment, bondsBorsaItalianaExtraMot, bondsBorsaItalianaMotBot, bondsBorsaItalianaMotBtp, bondsBorsaItalianaMotCct, bondsBorsaItalianaMotCtz, bondsBorsaItalianaMotOther, bondsBorsaItalianaTop50Corporate, bondsBorsaItalianaTop50Government, bondsBrusselsConvertible, bondsBrusselsCorporate, bondsBrusselsGovernment, bondsBrusselsReverseConvertible, bondsEuroTlxCorporate, bondsEuroTlxItalianGovernment, bondsEuroTlxOtherGovernment, bondsEuroTlxTop50Corporate, bondsEuroTlxTop50Government, bondsLuxembourgConvertible, bondsLuxembourgCorporate, bondsLuxembourgGovernment, bondsLuxembourgReverseConvertible, bondsSocieteGenerale
-
Name of the Bonds type
Example
{
"accountNumber": "string",
"type": "string"
}
InstrumentDerivativesQueryParams: object
GetDerivatives query parameters model
- accountNumber: string (3 to 15 chars)
-
Mandatory account number
- symbol: string
-
Selection on symbol. Cannot be used in combination with 'UnderlyingInstrumentId'.
- underlyingInstrumentId: string
-
Selection on the ID of the underlying equity. Cannot be used in combination with 'symbol'.
- marketIdentificationCode: string
-
Can be used in combination with symbol to specify the market.
- currency: string
-
Can be used in combination with symbol to specify the currency.
Example
{
"accountNumber": "string",
"symbol": "string",
"underlyingInstrumentId": "string",
"marketIdentificationCode": "string",
"currency": "string"
}
DerivativesResponseModel: object
Derivatives API response
- derivativesCollection: DerivativesCollectionModel
-
Derivative classes information
- paging: PagingModel
-
Paging information
- count: integer (int64)
-
Number of entries in the complete collection
- metadata: MetadataModel
-
API response meta data
Example
{
"derivativesCollection": {
"classes": [
{
"underlyingInstrumentId": "string",
"name": "string",
"symbol": "string",
"isincode": "string",
"marketIdentificationCode": "string",
"currency": "string",
"type": "string",
"contractSize": "number (double)",
"series": [
{
"instrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
}
]
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
DerivativesCollectionModel: object
Collection of instruments
- classes: DerivativeClassInfoModel
-
Derivative classes collection
-
DerivativeClassInfoModel
Example
{
"classes": [
{
"underlyingInstrumentId": "string",
"name": "string",
"symbol": "string",
"isincode": "string",
"marketIdentificationCode": "string",
"currency": "string",
"type": "string",
"contractSize": "number (double)",
"series": [
{
"instrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
}
]
}
]
}
DerivativeClassInfoModel: object
The model for derivatives - future ans option classes
- underlyingInstrumentId: string
-
Identification of the underlying instrument
- name: string
-
Name of the class
- symbol: string
-
Symbol of the class
- isincode: string
-
ISIN Code of the class
- marketIdentificationCode: string
-
ISO MIC of the class
- currency: string
-
Currency of the class
- type: string bond, cashDividend, certificate, choiceDividend, claim, coupon, discounter, equity, future, futureClass, index, investmentFund, ipo, option, optionClass, otherLeveragedProduct, speeder, sprinter, srd, srdClass, stockDividend, structuredProduct, tracker, turbo, unclassified, warrant
-
Type of the class (option or future class)
- contractSize: number (double)
-
Contract Size of the class
- series: DerivativeSeriesInfoModel
-
Collection of series for this class
-
DerivativeSeriesInfoModel
Example
{
"underlyingInstrumentId": "string",
"name": "string",
"symbol": "string",
"isincode": "string",
"marketIdentificationCode": "string",
"currency": "string",
"type": "string",
"contractSize": "number (double)",
"series": [
{
"instrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
}
]
}
DerivativeSeriesInfoModel: object
Derivatives series information
- instrumentId: string
-
Instrument Id of the serie
- strike: number (double)
-
Strike price (options only)
- strikeDecimals: integer (int32)
-
Number of decimals in strike price (options only)
- optionType: string put, call
-
Option type (put or call) (options only)
- contractSize: number (double)
-
Contract size
- expirationDate: string (date-time)
-
Expiration date
Example
{
"instrumentId": "string",
"strike": "number (double)",
"strikeDecimals": "integer (int32)",
"optionType": "string",
"contractSize": "number (double)",
"expirationDate": "string (date-time)"
}
KidResponseModel: object
OpenApi response for KID collection
- kidCollection: KidCollectionModel
-
Holds KID collection
- metadata: MetadataModel
-
API response meta data
Example
{
"kidCollection": {
"kids": [
{
"name": "string",
"kidId": "string"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
KidCollectionModel: object
Model contains KID collection
- kids: KidInfoModel
-
Holds KID collection data in name, KID id pair
-
KidInfoModel
Example
{
"kids": [
{
"name": "string",
"kidId": "string"
}
]
}
KidInfoModel: object
Info model for KID
- name: string
-
Name of the document
- kidId: string
-
Id of the document
Example
{
"name": "string",
"kidId": "string"
}
NewsRequestQueryParams: object
Query params for the news message
- accountNumber: string (3 to 15 chars)
-
Mandatory account number
- fromDate: string (date-time)
-
Optional start date, if left out, fromDate will be today. If no instrument ids are supplied, only dates from the last month are accepted, otherwise only dates from the last week are accepted.
- toDate: string (date-time)
-
Optional end date, do not combine with instruments.
- instrumentIds: string
-
Optional ids of the instruments to retrieve. If there are multiple ids, separate them by commas.
Example
{
"accountNumber": "string",
"fromDate": "string (date-time)",
"toDate": "string (date-time)",
"instrumentIds": "string"
}
NewsResponseModel: object
response of the news request
- newsCollection: NewsCollectionModel
-
News items
- newsSubscriptionCollection: NewsSubscriptionCollectionModel
-
News subscriptions granted
- paging: PagingModel
-
Paging information
- count: integer (int64)
-
Number of entries in the complete collection
- metadata: MetadataModel
-
API response meta data
Example
{
"newsCollection": {
"news": [
{
"culture": "string",
"headline": "string",
"body": "string",
"format": "string",
"publishedDateTime": "string (date-time)",
"instrumentIds": [
"string"
]
}
]
},
"newsSubscriptionCollection": {
"subscriptions": [
{
"newsSubscription": "string"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
NewsCollectionModel: object
Collection of news item
- news: NewsItemModel
-
List of news items
-
NewsItemModel
Example
{
"news": [
{
"culture": "string",
"headline": "string",
"body": "string",
"format": "string",
"publishedDateTime": "string (date-time)",
"instrumentIds": [
"string"
]
}
]
}
NewsSubscriptionCollectionModel: object
Collection of news subscriptions
- subscriptions: NewsSubscriptionModel
-
List of subscriptions for the specified account
-
NewsSubscriptionModel
Example
{
"subscriptions": [
{
"newsSubscription": "string"
}
]
}
NewsItemModel: object
News item
- culture: string
-
The culture of the message
- headline: string
-
Headline of the message
- body: string
-
Body of the message (optional)
- format: string plain, html
-
Indication whether the body is in HTML format
- publishedDateTime: string (date-time)
-
Date and time the publisher published the message
- instrumentIds: string[]
-
The instruments for which this news message contains news (if any)
-
string
Example
{
"culture": "string",
"headline": "string",
"body": "string",
"format": "string",
"publishedDateTime": "string (date-time)",
"instrumentIds": [
"string"
]
}
NewsSubscriptionModel: object
News subscription
- newsSubscription: string binckNl, binckNlPro, binckIt, binckFrBe, binckNlBe, binckFr
-
The level of subscription
Example
{
"newsSubscription": "string"
}
OrdersQueryParams: object
Order parameters
- status: string
-
Status 'all' will select all the orders. Other possible values are 'open', 'executed' and 'canceled'.
- includeStatusHistory: boolean
-
When set to True, orders will include a detailed status history overview. When set to false the response doesn't contain the status history, but the request will be handled faster. Default is True.
Example
{
"status": "string",
"includeStatusHistory": "boolean"
}
OrdersResponse: object
Orders API response (includes paging)
- ordersCollection: OrdersCollectionModel
-
Collection of zero, one or more orders
- paging: PagingModel
-
Paging information
- count: integer (int64)
-
Number of entries in the complete collection
- metadata: MetadataModel
-
API response meta data
Example
{
"ordersCollection": {
"orders": [
{
"number": "integer (int64)",
"instrument": {
"id": "string",
"name": "string"
},
"type": "string",
"statusHistory": [
{
"dateTime": "string (date-time)",
"status": "string",
"executedQuantity": "number (double)",
"executionPrice": "number (double)"
}
],
"currency": "string",
"duration": "string",
"line": "integer (int64)",
"side": "string",
"executedQuantity": "number (double)",
"limitPrice": "number (double)",
"averagePrice": "number (double)",
"quantity": "number (double)",
"expirationDate": "string (date-time)",
"lastStatus": "string",
"lastStatusDateTime": "string (date-time)",
"stopPrice": "number (double)",
"fixingPrice": "number (double)",
"condition": "string",
"referenceId": "string"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
OrdersCollectionModel: object
Collection of orders
- orders: OrderModel
-
Collection of orders
-
OrderModel
Example
{
"orders": [
{
"number": "integer (int64)",
"instrument": {
"id": "string",
"name": "string"
},
"type": "string",
"statusHistory": [
{
"dateTime": "string (date-time)",
"status": "string",
"executedQuantity": "number (double)",
"executionPrice": "number (double)"
}
],
"currency": "string",
"duration": "string",
"line": "integer (int64)",
"side": "string",
"executedQuantity": "number (double)",
"limitPrice": "number (double)",
"averagePrice": "number (double)",
"quantity": "number (double)",
"expirationDate": "string (date-time)",
"lastStatus": "string",
"lastStatusDateTime": "string (date-time)",
"stopPrice": "number (double)",
"fixingPrice": "number (double)",
"condition": "string",
"referenceId": "string"
}
]
}
OrderModel: object
Order model
- number: integer (int64)
-
The identification of the order
- instrument: InstrumentBriefModel
-
Attributes of the financial instrument ordered
- type: string limit, market, stop, stopLimit, allOrNone
-
The price type of the order
- statusHistory: StatusHistory
-
Status history of the order, populated when requested with "includeStatusHistory != false"
-
StatusHistory - currency: string
-
The currency of the security
- duration: string fillOrKill, immediateOrCancel, day, goodTillCancelled, goodTillDate, atTheOpening, goodTillCrossing
-
Specifies the term for which the order is in effect
- line: integer (int64)
-
Line number of this order in case of a multi line order
- side: string buy, sell
-
Buy or sell - not available when bid (IPO)
- executedQuantity: number (double)
-
Number of executed instruments (equities), nominal value (odds) or number of contracts (options and futures)
- limitPrice: number (double)
-
Value of the order's limit
- averagePrice: number (double)
-
Average price of all fills on this order
- quantity: number (double)
-
Quantity ordered
- expirationDate: string (date-time)
-
Expiration date for a good till date order
- lastStatus: string placed, placementConfirmed, partiallyExecuted, executed, expired, cancelationRequested, canceled, modificationRequested, modified, refused, modificationRefused, cancelationRefused, remainderCanceled, remainderExpired, remainderExecuted, other
-
Status of the order last executed
- lastStatusDateTime: string (date-time)
-
Indicates the date and time of the last status change
- stopPrice: number (double)
-
Stop price for a stop or stop limit order
- fixingPrice: number (double)
-
Fixing price of the order
- condition: string pay, receive
-
Pay or receive condition, only applicable for multi-leg orders
- referenceId: string
-
Reference Id supplied at registration time
Example
{
"number": "integer (int64)",
"instrument": {
"id": "string",
"name": "string"
},
"type": "string",
"statusHistory": [
{
"dateTime": "string (date-time)",
"status": "string",
"executedQuantity": "number (double)",
"executionPrice": "number (double)"
}
],
"currency": "string",
"duration": "string",
"line": "integer (int64)",
"side": "string",
"executedQuantity": "number (double)",
"limitPrice": "number (double)",
"averagePrice": "number (double)",
"quantity": "number (double)",
"expirationDate": "string (date-time)",
"lastStatus": "string",
"lastStatusDateTime": "string (date-time)",
"stopPrice": "number (double)",
"fixingPrice": "number (double)",
"condition": "string",
"referenceId": "string"
}
InstrumentBriefModel: object
Brief instrument information
- id: string
-
Identification of the instrument
- name: string
-
Instrument's name
Example
{
"id": "string",
"name": "string"
}
StatusHistory: object
History of the order status
- dateTime: string (date-time)
-
DateTime of the status
- status: string placed, placementConfirmed, partiallyExecuted, executed, expired, cancelationRequested, canceled, modificationRequested, modified, refused, modificationRefused, cancelationRefused, remainderCanceled, remainderExpired, remainderExecuted, other
-
Name of the status
- executedQuantity: number (double)
-
The number of orders executed
- executionPrice: number (double)
-
Execution price of the executed quantities
Example
{
"dateTime": "string (date-time)",
"status": "string",
"executedQuantity": "number (double)",
"executionPrice": "number (double)"
}
NewOrderModel: object
New order model
- type: string limit, market, stop, stopLimit
-
The kind of order to be placed
- quantity: number (double)
-
The number of financial instruments to buy or sell
- duration: string day, goodTillCancelled, goodTillDate
-
Specifies the term for which the order is active - in general, duration is 'day' for market orders
- expirationDate: string (date-time)
-
The date when the order will be expired, used in combination with duration GoodTillDateTime
- limitPrice: number (double)
-
The highest price at which to buy or the lowest price at which to sell (only if type is limit or stopLimit)
- stopPrice: number (double)
-
The trigger price to initiate a buy or sell order, applicable when type is stop or stopLimit
- cash: NewOrderModelCash
-
For cash orders (equities, bonds), this field is required
- srd: NewOrderModelSrd
-
For SRD orders (Service de Règlement Différé, France), this field is required
- option: NewOrderModelOption
-
For option orders, this field is required
- future: NewOrderModelFuture
-
For future orders, this field is required
- validationCode: string
-
Order validation code (needs to be obtained by a preview order)
- referenceId: string
-
Reference identifier available for 3rd parties. Max length 40 chars
Example
{
"type": "string",
"quantity": "number (double)",
"duration": "string",
"expirationDate": "string (date-time)",
"limitPrice": "number (double)",
"stopPrice": "number (double)",
"cash": {
"side": "string",
"instrumentId": "string"
},
"srd": {
"side": "string",
"instrumentId": "string"
},
"option": {
"condition": "string",
"leg1": {
"side": "string",
"instrumentId": "string"
},
"leg2": {
"side": "string",
"instrumentId": "string"
}
},
"future": {
"side": "string",
"instrumentId": "string"
},
"validationCode": "string",
"referenceId": "string"
}
NewOrderModelCash: object
For cash orders (equities), this field is required
- side: string buy, sell
-
Buy or sell
- instrumentId: string
-
Instrument Id
Example
{
"side": "string",
"instrumentId": "string"
}
NewOrderModelSrd: object
For SRD orders (equities), this field is required
- side: string buy, sell
-
Buy or sell
- instrumentId: string
-
The instrumentId of a SRD class, or the underlying equity
Example
{
"side": "string",
"instrumentId": "string"
}
NewOrderModelOption: object
For option orders, this field is required
- condition: string pay, receive
-
Combination strategy. Pay or Receive
- leg1: NewOrderModelOptionLeg
-
The information about the first leg
- leg2: NewOrderModelOptionLeg
-
For a strategy the second leg is required
Example
{
"condition": "string",
"leg1": {
"side": "string",
"instrumentId": "string"
},
"leg2": {
"side": "string",
"instrumentId": "string"
}
}
NewOrderModelFuture: object
For future orders (equities), this field is required
- side: string buy, sell
-
Buy or sell
- instrumentId: string
-
Instrument Id
Example
{
"side": "string",
"instrumentId": "string"
}
NewOrderModelOptionLeg: object
The details of a leg
- side: string buy, sell
-
Buy or sell
- instrumentId: string
-
Instrument Id
Example
{
"side": "string",
"instrumentId": "string"
}
OrderResponse: object
Order API response
- ordersCollection: OrdersCollectionModel
-
Collection of zero, one or more orders
- metadata: MetadataModel
-
API response meta data
Example
{
"ordersCollection": {
"orders": [
{
"number": "integer (int64)",
"instrument": {
"id": "string",
"name": "string"
},
"type": "string",
"statusHistory": [
{
"dateTime": "string (date-time)",
"status": "string",
"executedQuantity": "number (double)",
"executionPrice": "number (double)"
}
],
"currency": "string",
"duration": "string",
"line": "integer (int64)",
"side": "string",
"executedQuantity": "number (double)",
"limitPrice": "number (double)",
"averagePrice": "number (double)",
"quantity": "number (double)",
"expirationDate": "string (date-time)",
"lastStatus": "string",
"lastStatusDateTime": "string (date-time)",
"stopPrice": "number (double)",
"fixingPrice": "number (double)",
"condition": "string",
"referenceId": "string"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
HistoricalOrdersQueryParams: object
Historical Order status parameters
- year: integer (int64)
-
The year for which the historical orders should be retrieved
- month: integer (int64)
-
The month for which the historical orders should be retrieved
Example
{
"year": "integer (int64)",
"month": "integer (int64)"
}
ModifyOrderModel: object
Modify order model
- orderNumber: integer (int64)
-
Order Number of Account.
- limitPrice: number (double)
-
New Limit Price of the Order.
- validationCode: string
-
Order validation code (needs to be obtained by a preview modify order)
Example
{
"orderNumber": "integer (int64)",
"limitPrice": "number (double)",
"validationCode": "string"
}
OrderCostsResponse: object
Response for Costs request
- costsCollection: OrderCostsCollectionModel
-
List of costs
- metadata: MetadataModel
-
API response meta data
Example
{
"costsCollection": {
"legs": [
{
"categories": [
{
"subCategories": [
{
"name": "string",
"percentage": "number (double)",
"valueInEuro": "number (double)",
"extraInfo": "string"
}
],
"name": "string",
"percentage": "number (double)",
"valueInEuro": "number (double)",
"extraInfo": "string"
}
]
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
OrderCostsCollectionModel: object
Costs collection
- legs: OrderCostsForLegModel
-
Order execution costs per order leg
-
OrderCostsForLegModel
Example
{
"legs": [
{
"categories": [
{
"subCategories": [
{
"name": "string",
"percentage": "number (double)",
"valueInEuro": "number (double)",
"extraInfo": "string"
}
],
"name": "string",
"percentage": "number (double)",
"valueInEuro": "number (double)",
"extraInfo": "string"
}
]
}
]
}
OrderCostsForLegModel: object
Collection of order costs for one leg of the order
- categories: OrderCostsForCategoryModel
-
List of costs per category
-
OrderCostsForCategoryModel
Example
{
"categories": [
{
"subCategories": [
{
"name": "string",
"percentage": "number (double)",
"valueInEuro": "number (double)",
"extraInfo": "string"
}
],
"name": "string",
"percentage": "number (double)",
"valueInEuro": "number (double)",
"extraInfo": "string"
}
]
}
OrderCostsForCategoryModel: object
Order costs for category
- subCategories: OrderCostsForSubCategoryModel
-
List of costs per subcategory
-
OrderCostsForSubCategoryModel - name: string
-
Order category name, translated in the language of the customer
- percentage: number (double)
-
Percentage representation of the cost category
- valueInEuro: number (double)
-
Amount in EUR of costs for the category
- extraInfo: string
-
In case of null values for ValueInEuros / percentage, ExtraInfo will be be provided
Example
{
"subCategories": [
{
"name": "string",
"percentage": "number (double)",
"valueInEuro": "number (double)",
"extraInfo": "string"
}
],
"name": "string",
"percentage": "number (double)",
"valueInEuro": "number (double)",
"extraInfo": "string"
}
OrderCostsForSubCategoryModel: object
Order costs for sub category
- name: string
-
Order category name, translated in the language of the customer
- percentage: number (double)
-
Percentage representation of the cost category
- valueInEuro: number (double)
-
Amount in EUR of costs for the category
- extraInfo: string
-
In case of null values for ValueInEuros / percentage, ExtraInfo will be be provided
Example
{
"name": "string",
"percentage": "number (double)",
"valueInEuro": "number (double)",
"extraInfo": "string"
}
PreviewOrderResponse: object
Preview Order API response
- previewOrder: PreviewOrderModel
-
Information related to the order validation such as if the order is processable, spending power, etc.
- metadata: MetadataModel
-
API response meta data
Example
{
"previewOrder": {
"orderCanBeRegistered": "boolean",
"expectedExpirationDate": "string (date-time)",
"positionEffect": "string",
"effectOnSpendingLimit": "number (double)",
"currentSpendingLimit": "number (double)",
"newSpendingLimit": "number (double)",
"currency": "string",
"oldRiskNumber": "integer (int32)",
"newRiskNumber": "integer (int32)",
"recommendedRiskNumber": "integer (int32)",
"warningsToBeShown": [
"string"
],
"warningsToBeConfirmed": [
"string"
],
"validationCode": "string"
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
PreviewOrderModel: object
This object is used in the response of the order validation call.
- orderCanBeRegistered: boolean
-
True if the order can be placed
- expectedExpirationDate: string (date-time)
-
For GTD en GTC orders the end date will be limited to about 2 weeks maximum
- positionEffect: string
-
Contains the position effect information (open, close)
- effectOnSpendingLimit: number (double)
-
Effect of a successfully placed order on the spending limit of the account
- currentSpendingLimit: number (double)
-
The current spending limit of the account (before placing the order)
- newSpendingLimit: number (double)
-
The new spending limit of the account (after placing the order)
- currency: string
-
The currency of the spending limit
- oldRiskNumber: integer (int32)
-
Risk number before placing the order
- newRiskNumber: integer (int32)
-
Risk number after successfully placing the order
- recommendedRiskNumber: integer (int32)
-
Recommended risk number
- warningsToBeShown: string[]
-
Warnings or error messages about the requested order that only needs to be shown
-
string - warningsToBeConfirmed: string[]
-
Warning messages about the requested order that explicitly need to be confirmed
-
string - validationCode: string
-
(Optional) validation code (only supplied when order can be registered)
Example
{
"orderCanBeRegistered": "boolean",
"expectedExpirationDate": "string (date-time)",
"positionEffect": "string",
"effectOnSpendingLimit": "number (double)",
"currentSpendingLimit": "number (double)",
"newSpendingLimit": "number (double)",
"currency": "string",
"oldRiskNumber": "integer (int32)",
"newRiskNumber": "integer (int32)",
"recommendedRiskNumber": "integer (int32)",
"warningsToBeShown": [
"string"
],
"warningsToBeConfirmed": [
"string"
],
"validationCode": "string"
}
PerformancesResponse: object
Performances API response
- performancesCollection: PerformanceCollectionModel
-
Collection of zero, one or more performances for positions
- summary: PerformanceSummaryModel
-
Summary of the performances
- metadata: MetadataModel
-
API response meta data
Example
{
"performancesCollection": {
"performances": [
{
"currency": "string",
"instrument": {
"id": "string",
"name": "string"
},
"year": "string",
"realized": "number (double)",
"unrealized": "number (double)",
"annual": "number (double)",
"previousYearsTotal": "number (double)",
"total": "number (double)"
}
]
},
"summary": {
"year": "string",
"currency": "string",
"realized": "number (double)",
"unrealized": "number (double)",
"annual": "number (double)",
"previousYearsTotal": "number (double)",
"total": "number (double)"
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
PerformanceCollectionModel: object
Collection of zero, one or more performances for positions
- performances: PerformanceDetailModel
-
Collection of zero, one or more performances for positions
-
PerformanceDetailModel
Example
{
"performances": [
{
"currency": "string",
"instrument": {
"id": "string",
"name": "string"
},
"year": "string",
"realized": "number (double)",
"unrealized": "number (double)",
"annual": "number (double)",
"previousYearsTotal": "number (double)",
"total": "number (double)"
}
]
}
PerformanceSummaryModel: object
Summary for a year or a total summary (in case of year results requested)
- year: string
-
Year for this summary
- currency: string
-
Currency for this summary
- realized: number (double)
-
Realized profit/loss
- unrealized: number (double)
-
Unrealized profit/loss
- annual: number (double)
-
Total this year
- previousYearsTotal: number (double)
-
Including previous years
- total: number (double)
-
Total
Example
{
"year": "string",
"currency": "string",
"realized": "number (double)",
"unrealized": "number (double)",
"annual": "number (double)",
"previousYearsTotal": "number (double)",
"total": "number (double)"
}
PerformanceDetailModel: object
Performance for one instrument. Due to rounding errors some calculation have difference of one cent.
- currency: string
- instrument: InstrumentBriefModel
-
Instrument information
- year: string
-
Year in case of summary info
- realized: number (double)
-
Realized profit/loss
- unrealized: number (double)
-
Unrealized profit/loss
- annual: number (double)
-
This year
- previousYearsTotal: number (double)
-
Including previous years
- total: number (double)
-
Total
Example
{
"currency": "string",
"instrument": {
"id": "string",
"name": "string"
},
"year": "string",
"realized": "number (double)",
"unrealized": "number (double)",
"annual": "number (double)",
"previousYearsTotal": "number (double)",
"total": "number (double)"
}
PerformancesQueryParams: object
Performances query parameters model
- onPosition: boolean
-
Performances can be calculated on position level or on instrument level. When 'onPosition' set to true, the performance of all individual instruments will be reported. If set to false, the performance of derivative instruments is included in the performance of the underlying instrument.
Example
{
"onPosition": "boolean"
}
PositionsResponse: object
Positions API response (includes paging)
- positionsCollection: PositionsCollectionModel
-
Collection of zero, one or more positions
- paging: PagingModel
-
Paging information
- count: integer (int64)
-
Number of entries in the complete collection
- metadata: MetadataModel
-
API response meta data
Example
{
"positionsCollection": {
"positions": [
{
"instrument": {
"id": "string",
"name": "string"
},
"quantity": "integer (int64)",
"currency": "string",
"accruedInterest": {
"value": "number (double)",
"rate": "number (double)"
},
"averageHistoricalPrice": "number (double)",
"valueInEuro": "number (double)",
"margin": {
"value": "number (double)",
"factor": "number (double)"
},
"result": {
"currency": "string",
"unrealized": "number (double)",
"realized": "number (double)",
"total": "number (double)",
"unrealizedPercentage": "number (double)",
"purchaseValue": "number (double)"
},
"resultInEuro": {
"currency": "string",
"unrealized": "number (double)",
"realized": "number (double)",
"total": "number (double)",
"unrealizedPercentage": "number (double)",
"purchaseValue": "number (double)"
},
"value": "number (double)"
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
PositionsCollectionModel: object
Collection of positions
- positions: PositionModel
-
Collection of positions
-
PositionModel
Example
{
"positions": [
{
"instrument": {
"id": "string",
"name": "string"
},
"quantity": "integer (int64)",
"currency": "string",
"accruedInterest": {
"value": "number (double)",
"rate": "number (double)"
},
"averageHistoricalPrice": "number (double)",
"valueInEuro": "number (double)",
"margin": {
"value": "number (double)",
"factor": "number (double)"
},
"result": {
"currency": "string",
"unrealized": "number (double)",
"realized": "number (double)",
"total": "number (double)",
"unrealizedPercentage": "number (double)",
"purchaseValue": "number (double)"
},
"resultInEuro": {
"currency": "string",
"unrealized": "number (double)",
"realized": "number (double)",
"total": "number (double)",
"unrealizedPercentage": "number (double)",
"purchaseValue": "number (double)"
},
"value": "number (double)"
}
]
}
PositionModel: object
Position model
- instrument: InstrumentBriefModel
-
Instrument information
- quantity: integer (int64)
-
Number of securities or contracts or nominal value
- currency: string
-
Currency
- accruedInterest: PositionAccruedInterest
-
Accrued interest in case of a debt instrument
- averageHistoricalPrice: number (double)
-
Volume weighted average price paid at the time of purchase - for futures this is based on fixing price, if held overnight
- valueInEuro: number (double)
-
Value of the position expressed in the EURO currency
- margin: PositionMargin
-
Margin
- result: PositionResult
-
Result expressed in mentioned currency of instrument
- resultInEuro: PositionResult
-
Result expressed in the EURO currency
- value: number (double)
-
Value of the portfolio
Example
{
"instrument": {
"id": "string",
"name": "string"
},
"quantity": "integer (int64)",
"currency": "string",
"accruedInterest": {
"value": "number (double)",
"rate": "number (double)"
},
"averageHistoricalPrice": "number (double)",
"valueInEuro": "number (double)",
"margin": {
"value": "number (double)",
"factor": "number (double)"
},
"result": {
"currency": "string",
"unrealized": "number (double)",
"realized": "number (double)",
"total": "number (double)",
"unrealizedPercentage": "number (double)",
"purchaseValue": "number (double)"
},
"resultInEuro": {
"currency": "string",
"unrealized": "number (double)",
"realized": "number (double)",
"total": "number (double)",
"unrealizedPercentage": "number (double)",
"purchaseValue": "number (double)"
},
"value": "number (double)"
}
PositionAccruedInterest: object
Position accrued interest
- value: number (double)
-
Value
- rate: number (double)
-
Rate
Example
{
"value": "number (double)",
"rate": "number (double)"
}
PositionMargin: object
Position margin
- value: number (double)
-
Value
- factor: number (double)
-
Factor
Example
{
"value": "number (double)",
"factor": "number (double)"
}
PositionResult: object
Position result
- currency: string
-
Currency the result is expressed in
- unrealized: number (double)
-
Unrealized result
- realized: number (double)
-
Realized result
- total: number (double)
-
Total result
- unrealizedPercentage: number (double)
-
Unrealized result in a percentage of ... (?)
- purchaseValue: number (double)
-
Purchase value
Example
{
"currency": "string",
"unrealized": "number (double)",
"realized": "number (double)",
"total": "number (double)",
"unrealizedPercentage": "number (double)",
"purchaseValue": "number (double)"
}
PositionResponse: object
Position API response
- positionsCollection: PositionsCollectionModel
-
Position information
- metadata: MetadataModel
-
API response meta data
Example
{
"positionsCollection": {
"positions": [
{
"instrument": {
"id": "string",
"name": "string"
},
"quantity": "integer (int64)",
"currency": "string",
"accruedInterest": {
"value": "number (double)",
"rate": "number (double)"
},
"averageHistoricalPrice": "number (double)",
"valueInEuro": "number (double)",
"margin": {
"value": "number (double)",
"factor": "number (double)"
},
"result": {
"currency": "string",
"unrealized": "number (double)",
"realized": "number (double)",
"total": "number (double)",
"unrealizedPercentage": "number (double)",
"purchaseValue": "number (double)"
},
"resultInEuro": {
"currency": "string",
"unrealized": "number (double)",
"realized": "number (double)",
"total": "number (double)",
"unrealizedPercentage": "number (double)",
"purchaseValue": "number (double)"
},
"value": "number (double)"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
QuoteRequestQueryParams: object
request params for quotes
- accountNumber: string (3 to 15 chars)
-
Mandatory account number
- instrumentIds: string
-
Ids of the instruments to retrieve. If there are multiple ids, separate them by commas.
- level: string none, tradesOnly, tradesBidAsk, fullBook
-
The maximal quote level returned
Example
{
"accountNumber": "string",
"instrumentIds": "string",
"level": "string"
}
QuotesResponseModel: object
Instruments/Quotes response (includes paging)
- quotesCollection: QuotesCollectionModel
-
Quotes Collection
- paging: PagingModel
-
Paging information
- count: integer (int64)
-
Number of entries in the complete collection
- metadata: MetadataModel
-
API response meta data
Example
{
"quotesCollection": {
"quotes": [
{
"instrumentId": "string",
"subscriptionLevel": "string",
"open": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"last": {
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"close": {
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"high": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"low": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"implVol": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"implDiv": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"settlement": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"openInterest": {
"volume": "integer (int64)",
"tags": "string"
},
"theoreticalPrice": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"implIr": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"cumVol": {
"volume": "integer (int64)",
"tags": "string"
},
"bid": [
{
"orderCount": "integer (int64)",
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
}
],
"ask": [
{
"orderCount": "integer (int64)",
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
}
]
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
QuotesCollectionModel: object
Quotes Collection
- quotes: QuoteModel
-
Quotes Collection
-
QuoteModel
Example
{
"quotes": [
{
"instrumentId": "string",
"subscriptionLevel": "string",
"open": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"last": {
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"close": {
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"high": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"low": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"implVol": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"implDiv": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"settlement": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"openInterest": {
"volume": "integer (int64)",
"tags": "string"
},
"theoreticalPrice": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"implIr": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"cumVol": {
"volume": "integer (int64)",
"tags": "string"
},
"bid": [
{
"orderCount": "integer (int64)",
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
}
],
"ask": [
{
"orderCount": "integer (int64)",
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
}
]
}
]
}
QuoteModel: object
Quote Model
- instrumentId: string
-
Security Id
- subscriptionLevel: string none, delayed, realtimeLevel0, realtimeLevel1, realtime
-
Level of quote access
- open: PriceModel
-
Open quote
- last: PriceWithVolumeModel
-
Last quote
- close: PriceWithVolumeModel
-
Close quote
- high: PriceModel
-
High quote
- low: PriceModel
-
Low quote
- implVol: PriceModel
-
Implied volatility quote
- implDiv: PriceModel
-
Implied dividend quote
- settlement: PriceModel
-
Settlement quote
- openInterest: VolumeModel
-
Open interest quote
- theoreticalPrice: PriceModel
-
Theoretical price quote
- implIr: PriceModel
-
Implied interest rate quote
- cumVol: VolumeModel
-
Cumulative volume quote
- bid: PriceOrderBookModel
-
Bid book
-
PriceOrderBookModel - ask: PriceOrderBookModel
-
Ask book
-
PriceOrderBookModel
Example
{
"instrumentId": "string",
"subscriptionLevel": "string",
"open": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"last": {
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"close": {
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"high": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"low": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"implVol": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"implDiv": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"settlement": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"openInterest": {
"volume": "integer (int64)",
"tags": "string"
},
"theoreticalPrice": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"implIr": {
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
},
"cumVol": {
"volume": "integer (int64)",
"tags": "string"
},
"bid": [
{
"orderCount": "integer (int64)",
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
}
],
"ask": [
{
"orderCount": "integer (int64)",
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
}
]
}
PriceModel: object
Model of a quote
- price: number (double)
-
Quote Price
- priceDateTime: string (date-time)
-
Date and time of the quote according to the exchange (local to the market)
- tags: string
-
Tags for Market (M), Cancel (O), MarketOpen (O), ExcludeIntraday (X)
Example
{
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
}
PriceWithVolumeModel: object
Model of a quote with volume
- volume: integer (int64)
-
Quote Volume
- price: number (double)
-
Quote Price
- priceDateTime: string (date-time)
-
Date and time of the quote according to the exchange (local to the market)
- tags: string
-
Tags for Market (M), Cancel (O), MarketOpen (O), ExcludeIntraday (X)
Example
{
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
}
VolumeModel: object
Volume information
- volume: integer (int64)
-
Quote Volume
- tags: string
-
Tags for Market (M), Cancel (O), MarketOpen (O), ExcludeIntraday (X)
Example
{
"volume": "integer (int64)",
"tags": "string"
}
PriceOrderBookModel: object
Price in order book
- orderCount: integer (int64)
-
Number of open orders for this price
- volume: integer (int64)
-
Quote Volume
- price: number (double)
-
Quote Price
- priceDateTime: string (date-time)
-
Date and time of the quote according to the exchange (local to the market)
- tags: string
-
Tags for Market (M), Cancel (O), MarketOpen (O), ExcludeIntraday (X)
Example
{
"orderCount": "integer (int64)",
"volume": "integer (int64)",
"price": "number (double)",
"priceDateTime": "string (date-time)",
"tags": "string"
}
HistoricalQuoteRequestQueryParams: object
request params for historical quotes
- accountNumber: string (3 to 15 chars)
-
Mandatory account number
- fromDateTime: string (date-time)
-
The start moment of historical quotes
- toDateTime: string (date-time)
-
The end moment of historical quotes, defaulting to the Current date and time according to UTC time standard
- interval: string oneMinute, fiveMinutes, tenMinutes, fifteenMinutes, oneHour, oneDay, oneWeek, oneMonth
-
Interval for historical quotes Depending on the interval, the historical quotes collection returned will be limited to a certain period: Max. number of days for one minute interval is 5. Max. number of days for five minute interval is 20. Max. number of days for ten minute interval is 20. Max. number of days for fifteen minute interval is 60. Max. number of days for one hour interval is 120. Max. number of years for one day interval is 10. Max. number of years for one week interval is 10.
Example
{
"accountNumber": "string",
"fromDateTime": "string (date-time)",
"toDateTime": "string (date-time)",
"interval": "string"
}
HistoricalQuotesResponseModel: object
Historical Quotes response
- historicalQuotesCollection: HistoricalQuotesCollectionModel
-
HistoricalQuotes Collection
- metadata: MetadataModel
-
API response meta data
Example
{
"historicalQuotesCollection": {
"historicalQuotes": [
{
"dateTime": "string (date-time)",
"last": "number (double)",
"low": "number (double)",
"high": "number (double)",
"first": "number (double)",
"cumVol": "integer (int64)"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
HistoricalQuotesCollectionModel: object
Historical Quotes Collection Model
- historicalQuotes: HistoricalQuoteModel
-
Historical Quotes collection
-
HistoricalQuoteModel
Example
{
"historicalQuotes": [
{
"dateTime": "string (date-time)",
"last": "number (double)",
"low": "number (double)",
"high": "number (double)",
"first": "number (double)",
"cumVol": "integer (int64)"
}
]
}
HistoricalQuoteModel: object
Historical Quote Model
- dateTime: string (date-time)
-
Date and time of the quote according to the exchange (local to the market)
- last: number (double)
-
Latest trade price at the end of the interval
- low: number (double)
-
Lowest price within the interval
- high: number (double)
-
Highest price within the interval
- first: number (double)
-
First trade price within the interval
- cumVol: integer (int64)
-
Sum of all volumes within the interval
Example
{
"dateTime": "string (date-time)",
"last": "number (double)",
"low": "number (double)",
"high": "number (double)",
"first": "number (double)",
"cumVol": "integer (int64)"
}
LogoffResponse: object
Response of the logoff request.
- message: string
-
A message confirming the sign out is complete
- metadata: MetadataModel
-
API response meta data
Example
{
"message": "string",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
SessionsResponse: object
Sessions API response
- sessionsCollection: SessionsCollectionModel
-
Collection of sessions
- metadata: MetadataModel
-
API response meta data
Example
{
"sessionsCollection": {
"sessions": [
{
"accountNumber": "string",
"internalSessionId": "string"
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
SessionsCollectionModel: object
Collection of zero, one or more sessions
- sessions: SessionModel
-
Collection of sessions
-
SessionModel
Example
{
"sessions": [
{
"accountNumber": "string",
"internalSessionId": "string"
}
]
}
SessionModel: object
Session information used by internal applications to replace the login and retrieve the session id for the default account
- accountNumber: string
-
The number of the account
- internalSessionId: string
-
The internal session ID
Example
{
"accountNumber": "string",
"internalSessionId": "string"
}
SettingsResponse: object
API Account Settings response
- settingsCollection: SettingsCollectionModel
-
Collection of settings
- metadata: MetadataModel
-
API response meta data
Example
{
"settingsCollection": {
"settings": [
{
"tradingAllowed": [
{
"tradingType": "string"
}
]
}
]
},
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
SettingsCollectionModel: object
A collection of settings model instances
- settings: SettingsModel
-
Collection of Settings Object
-
SettingsModel
Example
{
"settings": [
{
"tradingAllowed": [
{
"tradingType": "string"
}
]
}
]
}
SettingsModel: object
Settings list
- tradingAllowed: TradingProductModel
-
A list of products trading is allowed for
-
TradingProductModel
Example
{
"tradingAllowed": [
{
"tradingType": "string"
}
]
}
TradingProductModel: object
Settings for trading product
- tradingType: string equities, optionsNl, optionsBe, optionsFr, optionsUsa, optionsDe, optionsIt, futuresNl, futuresBe, futuresFr, futuresUsa, futuresDe, futuresIt, srd
-
Trading product type
Example
{
"tradingType": "string"
}
DateRangeQueryParams: object
From - To date parameters
- fromDate: string (date-time)
-
Date from which to filter. Format YYYY-MM-DD
- toDate: string (date-time)
-
Date to which to filter. Format YYYY-MM-DD
Example
{
"fromDate": "string (date-time)",
"toDate": "string (date-time)"
}
MutationGroupQueryParams: object
Mutation group parameter
- mutationGroup: string buyAndSell, cost, couponPayment, dividendPayment, interestPayment, moneyTransfer, positionMutation
-
Mutation groups (with enums)
BuyAndSell includes :
AssignmentCall
AssignmentPut
ExcerciseCall
ExcercisePut
Buy
OpeningBuy
OpeningBuyFutures
Sell
OpeningSell
OpeningSellFutures
ClosingBuy
ClosingBuyFutures
ClosingSell
ClosingSellFutures
Cost includes :
SettlementCosts
CouponPayment includes :
SecuritiesLendingCouponPayment
CouponPayment
DividendPayment includes :
SecuritiesLendingDividendPayment
DividendPayment
InterestPayment includes :
CreditInterest
DebitInterest
MoneyTransfer includes :
ExternalTransfer
InternalTransfer
OnlineMoneyTransfer
Regulation
PositionMutation includes :
Buy
Sell
Example
{
"mutationGroup": "string"
}
CurrencyQueryParams: object
Currency parameter
- currency: string
-
3-letter currency code (ISO 4217)
Example
{
"currency": "string"
}
TransactionsResponse: object
Transaction API response
- transactionsCollection: TransactionsCollectionModel
-
Collection of zero, one or more Transactions
- paging: PagingModel
-
Paging information
- count: integer (int64)
-
Number of entries in the complete collection
- metadata: MetadataModel
-
API response meta data
Example
{
"transactionsCollection": {
"transactions": [
{
"accountCurrency": "string",
"number": "integer (int64)",
"transactionDate": "string (date-time)",
"settlementDate": "string (date-time)",
"mutationType": "string",
"balanceMutation": "number (double)",
"mutatedBalance": "number (double)",
"instrument": {
"id": "string",
"name": "string"
},
"price": "number (double)",
"quantity": "number (double)",
"exchange": "string",
"totalCosts": "number (double)",
"currency": "string",
"netAmount": "number (double)",
"currencyRate": "number (double)",
"transactionCostComponents": [
{
"cost": "number (double)",
"currency": "string",
"costTypeCategory": "string",
"amountPercentage": "number (double)"
}
]
}
]
},
"paging": {
"limit": "integer (int64)",
"max": "integer (int64)",
"offset": "integer (int64)",
"next": "string",
"previous": "string",
"refresh": "string"
},
"count": "integer (int64)",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}
TransactionsCollectionModel: object
The model for the transactions endpoint
- transactions: TransactionModel
-
Collection of transactions
-
TransactionModel
Example
{
"transactions": [
{
"accountCurrency": "string",
"number": "integer (int64)",
"transactionDate": "string (date-time)",
"settlementDate": "string (date-time)",
"mutationType": "string",
"balanceMutation": "number (double)",
"mutatedBalance": "number (double)",
"instrument": {
"id": "string",
"name": "string"
},
"price": "number (double)",
"quantity": "number (double)",
"exchange": "string",
"totalCosts": "number (double)",
"currency": "string",
"netAmount": "number (double)",
"currencyRate": "number (double)",
"transactionCostComponents": [
{
"cost": "number (double)",
"currency": "string",
"costTypeCategory": "string",
"amountPercentage": "number (double)"
}
]
}
]
}
TransactionModel: object
Transaction model
- accountCurrency: string
-
Currency code for an account
- number: integer (int64)
-
State the uniqueness of this number for an account
- transactionDate: string (date-time)
-
The transaction date is the date when the transaction is effective
- settlementDate: string (date-time)
-
The date on which the transfer between two parties is executed
- mutationType: string unknown, repayment, conversion, excerciseCall, excercisePut, assignmentCall, assignmentPut, settlementDividend, deposit, emissionAllocation, internalBooking, transferOutOfSecurities, notificationOfRedemption, outstandingBooking, securityTransfer, conversionClaims, conversionDividend, cashSettlement, adjustment, assignmentCoupon, internalTransfer, externalTransfer, cashTransferToPartnerBank, cashTransferFromPartnerBank, openingBuy, openingBuyFutures, openingSell, openingSellFuture, regulation, creditInterest, debitInterest, closingBuy, closingBuyFuture, closingSell, closingSellFuture, assignmentClaim, assignmentDividend, couponPayment, dividendPayment, settlementCosts, sell, buy, liquidationTransfer, extensionOpenDeposit, extensionOpenTransferOut, extensionCloseDeposit, extensionCloseTransferOut, settlementBuy, settlementSell, securitiesLendingDividendPayment, securitiesLendingCouponPayment, securitiesLendingInterestPayment, onlineMoneyTransfer, taxReclaimPayment
-
Enumerated value of the mutation type
- balanceMutation: number (double)
-
Total amount when the transaction is completed
- mutatedBalance: number (double)
-
Total amount when the transaction is completed
- instrument: InstrumentBriefModel
-
The instrument object
- price: number (double)
-
The price of one instrument
- quantity: number (double)
-
The number of financial instruments to buy or sell
- exchange: string
-
Name of the exchange where this instrument was handled
- totalCosts: number (double)
-
All costs for this transaction
- currency: string
-
Transaction currency. This currency was used to complete this transaction
- netAmount: number (double)
-
The total amount for this transaction without the costs
- currencyRate: number (double)
-
The exchange rate used for the transaction currency
- transactionCostComponents: TransactionCostComponentModel
-
All Cost components for this transactions
-
TransactionCostComponentModel
Example
{
"accountCurrency": "string",
"number": "integer (int64)",
"transactionDate": "string (date-time)",
"settlementDate": "string (date-time)",
"mutationType": "string",
"balanceMutation": "number (double)",
"mutatedBalance": "number (double)",
"instrument": {
"id": "string",
"name": "string"
},
"price": "number (double)",
"quantity": "number (double)",
"exchange": "string",
"totalCosts": "number (double)",
"currency": "string",
"netAmount": "number (double)",
"currencyRate": "number (double)",
"transactionCostComponents": [
{
"cost": "number (double)",
"currency": "string",
"costTypeCategory": "string",
"amountPercentage": "number (double)"
}
]
}
TransactionCostComponentModel: object
Transaction costs components
- cost: number (double)
-
Amount for the costs
- currency: string
-
Currency of these costs
- costTypeCategory: string commission, stampDuty, capitalGainTax, capitalIncomeTax, exchangeTax, withHoldingTax, stampDutyBE, vAT, securitiesFee, socialTax, incomeTax, sRDExtensionCommission, sRDDifference, sRDSettlement, sRDCompensationPayment, sRDCommission, speculationTax, assetManagementFee, currencyExchangeCost
-
Costs category
- amountPercentage: number (double)
-
Percentage of the transaction amount
Example
{
"cost": "number (double)",
"currency": "string",
"costTypeCategory": "string",
"amountPercentage": "number (double)"
}
VersionModel: object
Version model
- currentVersion: string
-
Current version
- buildDate: string
-
Build date
- metadata: MetadataModel
-
API response meta data
Example
{
"currentVersion": "string",
"buildDate": "string",
"metadata": {
"version": "string",
"timestamp": "string (date-time)"
}
}