Leaders

List leader capabilities

Required API-key scope: leaders:read. Optional query filters: leader_address, network_object_id, is_founding, claimed, status (active/suspended/slashed), created_after / created_before (RFC3339, inclusive), page_token, page_size.

get /leaders

Authorizations

x-api-key string header required

Talus API Key in the form key_id.secret. The API also accepts Authorization: ApiKey <key_id.secret>, but the docs UI is configured to send x-api-key.

Query Parameters

leader_address string | null

Filter by the operator wallet address the cap was issued to.

network_object_id string | null

Filter by the network object the cap belongs to.

is_founding boolean | null

Filter founding caps (true) or issued caps (false).

claimed boolean | null

Filter caps that have (true) or have not (false) claimed the active state.

status string | null

Filter by serving status (active, suspended, slashed).

created_after string | null

Only include caps created at or after this RFC3339 timestamp.

created_before string | null

Only include caps created at or before this RFC3339 timestamp.

page_token integer | null
page_size integer | null

200application/json

Paginated list of leader capabilities

items object[] required
claim_token string | null
claimed_tx_digest string | null
created_at string required
created_tx_digest string required

The first transaction the projection saw for this cap — the creation transaction only if the projection saw it; a projection started mid-lineage records whichever status or stake event arrived first.

is_founding boolean required
issued_tx_digest string | null
leader_address string | null
leader_cap_id string required
network_object_id string | null

Null while the leader is known only from a LeaderUpserted or StakeDeposited that arrived ahead of its LeaderCapIssued, which is the only event carrying the network object.

onchain_created_at string | null

Checkpoint timestamp of the on-chain creation event; null for rows projected before on-chain timestamps were indexed (until a backfill + replay fills them).

registry_object_id string | null
stake_pool_total integer<int64> required

US currently pooled behind this leader, and the shares outstanding against it. Both are running aggregates over the stake ledger, so they are only complete if the projection saw the leader's whole history; GET /leaders/{leader_cap_id}/stake-events is the source of truth.

stake_total_shares integer<int64> required
status string | null

active, suspended or slashed. Null until a LeaderUpserted or LeaderStatusChanged names the state — a founding cap exists before either.

updated_at string required
metadata object required

Pagination metadata included in every listing response.

next_token integer | null

Token to pass as page_token to retrieve the next page. null means there are no more pages.

total_items integer<int64> required

Total number of items across all pages.

400

Invalid filter value

500

Internal server error