Formatting Parameters

Formatting API response data

We have a few URL parameters to help format the API response data. URL parameters are appended to the URL where the first parameter is preceded with "?" and subsequent parameters are preceded with "&". Here is an example:

https://api.sendwyre.com/v3/rates?pretty&as=priced

You can see ?pretty is the first parameter, and &as= is the second with a value of priced. If you remove the URL parameters the formatting reverts to a less structured state.

URL Parameter

Values

pretty

no value
Returns an easily readable JSON format

format

json_numberstring
This encodes all numbers returned from our API as strings.

csv
This downloads rates as CSV file.

Rates Formatting

When fetching current rates there are also additional formatting parameters available.

GET https://api.sendwyre.com/v2/rates

The ordering of the trade pair in the key represents the direction of an exchange. For example, BTCUSD is the rate used for BTC into USD conversions (e.g. the sell rate). On the other hand, converting USD into BTC (the buy rate) would use the opposite rate under USDBTC.

Rates Parameter

Value

as

divisor
Source amount / rate = destination amount (default)

multiplier
Source amount * rate = destination amount

priced
Shows both divisor and multiplier values

You can also view the rates in different formats according to your preference:

Examples

https://api.sendwyre.com/v2/rates?as=divisor - source amount / rate = destination amount (default)

https://api.sendwyre.com/v2/rates?as=multiplier - source amount * rate = destination amount

https://api.sendwyre.com/v2/rates?as=priced&pretty&format=json_numberstring - shows both divisor and multiplier values

https://api.sendwyre.com/v2/rates?as=priced&pretty&format=csv - downloads rates as CSV file
For example, if 1 BTC is selling at 9000 USD, USDBTC will be 9000 in the divisor view and (1/9000) in the multiplier view.

Pagination Parameters

We split our tabular data into pages of 25 items. You can apply the parameters below to any request for tabular to adjust the pagination.

Parameter

Description

offset

How many items are skipped before the first item that is shown (default: 0).

limit

Number of items returned per page (default: 25).

from

The lower bound of a creation time filter for the displayed items. Formatted in millisecond Epoch format. (default: 0)

to

The upper bound of a creation time filter for the displayed items. Formatted in millisecond Epoch format. (default: current time)