Skip to main content
POST
Retrieve FX reference and market details.

Authorizations

Authorization
string
header
required

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

Body

A slash-delimited FxPair, date-only MarketDate, and one authorised provider-selector form.

Selects an FX pair and market-data date for quote, currency, name, and calendar details.

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

FX pair selected by derived requests.

market_date
string<date-time>

Market date used by the derived request.

provider_id
string | null

Opaque identifier of a single market-data provider to use instead of either environment-name option.

entity_access_type
enum<string>

Access classification associated with the selected market-data environment.

Available options:
view,
edit,
owner,
blocked
market_data_environment_names
string[] | null

Names of the market-data environments to use. Do not combine this list with the single-name or provider-ID alternatives.

market_data_environment_name
string | null

Single market-data environment name to use instead of market_data_environment_names or provider_id.

Example:

"Example market data"

Response

Returns the FX reference and market details, including the calendar ID used by GetFxCalendar.

Returns descriptive and spot details for the selected FX pair.

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

provider_id
string | null

Opaque identifier of the market-data provider associated with the returned data.

identifier
string | null

Resolved FX-pair identifier returned by the lookup.

market_date
string<date-time>

Market-data date copied from the request.

name
string | null

FX-pair name, or the literal N/A when the name lookup returns an empty string.

domestic_currency
string | null

Domestic currency code derived from the selected FX pair.

foreign_currency
string | null

Foreign currency code derived from the selected FX pair.

spot
number<double>

Spot quote for the selected pair and market-data date; zero is returned when unavailable.

trading_calendar_id
string | null

Calendar code derived from the selected FX pair.