Skip to main content
POST
Retrieve fully described equity market data.

Authorizations

Authorization
string
header
required

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

Body

The query payload. Identifiers, date-only MarketDates, and identifier-to-Descriptor pairs must all be non-empty; provider or environment fields select authorised sources.

Queries equity market data by identifier or descriptor across market dates.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetEquitiesRequest, 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

Instrument selectors whose equities are requested.

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

market_dates
string<date-time>[] | null

Market dates on which equities are requested.

descriptors
object[] | null

Structured selectors for the requested equities.

Response

Returns available equity assets with their requested market data and any invalid-provider, unsupported-identifier, missing-asset, or retrieval errors.

Returns equity market-data records and query errors.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.MarketData.ApiGetEquitiesResponse, 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.

equities
object[] | null

Equity market-data records returned by the query.