Rewards

Get baker cycle rewards

Returns a list of baker rewards for every cycle, including future cycles.

get/v1/rewards/bakers/{address}

Path parameters

addressstring required

Baker address.

Query parameters

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.

Filter by cycle.

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 items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.

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.
Click on the parameter to expand more details.

limitinteger

Maximum number of items to return.

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 as b,metadata.name as meta_name will result in [ { "address": "asd", "b": 10, "meta_name": "qwe" } ].

valuesstring[] nullable

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

Example: ?select.values=address,balance,metadata.name will result in [ [ "asd", 10, "qwe" ] ].

Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection (for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.

quote'None' | 'Btc' | 'Eur' | 'Usd' | 'Cny' | 'Jpy' | 'Krw' | 'Eth' | 'Gbp'

Comma-separated list of ticker symbols to inject historical prices into response

Response

cycleinteger

Cycle in which rewards were or will be earned.
[sortable]

ownDelegatedBalanceinteger

Amount delegated from the baker's own balance (micro tez). This amount doesn't include staked amount.

externalDelegatedBalanceinteger

Amount delegated from external delegators and "unstakers" (delegators who left the baker, but still had locked unstaked balance delegated to the baker) (micro tez). This amount doesn't include external staked amount.

delegatorsCountinteger

Number of delegators (those who were delegated to the baker). This doesn't include "unstakers" (delegators who left the baker, but still had locked unstaked balance delegated to the baker).

ownStakedBalanceinteger

Amount staked from the baker's own balance (micro tez).

externalStakedBalanceinteger

Amount staked from external stakers (micro tez).

stakersCountinteger

Number of external stakers (those who delegated to the baker and also staked some amount).

issuedPseudotokensstring nullable

Amount of staking pseudotokens issued by/for external stakers.

bakingPowerinteger

Baker's baking power

totalBakingPowerinteger

Sum of baking power of all active bakers

expectedBlocksnumber double

Expected value of how many blocks baker should produce based on baker's active stake, selected stake and blocks per cycle.

futureBlocksinteger

Number of blocks which baker is allowed to produce in this cycle based on future baking rights.

futureBlockRewardsinteger

Estimated value of future block rewards.

blocksinteger

Number of successfully baked blocks (both proposed and re-proposed blocks).

blockRewardsDelegatedinteger

Rewards, corresponding to delegated stake, received for baked blocks (both proposed and re-proposed blocks) on baker's liquid balance (it is not frozen and can be spent immediately).

blockRewardsStakedOwninteger

Rewards, corresponding to baker's own stake, received for baked blocks (both proposed and re-proposed blocks) on baker's own staked balance (it is frozen and belongs to the baker).

blockRewardsStakedEdgeinteger

Rewards, corresponding to baker's edge from external stake, received for baked blocks (both proposed and re-proposed blocks) on baker's own staked balance (it is frozen and belongs to the baker).

blockRewardsStakedSharedinteger

Rewards, corresponding to baker's external stake, received for baked blocks (both proposed and re-proposed blocks) on baker's external staked balance (it is frozen and belongs to baker's stakers).

missedBlocksinteger

Number of missed opportunities to bake block.

missedBlockRewardsinteger

Rewards which were not received due to missing blocks.

expectedAttestationsnumber double

Expected value of how many slots baker should validate based on baker's active stake, selected stake and attestation slots per cycle.

futureAttestationsinteger

Number of slots which baker is allowed to validate in this cycle based on future attestation rights.

futureAttestationRewardsinteger

Estimated value of future attestation rewards.

attestationsinteger

Number of successfully attested slots.

attestationRewardsDelegatedinteger

Rewards, corresponding to delegated stake, received for attested slots on baker's liquid balance (it is not frozen and can be spent immediately).

attestationRewardsStakedOwninteger

Rewards, corresponding to baker's own stake, received for attested slots on baker's own staked balance (it is frozen and belongs to the baker).

attestationRewardsStakedEdgeinteger

Rewards, corresponding to baker's edge from external stake, received for attested slots on baker's own staked balance (it is frozen and belongs to the baker).

attestationRewardsStakedSharedinteger

Rewards, corresponding to baker's external stake, received for attested slots on baker's external staked balance (it is frozen and belongs to baker's stakers).

missedAttestationsinteger

Number of not attested (missed) slots.

missedAttestationRewardsinteger

Rewards which were not received due to missing attestations.

expectedDalAttestationsinteger

Expected value of how many dal shards baker should attest based on baker's active stake, selected stake and total shards per cycle.

futureDalAttestationRewardsinteger

Estimated value of future dal attestation rewards.

dalAttestationRewardsDelegatedinteger

Rewards, corresponding to delegated stake, received for attested dal shards on baker's liquid balance (it is not frozen and can be spent immediately).

dalAttestationRewardsStakedOwninteger

Rewards, corresponding to baker's own stake, received for attested dal shards on baker's own staked balance (it is frozen and belongs to the baker).

dalAttestationRewardsStakedEdgeinteger

Rewards, corresponding to baker's edge from external stake, received for attested dal shards on baker's own staked balance (it is frozen and belongs to the baker).

dalAttestationRewardsStakedSharedinteger

Rewards, corresponding to baker's external stake, received for attested dal shards on baker's external staked balance (it is frozen and belongs to baker's stakers).

missedDalAttestationRewardsinteger

Rewards which were not received due to denunciation or not enough participation.

blockFeesinteger

Operation fees which were harvested from successfully baked blocks.

missedBlockFeesinteger

Operation fees which were not received due to missing blocks.

doubleBakingRewardsinteger

Rewards for detecting double baking (accusing someone of producing two different blocks at the same level).

doubleBakingLostStakedinteger

Amount of baker's own staked balance lost due to double baking

doubleBakingLostUnstakedinteger

Amount of baker's own unstaked balance lost due to double baking

doubleBakingLostExternalStakedinteger

Amount of baker's external staked balance lost due to double baking

doubleBakingLostExternalUnstakedinteger

Amount of baker's external unstaked balance lost due to double baking

doubleConsensusRewardsinteger

Rewards for detecting double (pre)attestation (accusing someone of validating two different blocks at the same level).

doubleConsensusLostStakedinteger

Amount of baker's own staked balance lost due to double (pre)attestation

doubleConsensusLostUnstakedinteger

Amount of baker's own unstaked balance lost due to double (pre)attestation

doubleConsensusLostExternalStakedinteger

Amount of baker's external staked balance lost due to double (pre)attestation

doubleConsensusLostExternalUnstakedinteger

Amount of baker's external unstaked balance lost due to double (pre)attestation

vdfRevelationRewardsDelegatedinteger

Rewards, corresponding to delegated stake, for including vdf revelations, received on baker's liquid balance (it is not frozen and can be spent immediately).

vdfRevelationRewardsStakedOwninteger

Rewards, corresponding to baker's own stake, for including vdf revelations, received on baker's own staked balance (it is frozen and belongs to the baker).

vdfRevelationRewardsStakedEdgeinteger

Rewards, corresponding to baker's edge from external stake, for including vdf revelations, received on baker's own staked balance (it is frozen and belongs to the baker).

vdfRevelationRewardsStakedSharedinteger

Rewards, corresponding to baker's external stake, for including vdf revelations, received on baker's external staked balance (it is frozen and belongs to baker's stakers).

nonceRevelationRewardsDelegatedinteger

Rewards, corresponding to delegated stake, for including seed nonce revelations, received on baker's liquid balance (it is not frozen and can be spent immediately).

nonceRevelationRewardsStakedOwninteger

Rewards, corresponding to baker's own stake, for including seed nonce revelations, received on baker's own staked balance (it is frozen and belongs to the baker).

nonceRevelationRewardsStakedEdgeinteger

Rewards, corresponding to baker's edge from external stake, for including seed nonce revelations, received on baker's own staked balance (it is frozen and belongs to the baker).

nonceRevelationRewardsStakedSharedinteger

Rewards, corresponding to baker's external stake, for including seed nonce revelations, received on baker's external staked balance (it is frozen and belongs to baker's stakers).

nonceRevelationLossesinteger

Amount of frozen deposits lost due to missing seed nonce revelation (always zero after Ithaca).

expectedDalShardsinteger

DEPRECATED

expectedEndorsementsnumber double

DEPRECATED

futureEndorsementsinteger

DEPRECATED

futureEndorsementRewardsinteger

DEPRECATED

endorsementsinteger

DEPRECATED

endorsementRewardsDelegatedinteger

DEPRECATED

endorsementRewardsStakedOwninteger

DEPRECATED

endorsementRewardsStakedEdgeinteger

DEPRECATED

endorsementRewardsStakedSharedinteger

DEPRECATED

missedEndorsementsinteger

DEPRECATED

missedEndorsementRewardsinteger

DEPRECATED

doubleEndorsingRewardsinteger

DEPRECATED

doubleEndorsingLostStakedinteger

DEPRECATED

doubleEndorsingLostUnstakedinteger

DEPRECATED

doubleEndorsingLostExternalStakedinteger

DEPRECATED

doubleEndorsingLostExternalUnstakedinteger

DEPRECATED

doublePreendorsingRewardsinteger

DEPRECATED

doublePreendorsingLostStakedinteger

DEPRECATED

doublePreendorsingLostUnstakedinteger

DEPRECATED

doublePreendorsingLostExternalStakedinteger

DEPRECATED

doublePreendorsingLostExternalUnstakedinteger

DEPRECATED

Changes

No recorded changes to this endpoint across all 1 revision of this API.