Market orders
API endpoints
Authentication: endpoints listed in this page require header authentication with a user token.
List market orders
GET
https://{domain}.biapi.pro/2.0/users/{userId}/marketorders
List market orders related to a user.
Path Parameters
Name | Type | Description |
---|---|---|
userId* | Integer or "me" | ID of the related user. |
Response body: MarketOrdersList object
Get a market order
GET
https://{domain}.biapi.pro/2.0/marketorders/{marketOrderId}
Get a single market order by ID.
Path Parameters
Name | Type | Description |
---|---|---|
marketOrderId* | Integer | ID of the market order. |
Response body: MarketOrder object
Data model
MarketOrdersList object
Property | Type | Description |
---|---|---|
| Array of MarketOrder objects | List of market orders. |
MarketOrder object
Property | Type | Description |
---|---|---|
| Integer | ID of the market order. |
| Integer | ID of the related account. |
| String | Number of the market order. |
| String | Display name of the market order. |
| String or null | Technical code (ISIN) of the market order. |
| String or null | Stock ticker symbol of the investment in the associated stock market. |
| MarkerOrderDirection object | Market order direction. |
| MarkerOrderType object | Market order type. |
| String or null | Stock market on which the order was executed (examples: "NASDAQ", "Xetra"…). |
| String | Current state of the market order (examples: "Executed", "Pending"…). |
| String | Payment method ("CASH", "DEFERRED", "UNKNOWN"). |
| DateTime or null | Creation date of the market order. |
| DateTime or null | Execution date of the market order. |
| DateTime or null | Validity date of the market order. |
| Decimal or null | Quantity of stocks purchased or sold. |
| Decimal or null | Total amount that was purchased or sold. |
| Decimal or null | Limit or Trigger value (only applicable for "Limit" or "Trigger" types). |
| Decimal or null | Value of one stock when the order was executed. |
| Decimal or null | Current value of the related stock. |
| DateTime or null | Deletion date for market orders that no longer exist ( |
| DateTime | Date of the last synchronization of the investment. |
MarketOrderDirection object
Property | Type | Description |
---|---|---|
| Integer | ID of the the market order direction. |
| String | Market order direction: |
MarketOrderType object
Property | Type | Description |
---|---|---|
| Integer | ID of the the market order type. |
| String | Market order type: |
Last updated