Comment on page

Market orders

API endpoints
Authentication: endpoints listed in this page require header authentication with a user token.
get
https://{domain}.biapi.pro/2.0
/users/{userId}/marketorders
List market orders
Filtering route aliases:
/users/{userId}/accounts/{accountId}/marketorders
/users/{userId}/connections/{connectionId}/marketorders
get
https://{domain}.biapi.pro/2.0
/marketorders/{marketOrderId}
Get a market order
Data model
MarketOrdersList object
Property
Type
Description
marketorders
Array of MarketOrder objects
List of market orders.
MarketOrder object
Property
Type
Description
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
​MarkerOrderDirection object
Market order direction.
order_type
​MarkerOrderType object
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
Property
Type
Description
id
Integer
ID of the the market order direction.
name
String
Market order direction: BUY or SALE.
MarketOrderType object
Property
Type
Description
id
Integer
ID of the the market order type.
name
String
Market order type: MARKET, LIMIT, TRIGGER or UNKNOWN.

Property	Type	Description
`marketorders`	Array of MarketOrder objects	List of market orders.

Property	Type	Description
`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`	MarkerOrderDirection object	Market order direction.
`order_type`	MarkerOrderType object	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.

Property	Type	Description
`id`	Integer	ID of the the market order direction.
`name`	String	Market order direction: `BUY` or `SALE`.

Property	Type	Description
`id`	Integer	ID of the the market order type.
`name`	String	Market order type: `MARKET`, `LIMIT`, `TRIGGER or UNKNOWN`.

Investments

Pockets

Last modified 3mo ago