Rewards

Get delegator cycle rewards

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

get/v1/rewards/delegators/{address}

Request

  • Base URL
    https://api.tzkt.io
  • URL
    https://api.tzkt.io/v1/rewards/delegators/{address}
  • Auth
    none declared

Path parameters

addressstring required

Delegator 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]

delegatedBalanceinteger

Amount delegated to the baker at the snapshot time (micro tez). This amount doesn't include staked amount.

stakedPseudotokensstring nullable

Amount of staked pseudotokens, representing staker's share within the baker's externalStakedBalance at the snapshot time.

stakedBalanceinteger nullable

Estimated amount staked to the baker at the snapshot time (micro tez). It's computed on-the-fly as externalStakedBalance * stakedPseudotokens / issuedPseudotokens.

bakingPowerinteger

DEPRECATED

totalBakingPowerinteger

DEPRECATED

bakerDelegatedBalanceinteger

DEPRECATED

externalDelegatedBalanceinteger

DEPRECATED

bakerStakedBalanceinteger

DEPRECATED

externalStakedBalanceinteger

DEPRECATED

expectedBlocksnumber double

DEPRECATED

expectedEndorsementsnumber double

DEPRECATED

expectedDalShardsinteger

DEPRECATED

futureBlocksinteger

DEPRECATED

futureBlockRewardsinteger

DEPRECATED

blocksinteger

DEPRECATED

blockRewardsDelegatedinteger

DEPRECATED

blockRewardsStakedOwninteger

DEPRECATED

blockRewardsStakedEdgeinteger

DEPRECATED

blockRewardsStakedSharedinteger

DEPRECATED

missedBlocksinteger

DEPRECATED

missedBlockRewardsinteger

DEPRECATED

futureEndorsementsinteger

DEPRECATED

futureEndorsementRewardsinteger

DEPRECATED

endorsementsinteger

DEPRECATED

endorsementRewardsDelegatedinteger

DEPRECATED

endorsementRewardsStakedOwninteger

DEPRECATED

endorsementRewardsStakedEdgeinteger

DEPRECATED

endorsementRewardsStakedSharedinteger

DEPRECATED

missedEndorsementsinteger

DEPRECATED

missedEndorsementRewardsinteger

DEPRECATED

futureDalAttestationRewardsinteger

DEPRECATED

dalAttestationRewardsDelegatedinteger

DEPRECATED

dalAttestationRewardsStakedOwninteger

DEPRECATED

dalAttestationRewardsStakedEdgeinteger

DEPRECATED

dalAttestationRewardsStakedSharedinteger

DEPRECATED

missedDalAttestationRewardsinteger

DEPRECATED

blockFeesinteger

DEPRECATED

missedBlockFeesinteger

DEPRECATED

doubleBakingRewardsinteger

DEPRECATED

doubleBakingLostStakedinteger

DEPRECATED

doubleBakingLostUnstakedinteger

DEPRECATED

doubleBakingLostExternalStakedinteger

DEPRECATED

doubleBakingLostExternalUnstakedinteger

DEPRECATED

doubleEndorsingRewardsinteger

DEPRECATED

doubleEndorsingLostStakedinteger

DEPRECATED

doubleEndorsingLostUnstakedinteger

DEPRECATED

doubleEndorsingLostExternalStakedinteger

DEPRECATED

doubleEndorsingLostExternalUnstakedinteger

DEPRECATED

doublePreendorsingRewardsinteger

DEPRECATED

doublePreendorsingLostStakedinteger

DEPRECATED

doublePreendorsingLostUnstakedinteger

DEPRECATED

doublePreendorsingLostExternalStakedinteger

DEPRECATED

doublePreendorsingLostExternalUnstakedinteger

DEPRECATED

vdfRevelationRewardsDelegatedinteger

DEPRECATED

vdfRevelationRewardsStakedOwninteger

DEPRECATED

vdfRevelationRewardsStakedEdgeinteger

DEPRECATED

vdfRevelationRewardsStakedSharedinteger

DEPRECATED

nonceRevelationRewardsDelegatedinteger

DEPRECATED

nonceRevelationRewardsStakedOwninteger

DEPRECATED

nonceRevelationRewardsStakedEdgeinteger

DEPRECATED

nonceRevelationRewardsStakedSharedinteger

DEPRECATED

nonceRevelationLossesinteger

DEPRECATED

Changes

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