Skip to main content
GET
Your aggregator earnings

Authorizations

X-Api-Key
string
header
required

API key (programmatic access — recommended)

Send your API key in the X-Api-Key header. Keys start with nxs_ and are created in the dashboard (or via POST /api/keys with a session JWT).

Each key is scoped to one chain and one network (for example CARDANO_MAINNET), fixed at creation time. It cannot query a different network on the same chain, and it cannot query a different chain at all. A mismatched network parameter returns 400 Network Mismatch. Create one key per chain and network under the same account.

This is the credential most integrations should use.

Response

200 - */*

OK

Aggregator swap earnings for the authenticated user's partner keys.

lifetimeLovelace
integer<int64>
default:""

Everything ever accrued, in lovelace, paid or not. The number to show on a 'total earned' counter.

Example:

1250000000

paidLovelace
integer<int64>
default:""

Already paid out on-chain, in lovelace.

Example:

1000000000

unpaidLovelace
integer<int64>
default:""

Accrued but not yet paid out, in lovelace. Includes amounts reserved to a payout that has not confirmed yet.

Example:

250000000

keys
object[]

Per-key breakdown. Empty when the caller holds no partner keys.