Skip to navigation

Stocks

View as Markdown

Listed holdings — shares and other traded securities.

Each position carries the instrument, its identifiers, the quantity held, the price at the moment of the extraction, the valuation and the result, in the currency the institution reports. Field by field in Investments.

A valuation is a snapshot, not a quote. It is what the institution showed when the engine read it; it does not move afterwards and it is not a market feed.

Requires the stocks_read feature

Features are chosen when the execution starts, not here. An execution that did not ask for stocks_read answers 204, and the only way to get the data is to run another one.

StatusMeaning
200The positions.
202feature_not_ready — stocks_read is still running. Only this family waits: the ones that already closed answer now.
204The execution never asked for stocks_read. No body.
404No execution with that id for your application, or it has been deleted.

Server to server only. This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

200 OK
Equity positions: what is held, how much of it, at what cost and what it is worth on the day the source reported it.

An empty list is an answer, not a gap: the feature ran and the source reported none.

idstringformat: "object-id"

Product ID for the current execution. Note: it may change between executions.

product"investment_asset"
sub_family"investment_asset:stock"
fetch_datestringformat: "datetime"
Date this product was fetched
accountobject
Account identifier
customer_segmentenum
product_namestring
Product name
contractobjectOptional
Contract if present
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
isinstringOptional
ISIN code
tickerstringOptional
Ticker
marketstringOptional
Market
categorystringOptional
Category
unit_priceobjectOptional
Unit price
quantitystringOptionalformat: "number"Defaults to nan
The number of units of a financial instrument held by the account.
valuationobjectOptional
The monetary value of a financial instrument held by the account.
valuation_datedateOptional
Valuation date
appreciationobjectOptional
The monetary value of the appreciation of a financial instrument held by the account.
performanceobjectOptional
Performance

Errors

404
Not Found Error
422
Unprocessable Entity Error