POST
/
api
/
service
/
balance
/
retrieve
JavaScript
import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: 'My API Key',
});

const balance = await client.balance.retrieve({ currency: 'EUR' });

console.log(balance.balances);
{
  "balances": [
    {
      "currency": "EUR",
      "available": 123
    }
  ]
}

Authorizations

X-Ivy-Api-Key
string
header
required

API key for authentication

Body

application/json
currency
enum<string>
required

The currency to retrieve the balance for

Available options:
EUR,
GBP,
PLN,
SEK,
DKK

Response

200 - application/json

The account balance

balances
object[]
required

Array of balance information for different currencies