API referenceF X display

Balances as one figure

Every balance this business holds, added up in one currency. A heading, not a quote. The rates behind it are usually reference rates that no counterparty would deal at, which is fine for a number on a screen and disqualifying for a trade — `may_settle` says which you have.

GET
/api/b/v1/fx/display/balance

Every balance this business holds, added up in one currency.

A heading, not a quote. The rates behind it are usually reference rates that no counterparty would deal at, which is fine for a number on a screen and disqualifying for a trade — may_settle says which you have.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Query Parameters

display_currency?|

Overrides the saved preference for this request only.

admin_access_token?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/b/v1/fx/display/balance"
{  "currency": "string",  "amount_minor": 0,  "as_of": "2019-08-24T14:15:22Z",  "complete": true,  "may_settle": true,  "rate_sources": [    "string"  ],  "legs": [    {      "currency": "string",      "amount_minor": 0,      "converted_minor": 0,      "rate": "string",      "rate_source": "string"    }  ]}