Get bonded overview

This endpoint provides an overview of bonded (locked) assets following an unstake action for assets that have a defined bonding period.

It returns aggregated data both:

  • Per asset — including the bonded amount (in asset units) and its corresponding fiat value.
  • Across all assets — showing the total bonded value in the requested fiat currency.

The endpoint also supports asset filtering, allowing partners to query specific subsets of bonded assets after unstaking.

SecuritybearerAuth
Request
path Parameters
fiatSymbol
required
string = 3 characters

Fiat currency symbol in ISO 4217 (3-letter) format.

Example: EUR
query Parameters
asset_ids[]
Array of strings <uuid>

Optional filter: one or more asset IDs.
If provided, only bonded amounts for these assets are returned.
If omitted, bonded amounts for all assets are included.
Non-existent PIDs are ignored but invalid UUIDs will cause a validation error.

Example: asset_ids[]=32b6f7de-1a71-4b8c-9d8a-1234567890ab&asset_ids[]=9f8d7c3e-2b33-41d2-bc99-abcdef123456
header Parameters
bp-user-id
required
string <uuid>

The unique identifier of the user whose bonded staking overview is being requested.

Responses
200

Success Response

401

Unauthorized

403

Forbidden

405

Not Allowed

422

Validation Error

429

Too Many Requests

500

Internal Error

503

Maintenance or Service unavailable

get/v1/staking/overview/bonded/fiats/{fiatSymbol}
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}