Get staking overview

This endpoint provides an overview of total staked amounts and rewards for a given user, aggregated both:

  • By asset (in asset units and converted fiat value).
  • As a total sum across all assets in the requested fiat currency.

It supports date-range filtering and asset filtering, allowing partners to query historical or specific subsets of staked amounts and rewards.

Keep in mind that since the staked amount is a point-in-time value, it reflects the amount staked as of the end date (or the most recent data if no end date is provided).

SecuritybearerAuth
Request
path Parameters
fiatSymbol
required
string = 3 characters
Example: EUR
query Parameters
start_date
string <date>

Optional filter: start date (inclusive) in YYYY-MM-DD. Ignored for point-in-time staking amounts.

If omitted, rewards are calculated from the beginning of available history.

Example: start_date=2025-01-01
end_date
string <date>

Optional filter: end date (inclusive) in YYYY-MM-DD.

If omitted, staking amounts and rewards are calculated up to the most recent available data.

Example: end_date=2025-01-31
asset_ids[]
Array of strings <uuid>

Optional filter: one or more asset IDs.

If provided, only totals and rewards for these assets are returned. If omitted, staking amounts and rewards for all assets are included. Non-existent asset IDs are ignored; 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>
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/fiats/{fiatSymbol}
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}