Get venue balance summary aggregated by asset across available venues

Get venue balance summary

GET /trade/v1/venues/balances/summary

Get venue balance summary aggregated by asset across available venues

cURL

curl --request GET \
  --url https://api.staging.layer1.com/trade/v1/venues/balances/summary \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "asset": "<string>",
    "venue": "kraken",
    "total": 100,
    "available": 90,
    "locked": 10,
    "loaned": 0,
    "borrowed": 0,
    "withdrawing": 0,
    "depositing": 0
  }
]

Query Parameters

aggregate · boolean

Aggregate balances from available venues for the same asset

nonZeroBalanceOnly · boolean

Show only balances with non-zero total or available balance

asset · string

Filter by asset

venue · string

Filter by venue

Response

200

*/*

OK

asset · string

The asset of balance

venue · string

The venue this balance is from

Example:

"kraken"

total · number

Total balance amount

Example:

100

available · number

Available balance amount for trading

Example:

90

locked · number

Amount locked in pending orders

Example:

10

loaned · number

Amount loaned to other accounts

Example:

0

borrowed · number

Amount borrowed from other accounts

Example:

0

withdrawing · number

Amount currently being withdrawn

Example:

0

depositing · number

Amount currently being deposited

Example:

0