Skip to main content
POST
Retrieve FX observations for an inclusive date range.

Authorizations

Authorization
string
header
required

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

Body

The query payload. FxPairs must be non-empty and contain FX pair codes such as GBPUSD; StartDate and EndDate are required ISO 8601 date/time bounds.

Queries dated FX observations by currency pair and date range.

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

fx_pairs
string[] | null

Conventional six-character currency pairs, such as GBPUSD, that narrow the FX operation.

start_date
string<date-time>

Required ISO 8601 date/time value whose calendar date is the inclusive lower boundary.

end_date
string<date-time>

Required ISO 8601 date/time value whose calendar date is the inclusive upper boundary.

Response

Returns the available FX observations keyed by conventional pair code, plus any lookup errors.

Returns dated FX observations.

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

fx_data
object[] | null

FX observations returned by the query.