Skip to main content
POST
Retrieve tradable identifiers for contracts.

Authorizations

Authorization
string
header
required

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

Body

JSON request with non-empty Contracts, AsOfDate, and at most one accessible market-data environment selected by name or identifier.

Contract definitions and as-of date used to resolve tradable identifiers.

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

contracts
object[] | null

Contract definitions whose tradable identifiers are requested.

Polymorphic base role shared by public contract definitions.

as_of_date
string<date-time>

Date at which tradable identifiers are resolved for the supplied contracts.

Response

Returns identifiers corresponding to the supplied contracts and any errors.

Tradables resolved from the supplied contract definitions.

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

results
object[] | null

Resolved tradable identifiers with their contracts, as-of dates, and display names.