Skip to main content
POST
Retrieve client-visible stock reference details.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

The query payload containing a non-empty collection of equity Identifiers. Returned details are limited to those available to the caller's organisation or in shared Derivitec reference data.

Queries equity reference details by structured equity selector.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetStockInfoRequest, Derivitec.Web.Core
market_data_environment_name
string | null

Name of the market-data environment to use. Supply either this name or provider_id, not both.

Example:

"Example market data"

provider_id
string | null

Opaque identifier of the market-data provider to use. Supply either this identifier or market_data_environment_name, not both.

identifiers
object[] | null

Equity selectors whose reference details are requested.

Instrument code qualified by an identifier namespace and optional market code.

Response

Returns available stock reference details keyed by input identifier and any unsupported-identifier or retrieval errors.

Returns equity reference details keyed by the requested instrument selectors.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetStockInfoResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

stock_info
object[] | null

Equity reference details keyed by the requested instrument selectors.