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
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
marketOrderId*
Integer
ID of the market order.
Response body: MarketOrder object
Data model
MarketOrdersList object
marketorders
List of market orders.
MarketOrder object
id
Integer
ID of the market order.
id_account
Integer
ID of the related account.
number
String
Number of the market order.
label
String
Display name of the market order.
code
String or null
Technical code (ISIN) of the market order.
stock_symbol
String or null
Stock ticker symbol of the investment in the associated stock market.
order_direction
Market order direction.
order_type
Market order type.
stock_market
String or null
Stock market on which the order was executed (examples: "NASDAQ", "Xetra"…).
state
String
Current state of the market order (examples: "Executed", "Pending"…).
payment_method
String
Payment method ("CASH", "DEFERRED", "UNKNOWN").
date
DateTime or null
Creation date of the market order.
execution_date
DateTime or null
Execution date of the market order.
validity_date
DateTime or null
Validity date of the market order.
quantity
Decimal or null
Quantity of stocks purchased or sold.
amount
Decimal or null
Total amount that was purchased or sold.
ordervalue
Decimal or null
Limit or Trigger value (only applicable for "Limit" or "Trigger" types).
unitprice
Decimal or null
Value of one stock when the order was executed.
unitvalue
Decimal or null
Current value of the related stock.
deleted
DateTime or null
Deletion date for market orders that no longer exist (null if still present).
last_update
DateTime
Date of the last synchronization of the investment.
MarketOrderDirection object
id
Integer
ID of the the market order direction.
name
String
Market order direction: BUY or SALE.
MarketOrderType object
id
Integer
ID of the the market order type.
name
String
Market order type: MARKET, LIMIT, TRIGGER or UNKNOWN.
Last updated