Skip to main content
GET
FX pair prices

Authorizations

X-API-KEY
string
header
default:pk_live_YOUR_KEY
required

Astreus API key (pk_live_...), created on the Developers page in the terminal. Also accepted as Authorization: Bearer pk_live_....

Path Parameters

pair
string
required

Two ISO 4217 codes, e.g. USDCAD.

Query Parameters

range
enum<string>
default:1Y

Window of bars served: from the range's first day (1M = 31 days back, YTD = 1 January) to the latest bar; ALL is the whole history. rangeFrom echoes the first day; displayFrom is the epoch ms of the first bar inside the range.

Available options:
1M,
3M,
6M,
YTD,
1Y,
2Y,
5Y,
ALL
lookback
integer
default:0

Bars to add before the range's first day, e.g. 200 to draw a 200-day moving average from the first bar. Default 0: only bars inside the range. lookbackBars says how many were added.

Required range: 0 <= x <= 1000
from
string<date>

First day (default the range's first day), YYYY-MM-DD.

to
string<date>

Last day, YYYY-MM-DD.

limit
integer

Latest N bars in the window, 1–100000. With from, to, limit or frequency exactly the window's bars are served, plus a window block; lookback does not apply.

Required range: 1 <= x <= 100000
frequency
enum<string>
default:daily

Bar frequency: daily (the default), weekly or monthly (the last close of each week or month).

Available options:
daily,
weekly,
monthly

Response

OK

Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.

symbol
string
bars
object[]
displayFrom
integer
currency
string
coverageFrom
string<date>
window
object