Sign in
fx
plan-premium

bid/ask time-series data for a given FX trading pair and interval. Values are the closing bid/ask for the interval. Supports a range of datetime formats and timezone offsets. Datetime format in the response will try to match your request - unless specified explicitly.

get/fx/quote/time-series

Query parameters

pairstring required

A single FX trading pair, with or without a slash

Trading pair, such as EURUSD

string

UTC/GMT date YYYY-MM-DD

OR
string

UTC/GMT datetime YYYY-MM-DD HH:MM:SS

OR
string

ISO8601 Datetime with optional timezone offset YYYY-MM-DDTHH:MM:SS±HH:00

OR
number

Milliseconds since Jan 1 1970 (unix timestamp with millisecond precision)

Example:2021-01-26T15:30:00-05:00

Time-series start. Supported formats: YYYY-MM-DD (UTC). YYYY-MM-DD HH:MM:SS (UTC), ISO8601 with timezone offset. Timestamp in milliseconds. Supply this or end.

string

UTC/GMT date YYYY-MM-DD

OR
string

UTC/GMT datetime YYYY-MM-DD HH:MM:SS

OR
string

ISO8601 Datetime with optional timezone offset YYYY-MM-DDTHH:MM:SS±HH:00

OR
number

Milliseconds since Jan 1 1970 (unix timestamp with millisecond precision)

Example:2021-01-26T15:30:00-05:00

Time-series end. Supported formats: YYYY-MM-DD (UTC). YYYY-MM-DD HH:MM:SS (UTC), ISO8601 with timezone offset. Timestamp in milliseconds. Supply this or start.

dtmfmt'ISO' | 'TSP' | 'UTCYMD'

Can be [ISO] ISO8601 datetime including timezone offset, [TSP] UNIX Timestamp in milliseconds, or [UTCYMD] 'YYYY-MM-DD HH:MM:SS' (UTC).

Desired datetime response format. Defaults to match your request. Can be [ISO] ISO8601 datetime including timezone offset, [TSP] UNIX Timestamp in milliseconds, or [UTCYMD] 'YYYY-MM-DD HH:MM:SS' (UTC).

intervalstring

ISO8601 Duration. https://en.wikipedia.org/wiki/ISO_8601#Durations

ISO8601 duration, such as P1D (daily). Defaults to P1D. Options are P1D, PT1H, PT1M.

limitnumber

Maximum number of data points to return. Default varies upon duration.

Response

Success

pairstring

A single FX trading pair, with or without a slash

intervalstring

ISO8601 Duration. https://en.wikipedia.org/wiki/ISO_8601#Durations

limitnumber
dtmfmt'ISO' | 'TSP' | 'UTCYMD'

Can be [ISO] ISO8601 datetime including timezone offset, [TSP] UNIX Timestamp in milliseconds, or [UTCYMD] 'YYYY-MM-DD HH:MM:SS' (UTC).

tzOffsetstring

Timezone offset. e.g. +00:00 or -05:00

sizenumber

Size of the quote is units of the base currency/symbol. Usually 1.

msnumber

Server response time in milliseconds

Example response

{
  "start": "2021-01-26T15:30:00-05:00",
  "end": "2021-01-26T15:30:00-05:00",
  "results": [
    {
      "dtm": "2021-01-26T15:30:00-05:00"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.