Skip to main content
POST
Retrieve tradable contracts by identifier.

Authorizations

Authorization
string
header
required

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

Body

A non-empty collection of TradableIds and at most one provider selector: ProviderId or MarketDataEnvironmentName.

Tradable identifiers used to retrieve contract definitions.

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

tradable_ids
string[] | null

Tradable identifiers whose contract definitions are requested.

Response

Returns available tradable IDs, display names, and contract definitions with validation or conversion errors for unavailable entries.

Contracts matched to requested tradable identifiers.

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

contracts
object[] | null

Resolved contracts with their tradable identifiers and display context.