Skip to main content
POST
finance.exchange-rate.history

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}$
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
from
string
required

Source currency (e.g. EUR).

Required string length: 1 - 512
to
string
required

Target currency (e.g. USD).

Required string length: 1 - 512
endDate
string

End date.

Required string length: 1 - 512
startDate
string

Start date.

Required string length: 1 - 512

Response

The result

average
number
required

Average.

rates
object[]

Rates.

changePercent
number

Change percent.

dataPoints
number

Data points.

max
number

Max.

min
number

Min.

endDate
string

End date, ISO 8601.

fromCurrency
string

From currency.

startDate
string

Start date, ISO 8601.

toCurrency
string

To currency.