Delegates

Get delegates

Returns a list of delegate accounts.

get/v1/delegates

Query parameters

eqboolean nullable

Equal filter mode (optional, i.e. param.eq=true is the same as param=true).
Specify a bool flag to get items where the specified field is equal to the specified value.

Example: ?active=true or ?active=1 or ?active.

nullboolean nullable

Is null filter mode.
Use this mode to get items where the specified field is null or not.

Example: ?active.null or ?active.null=false.

Delegate status to filter by (true - only active, false - only deactivated, undefined - all delegates)

eqinteger nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify an integer number to get items where the specified field is equal to the specified value.

Example: ?balance=1234.

neinteger nullable

Not equal filter mode.
Specify an integer number to get items where the specified field is not equal to the specified value.

Example: ?balance.ne=1234.

gtinteger nullable

Greater than filter mode.
Specify an integer number to get items where the specified field is greater than the specified value.

Example: ?balance.gt=1234.

geinteger nullable

Greater or equal filter mode.
Specify an integer number to get items where the specified field is greater than equal to the specified value.

Example: ?balance.ge=1234.

ltinteger nullable

Less than filter mode.
Specify an integer number to get items where the specified field is less than the specified value.

Example: ?balance.lt=1234.

leinteger nullable

Less or equal filter mode.
Specify an integer number to get items where the specified field is less than or equal to the specified value.

Example: ?balance.le=1234.

ininteger[] nullable

In list (any of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.

Example: ?level.in=12,14,52,69.

niinteger[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.

Example: ?level.ni=12,14,52,69.

Filters delegates by last activity level (where the delegate was updated)

fieldsstring[] nullable

Fields selection mode (optional, i.e. select.fields=balance is the same as select=balance).
Specify a comma-separated list of fields to include into response.

Example: ?select=address,balance => [ { "address": "asd", "balance": 10 } ].

valuesstring[] nullable

Values selection mode.
Specify a comma-separated list of fields to include their values into response.

Example: ?select.values=address,balance => [ [ "asd", 10 ] ].

Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.

ascstring nullable

Ascending sort mode (optional, i.e. sort.asc=id is the same as sort=id).
Specify a field name to sort by.

Example: ?sort=balance.

descstring nullable

Descending sort mode.
Specify a field name to sort by descending.

Example: ?sort.desc=id.

Sorts delegators by specified field. Supported fields: id (default), stakedBalance, externalStakedBalance, ownDelegatedBalance, externalDelegatedBalance, bakingPower, votingPower, balance, numDelegators, stakersCount, activationLevel, deactivationLevel.

elinteger nullable

Elements offset mode (optional, i.e. offset.el=123 is the same as offset=123).
Skips specified number of elements.

Example: ?offset=100.

pginteger nullable

Page offset mode.
Skips page * limit elements. This is a classic pagination.

Example: ?offset.pg=1.

crinteger nullable

Cursor offset mode.
Skips all elements with the cursor before (including) the specified value. Cursor is a field used for sorting, e.g. id. Avoid using this offset mode with non-unique or non-sequential cursors such as amount, balance, etc.

Example: ?offset.cr=45837.

Specifies which or how many items should be skipped

limitinteger

Maximum number of items to return

Response

idinteger

Internal TzKT id

typestring

Type of the account, delegate - account, registered as a delegate (baker)

addressstring required

Public key hash of the delegate's main key

consensusAddressstring nullable

Public key hash of the delegate's consensus key

companionAddressstring nullable

Public key hash of the delegate's companion key

activeboolean

Delegation status (true - active, false - deactivated)

aliasstring nullable

Name of the baking service

publicKeystring required

Public key of the delegate (baker)

revealedboolean

Public key revelation status. Unrevealed account can't send manager operation (transaction, origination etc.)

balanceinteger

Total balance of the delegate (baker), including spendable and frozen funds (micro tez)

rollupBondsinteger

Amount of tx rollup commitment bonds (micro tez)

smartRollupBondsinteger

Amount of smart rollup commitment bonds (micro tez)

stakedBalanceinteger

Amount staked from the own balance (micro tez). Like delegated amount, except for it is frozen and can be slashed.

unstakedBalanceinteger

Amount that was unstaked, but not yet finalized (i.e. it is still frozen) (micro tez).

externalStakedBalanceinteger

Amount staked from external stakers (micro tez). Like delegated amount, except for it is frozen and can be slashed.

externalUnstakedBalanceinteger

Amount that was unstaked by external stakers, but not yet finalized (i.e. it is still frozen) (micro tez).

roundingErrorinteger

Amount that was lost due to inconsistend rounding introduced in Oxford (micro tez).

totalStakedBalanceinteger

Total staked balance, which is stakedBalance + externalStakedBalance.

issuedPseudotokensstring nullable

Total amount of issued "pseudo-tokens". These pseudotokens are used for unstaking.

stakersCountinteger

Number of external stakers.

frozenDepositLimitinteger nullable

Configured max amount allowed to be locked as a security deposit (micro tez)

limitOfStakingOverBakinginteger nullable

This parameter determines the maximum portion (millionth) of external stake by stakers over the baker's own staked funds.

edgeOfBakingOverStakinginteger nullable

This parameter determines the fraction (billionth) of the rewards that accrue to the baker's liquid spendable balance — the remainder accrues to frozen stakes.

counterinteger

An account nonce which is used to prevent operation replay

activationLevelinteger

Block height when delegate (baker) was registered as a baker last time

activationTimestring date-time

Block datetime when delegate (baker) was registered as a baker last time (ISO 8601, e.g. 2019-11-31)

deactivationLevelinteger nullable

Block height when delegate (baker) was deactivated as a baker because of lack of funds or inactivity

deactivationTimestring date-time nullable

Block datetime when delegate (baker) was deactivated as a baker because of lack of funds or inactivity (ISO 8601, e.g. 2019-11-31)

bakingPowerinteger

Current baking power

votingPowerinteger

Current voting power

ownDelegatedBalanceinteger

Amount delegated from the own balance (micro tez).

externalDelegatedBalanceinteger

Amount delegated from the external delegators (micro tez).

numContractsinteger

Number of contracts, created (originated) and/or managed by the delegate (baker)

rollupsCountinteger

Number of tx rollups, created (originated) by the account

smartRollupsCountinteger

Number of smart rollups, created (originated) by the account

activeTokensCountinteger

Number of account tokens with non-zero balances

tokenBalancesCountinteger

Number of tokens the account ever had

tokenTransfersCountinteger

Number of token transfers from/to the account

activeTicketsCountinteger

Number of tickets the account owns.

ticketBalancesCountinteger

Number of tickets the account ever owned.

ticketTransfersCountinteger

Number of ticket transfers from/to the account.

numDelegatorsinteger

Number of current delegators (accounts, delegated their funds) of the delegate (baker)

numBlocksinteger

Number of baked (validated) blocks all the time by the delegate (baker)

numAttestationsinteger

Number of given attestations (approvals) by the delegate (baker)

numPreattestationsinteger

Number of given preattestations (approvals) by the delegate (baker)

numBallotsinteger

Number of submitted by the delegate ballots during a voting period

numProposalsinteger

Number of submitted (upvoted) by the delegate proposals during a proposal period

numActivationsinteger

Number of account activation operations. Are used to activate accounts that were recommended allocations of tezos tokens for donations to the Tezos Foundation’s fundraiser

numDoubleBakinginteger

Number of double baking (baking two different blocks at the same height) evidence operations, included in blocks, baked (validated) by the delegate

numDoubleConsensusinteger

Number of double consensus (attestation or preattestation of two different blocks at the same block height) evidence operations, included in blocks, baked (validated) by the delegate

numNonceRevelationsinteger

Number of seed nonce revelation (are used by the blockchain to create randomness) operations provided by the delegate

vdfRevelationsCountinteger

Number of vdf_revelation operations included into blocks by the delegate

numRevelationPenaltiesinteger

Number of operations for all time in which rewards were lost due to unrevealed seed nonces by the delegate (synthetic type)

numAttestationRewardsinteger

Number of attestation rewards received at the end of cycles (synthetic type)

numDelegationsinteger

Number of all delegation related operations (new delegator, left delegator, registration as a baker), related to the delegate (baker)

numOriginationsinteger

Number of all origination (deployment / contract creation) operations, related to the delegate (baker)

numTransactionsinteger

Number of all transaction (tez transfer) operations, related to the delegate (baker)

numRevealsinteger

Number of reveal (is used to reveal the public key associated with an account) operations of the delegate (baker)

numRegisterConstantsinteger

Number of register global constant operations sent by the baker

numSetDepositsLimitsinteger

Number of set deposits limit operations sent by the baker

numMigrationsinteger

Number of migration (result of the context (database) migration during a protocol update) operations, related to the delegate (synthetic type)

txRollupOriginationCountinteger

Number of tx rollup origination operations sent by the account

txRollupSubmitBatchCountinteger

Number of tx rollup submit batch operations sent by the account

txRollupCommitCountinteger

Number of tx rollup commit operations sent by the account

txRollupReturnBondCountinteger

Number of tx rollup return bond operations sent by the account

txRollupFinalizeCommitmentCountinteger

Number of tx rollup finalize commitment operations sent by the account

txRollupRemoveCommitmentCountinteger

Number of tx rollup remove commitment operations sent by the account

txRollupRejectionCountinteger

Number of tx rollup rejection operations sent by the account

txRollupDispatchTicketsCountinteger

Number of tx rollup dispatch tickets operations sent by the account

transferTicketCountinteger

Number of transfer ticket operations sent by the account

increasePaidStorageCountinteger

Number of increase_paid_storage operations sent by the account

updateSecondaryKeyCountinteger

Number of update_secondary_key operations sent by the account

drainDelegateCountinteger

Number of drain_delegate operations related to the account

smartRollupAddMessagesCountinteger

Number of smart_rollup_add_messages operations related to the account

smartRollupCementCountinteger

Number of smart_rollup_cement operations related to the account

smartRollupExecuteCountinteger

Number of smart_rollup_execute_outbox_message operations related to the account

smartRollupOriginateCountinteger

Number of smart_rollup_originate operations related to the account

smartRollupPublishCountinteger

Number of smart_rollup_publish operations related to the account

smartRollupRecoverBondCountinteger

Number of smart_rollup_recover_bond operations related to the account

smartRollupRefuteCountinteger

Number of smart_rollup_refute operations related to the account

refutationGamesCountinteger

Number of smart rollup refutation games related to the account

activeRefutationGamesCountinteger

Number of active smart rollup refutation games related to the account

stakingOpsCountinteger

Number of staking operations related to the account

autostakingOpsCountinteger

Number of autostaking operations related to the account

stakingUpdatesCountinteger

Number of staking updates related to the account

setDelegateParametersOpsCountinteger

Number of set delegate parameters operations related to the account

dalPublishCommitmentOpsCountinteger

Number of DAL publish commitment operations related to the account

dalEntrapmentEvidenceOpsCountinteger

Number of DAL entrapment evidences related to the account

dalAttestationRewardsCountinteger

Number of DAL attestation rewards related to the account

firstActivityinteger

Block height of the first operation, related to the delegate (baker)

firstActivityTimestring date-time

Block datetime of the first operation, related to the delegate (ISO 8601, e.g. 2020-02-20T02:40:57Z)

lastActivityinteger

Height of the block in which the account state was changed last time

lastActivityTimestring date-time

Datetime of the block in which the account state was changed last time (ISO 8601, e.g. 2020-02-20T02:40:57Z)

{"stackTrail":"components:schemas:Delegate:allOf:properties:extras","oasType":"schema","type":"unknown","description":"Off-chain extras","nullable":true}
softwareUpdateLevelinteger nullable

Level of the first block baked by the baker with the current software version

softwareUpdateTimestring date-time nullable

Datetime of the first block baked by the baker with the current software version

stakingBalanceinteger

DEPRECATED

delegatedBalanceinteger

DEPRECATED

updateConsensusKeyCountinteger

DEPRECATED

numEndorsementsinteger

DEPRECATED

numPreendorsementsinteger

DEPRECATED

numDoubleEndorsinginteger

DEPRECATED

numDoublePreendorsinginteger

DEPRECATED

numEndorsingRewardsinteger

DEPRECATED

Changes