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

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

Currency symbol, including an alternative symbol when requested.

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

Currency symbol, including an alternative symbol when requested.

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

Amount to convert; decimals and zero are accepted.

Required range: 0 <= x <= 1000000000
direct
boolean
default:false

Use the premium direct conversion route; integer amounts only until decimal precision is confirmed.

Response

The result

from
string
required

Currency symbol, including an alternative symbol when requested.

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

Currency symbol, including an alternative symbol when requested.

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

Input amount.

convertedAmount
number
required

Amount in the target currency, without forced rounding.

Required range: 0 <= x <= 1e+24
rate
number
required

Target currency units per source unit.

Required range: x <= 1000000000000000
observedAt
string<date-time>
required

Rate publication timestamp, 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))$