What each vault holds, per asset and network

GET

/v1/balances

const url = 'https://api.sotirea.com/v1/balances';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.sotirea.com/v1/balances \
  --header 'Authorization: Bearer <token>'

Amounts are strings of whole smallest units: 1.5 of an asset with 18 decimals is “1500000000000000000”. Spendable is what a new payment may use; money still arriving is in incoming and is not spendable until the network has made it final.

Authorizations

bearer

Parameters

Query Parameters

vault

integer

Only this vault’s.

chain

string

Only this network, by its CAIP-2 id, like eip155:1. Each vault lists the ids of its networks.

page

integer

Which page, from 1.

page_size

integer

How many per page, at most 100. 25 when not given.

Responses

200

Done.

application/json

object

data

required

Array<object>

object

address

required

string

asset

required

Native for the network’s own coin, or a token’s contract address.

string

available

required

Final, in the asset’s smallest unit.

string

chain_id

required

string

decimals

required

Any of:

integer
null

integer

held

required

Held for a compliance review: counted in available, not spendable until Sotirea releases it. Sotirea will contact you.

string

incoming

required

Seen arriving on the network and not yet final.

string

outgoing

required

Seen leaving on the network and not yet final.

string

paused

required

The network or asset is not available right now. What is held is still yours and deposits are still credited; it cannot be sent until it is available again.

boolean

recognised

required

True for the network’s coin and for tokens on Sotirea’s recognised list. Any other token’s symbol is whatever its contract calls itself, so do not trust it by name.

boolean

reserved

required

Promised to payments already accepted.

string

spendable

required

What a new payment may use. Show this as what can be sent.

string

symbol

required

string

updated_at

required

string format: date-time

vault_id

required

Any of:

integer
null

integer

vault_name

required

Any of:

string
null

string

meta

object

page

object

has_next

boolean

page

integer

page_size

integer

total

integer

total_pages

integer

request_id

Quote it when asking about a request; it is in the X-Request-Id header too.

string

success

required

Example

{
  "success": true
}

default

Refused or failed, in words a person can act on.

application/json

object

error

required

object

code

required

string

fields

object

key

additional properties

string

message

required

string

meta

object

request_id

Quote it when asking about a request.

string

success

required

Example

{
  "success": false
}