Skip to main content
POST
finance.market-rates.ohlc

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
premium
boolean
required

Required explicit choice to use premium interval prices.

symbols
string[]
required

Currency symbols to return.

Required array length: 1 - 100 elements

Currency symbol, including an alternative symbol when requested.

Required string length: 1 - 16
Pattern: ^[A-Z][A-Z0-9_]{1,15}$
startTime
string
required

UTC start minute, zero seconds, from 2016-12-19.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:00Z$
period
enum<string>
required

Completed price interval; alignment and retention depend on the period.

Available options:
1m,
5m,
15m,
30m,
1h,
12h,
1d,
1w,
1mo
base
string
default:USD

Currency symbol, including an alternative symbol when requested.

Required string length: 1 - 16
Pattern: ^[A-Z][A-Z0-9_]{1,15}$
includeAlternative
boolean
default:false

Include alternative and digital currencies when explicitly chosen.

Response

The result

base
string
required

Currency symbol, including an alternative symbol when requested.

Required string length: 1 - 16
Pattern: ^[A-Z][A-Z0-9_]{1,15}$
startTime
string<date-time>
required

Interval start, UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
endTime
string<date-time>
required

Interval end, UTC, inclusive.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
quotes
object[]
required

Prices for each requested currency.

Required array length: 1 - 100 elements