Rewards | XTZ (Tezos)

Get baker cycle rewards count

get

Returns total number of cycles where the baker was active

Authorizations

Path parameters

addressstringRequired

Baker address

Responses

200Success

application/json

Responseinteger · int32

get

GET /v1/rewards/bakers/{address}/count HTTP/1.1
Host: xtz-index.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

200Success

Get baker cycle rewards

get

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

Authorizations

Path parameters

addressstringRequired

Baker address.

Query parameters

cycleone of | nullableOptional

Filters rewards by cycle.

selectone of | nullableOptional

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.

sortone of | nullableOptional

Sorts cycle rewards by specified field. Supported fields: cycle (default, desc).

offsetone of | nullableOptional

Specifies which or how many items should be skipped

limitinteger · int32 · max: 10000Optional

Maximum number of items to return

Default: 100

quoteone ofOptional

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

Default: None

string · enumOptionalPossible values:

Responses

200Success

application/json

get

GET /v1/rewards/bakers/{address} HTTP/1.1
Host: xtz-index.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "cycle": 1,
    "bakingPower": 1,
    "totalBakingPower": 1,
    "ownDelegatedBalance": 1,
    "externalDelegatedBalance": 1,
    "delegatorsCount": 1,
    "ownStakedBalance": 1,
    "externalStakedBalance": 1,
    "stakersCount": 1,
    "expectedBlocks": 1,
    "expectedEndorsements": 1,
    "futureBlocks": 1,
    "futureBlockRewards": 1,
    "blocks": 1,
    "blockRewardsLiquid": 1,
    "blockRewardsStakedOwn": 1,
    "blockRewardsStakedShared": 1,
    "missedBlocks": 1,
    "missedBlockRewards": 1,
    "futureEndorsements": 1,
    "futureEndorsementRewards": 1,
    "endorsements": 1,
    "endorsementRewardsLiquid": 1,
    "endorsementRewardsStakedOwn": 1,
    "endorsementRewardsStakedShared": 1,
    "missedEndorsements": 1,
    "missedEndorsementRewards": 1,
    "blockFees": 1,
    "missedBlockFees": 1,
    "doubleBakingRewards": 1,
    "doubleBakingLostStaked": 1,
    "doubleBakingLostUnstaked": 1,
    "doubleBakingLostExternalStaked": 1,
    "doubleBakingLostExternalUnstaked": 1,
    "doubleEndorsingRewards": 1,
    "doubleEndorsingLostStaked": 1,
    "doubleEndorsingLostUnstaked": 1,
    "doubleEndorsingLostExternalStaked": 1,
    "doubleEndorsingLostExternalUnstaked": 1,
    "doublePreendorsingRewards": 1,
    "doublePreendorsingLostStaked": 1,
    "doublePreendorsingLostUnstaked": 1,
    "doublePreendorsingLostExternalStaked": 1,
    "doublePreendorsingLostExternalUnstaked": 1,
    "vdfRevelationRewardsLiquid": 1,
    "vdfRevelationRewardsStakedOwn": 1,
    "vdfRevelationRewardsStakedShared": 1,
    "nonceRevelationRewardsLiquid": 1,
    "nonceRevelationRewardsStakedOwn": 1,
    "nonceRevelationRewardsStakedShared": 1,
    "nonceRevelationLosses": 1,
    "quote": {
      "btc": 1,
      "eur": 1,
      "usd": 1,
      "cny": 1,
      "jpy": 1,
      "krw": 1,
      "eth": 1,
      "gbp": 1
    },
    "revelationRewards": 1,
    "revelationLosses": 1,
    "doublePreendorsingLosses": 1,
    "doubleEndorsingLosses": 1,
    "doubleBakingLosses": 1,
    "endorsementRewards": 1,
    "blockRewards": 1,
    "stakingBalance": 1,
    "activeStake": 1,
    "selectedStake": 1,
    "delegatedBalance": 1,
    "numDelegators": 1,
    "ownBlocks": 1,
    "extraBlocks": 1,
    "missedOwnBlocks": 1,
    "missedExtraBlocks": 1,
    "uncoveredOwnBlocks": 1,
    "uncoveredExtraBlocks": 1,
    "uncoveredEndorsements": 1,
    "ownBlockRewards": 1,
    "extraBlockRewards": 1,
    "missedOwnBlockRewards": 1,
    "missedExtraBlockRewards": 1,
    "uncoveredOwnBlockRewards": 1,
    "uncoveredExtraBlockRewards": 1,
    "uncoveredEndorsementRewards": 1,
    "ownBlockFees": 1,
    "extraBlockFees": 1,
    "missedOwnBlockFees": 1,
    "missedExtraBlockFees": 1,
    "uncoveredOwnBlockFees": 1,
    "uncoveredExtraBlockFees": 1,
    "doubleBakingLostDeposits": 1,
    "doubleBakingLostRewards": 1,
    "doubleBakingLostFees": 1,
    "doubleEndorsingLostDeposits": 1,
    "doubleEndorsingLostRewards": 1,
    "doubleEndorsingLostFees": 1,
    "revelationLostRewards": 1,
    "revelationLostFees": 1,
    "futureBlockDeposits": 1,
    "blockDeposits": 1,
    "futureEndorsementDeposits": 1,
    "endorsementDeposits": 1
  }
]

Get delegator cycle rewards count

get

Returns total number of cycles where the delegator was delegated to an active baker

Authorizations

Path parameters

addressstringRequired

Delegator address

Responses

200Success

application/json

Responseinteger · int32

get

GET /v1/rewards/delegators/{address}/count HTTP/1.1
Host: xtz-index.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

200Success

Get delegator cycle rewards

get

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

Authorizations

Path parameters

addressstringRequired

Delegator address.

Query parameters

cycleone of | nullableOptional

Filters rewards by cycle.

selectone of | nullableOptional

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.

sortone of | nullableOptional

Sorts cycle rewards by specified field. Supported fields: cycle (default, desc).

offsetone of | nullableOptional

Specifies which or how many items should be skipped

limitinteger · int32 · max: 10000Optional

Maximum number of items to return

Default: 100

quoteone ofOptional

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

Default: None

string · enumOptionalPossible values:

Responses

200Success

application/json

get

GET /v1/rewards/delegators/{address} HTTP/1.1
Host: xtz-index.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "cycle": 1,
    "delegatedBalance": 1,
    "stakedBalance": 1,
    "baker": {
      "alias": "text",
      "address": "text"
    },
    "bakingPower": 1,
    "totalBakingPower": 1,
    "bakerDelegatedBalance": 1,
    "externalDelegatedBalance": 1,
    "bakerStakedBalance": 1,
    "externalStakedBalance": 1,
    "expectedBlocks": 1,
    "expectedEndorsements": 1,
    "futureBlocks": 1,
    "futureBlockRewards": 1,
    "blocks": 1,
    "blockRewardsLiquid": 1,
    "blockRewardsStakedOwn": 1,
    "blockRewardsStakedShared": 1,
    "missedBlocks": 1,
    "missedBlockRewards": 1,
    "futureEndorsements": 1,
    "futureEndorsementRewards": 1,
    "endorsements": 1,
    "endorsementRewardsLiquid": 1,
    "endorsementRewardsStakedOwn": 1,
    "endorsementRewardsStakedShared": 1,
    "missedEndorsements": 1,
    "missedEndorsementRewards": 1,
    "blockFees": 1,
    "missedBlockFees": 1,
    "doubleBakingRewards": 1,
    "doubleBakingLostStaked": 1,
    "doubleBakingLostUnstaked": 1,
    "doubleBakingLostExternalStaked": 1,
    "doubleBakingLostExternalUnstaked": 1,
    "doubleEndorsingRewards": 1,
    "doubleEndorsingLostStaked": 1,
    "doubleEndorsingLostUnstaked": 1,
    "doubleEndorsingLostExternalStaked": 1,
    "doubleEndorsingLostExternalUnstaked": 1,
    "doublePreendorsingRewards": 1,
    "doublePreendorsingLostStaked": 1,
    "doublePreendorsingLostUnstaked": 1,
    "doublePreendorsingLostExternalStaked": 1,
    "doublePreendorsingLostExternalUnstaked": 1,
    "vdfRevelationRewardsLiquid": 1,
    "vdfRevelationRewardsStakedOwn": 1,
    "vdfRevelationRewardsStakedShared": 1,
    "nonceRevelationRewardsLiquid": 1,
    "nonceRevelationRewardsStakedOwn": 1,
    "nonceRevelationRewardsStakedShared": 1,
    "nonceRevelationLosses": 1,
    "quote": {
      "btc": 1,
      "eur": 1,
      "usd": 1,
      "cny": 1,
      "jpy": 1,
      "krw": 1,
      "eth": 1,
      "gbp": 1
    },
    "revelationRewards": 1,
    "revelationLosses": 1,
    "doublePreendorsingLosses": 1,
    "doubleEndorsingLosses": 1,
    "doubleBakingLosses": 1,
    "endorsementRewards": 1,
    "blockRewards": 1,
    "stakingBalance": 1,
    "activeStake": 1,
    "selectedStake": 1,
    "balance": 1,
    "ownBlocks": 1,
    "extraBlocks": 1,
    "missedOwnBlocks": 1,
    "missedExtraBlocks": 1,
    "uncoveredOwnBlocks": 1,
    "uncoveredExtraBlocks": 1,
    "uncoveredEndorsements": 1,
    "ownBlockRewards": 1,
    "extraBlockRewards": 1,
    "missedOwnBlockRewards": 1,
    "missedExtraBlockRewards": 1,
    "uncoveredOwnBlockRewards": 1,
    "uncoveredExtraBlockRewards": 1,
    "uncoveredEndorsementRewards": 1,
    "ownBlockFees": 1,
    "extraBlockFees": 1,
    "missedOwnBlockFees": 1,
    "missedExtraBlockFees": 1,
    "uncoveredOwnBlockFees": 1,
    "uncoveredExtraBlockFees": 1,
    "doubleBakingLostDeposits": 1,
    "doubleBakingLostRewards": 1,
    "doubleBakingLostFees": 1,
    "doubleEndorsingLostDeposits": 1,
    "doubleEndorsingLostRewards": 1,
    "doubleEndorsingLostFees": 1,
    "revelationLostRewards": 1,
    "revelationLostFees": 1
  }
]

Get reward split

get

Returns baker rewards for the specified cycle with all delegator balances at that cycle to allow rewards distribution in proportion to shares.

Authorizations

Path parameters

bakerstringRequired

Baker address

cycleinteger · int32Required

Rewards cycle

Query parameters

offsetinteger · int32Optional

Specifies how many delegators in the reward split should be skipped

Default: 0

limitinteger · int32 · max: 10000Optional

Maximum number of delegators to return

Default: 100

Responses

200Success

application/json

get

GET /v1/rewards/split/{baker}/{cycle} HTTP/1.1
Host: xtz-index.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "cycle": 1,
  "bakingPower": 1,
  "totalBakingPower": 1,
  "ownDelegatedBalance": 1,
  "externalDelegatedBalance": 1,
  "delegatorsCount": 1,
  "ownStakedBalance": 1,
  "externalStakedBalance": 1,
  "stakersCount": 1,
  "expectedBlocks": 1,
  "expectedEndorsements": 1,
  "futureBlocks": 1,
  "futureBlockRewards": 1,
  "blocks": 1,
  "blockRewardsLiquid": 1,
  "blockRewardsStakedOwn": 1,
  "blockRewardsStakedShared": 1,
  "missedBlocks": 1,
  "missedBlockRewards": 1,
  "futureEndorsements": 1,
  "futureEndorsementRewards": 1,
  "endorsements": 1,
  "endorsementRewardsLiquid": 1,
  "endorsementRewardsStakedOwn": 1,
  "endorsementRewardsStakedShared": 1,
  "missedEndorsements": 1,
  "missedEndorsementRewards": 1,
  "blockFees": 1,
  "missedBlockFees": 1,
  "doubleBakingRewards": 1,
  "doubleBakingLostStaked": 1,
  "doubleBakingLostUnstaked": 1,
  "doubleBakingLostExternalStaked": 1,
  "doubleBakingLostExternalUnstaked": 1,
  "doubleEndorsingRewards": 1,
  "doubleEndorsingLostStaked": 1,
  "doubleEndorsingLostUnstaked": 1,
  "doubleEndorsingLostExternalStaked": 1,
  "doubleEndorsingLostExternalUnstaked": 1,
  "doublePreendorsingRewards": 1,
  "doublePreendorsingLostStaked": 1,
  "doublePreendorsingLostUnstaked": 1,
  "doublePreendorsingLostExternalStaked": 1,
  "doublePreendorsingLostExternalUnstaked": 1,
  "vdfRevelationRewardsLiquid": 1,
  "vdfRevelationRewardsStakedOwn": 1,
  "vdfRevelationRewardsStakedShared": 1,
  "nonceRevelationRewardsLiquid": 1,
  "nonceRevelationRewardsStakedOwn": 1,
  "nonceRevelationRewardsStakedShared": 1,
  "nonceRevelationLosses": 1,
  "delegators": [
    {
      "address": "text",
      "delegatedBalance": 1,
      "stakedBalance": 1,
      "currentDelegatedBalance": 1,
      "currentStakedBalance": 1,
      "emptied": true,
      "balance": 1,
      "currentBalance": 1
    }
  ],
  "revelationRewards": 1,
  "revelationLosses": 1,
  "doublePreendorsingLosses": 1,
  "doubleEndorsingLosses": 1,
  "doubleBakingLosses": 1,
  "endorsementRewards": 1,
  "blockRewards": 1,
  "stakingBalance": 1,
  "activeStake": 1,
  "selectedStake": 1,
  "delegatedBalance": 1,
  "numDelegators": 1,
  "ownBlocks": 1,
  "extraBlocks": 1,
  "missedOwnBlocks": 1,
  "missedExtraBlocks": 1,
  "uncoveredOwnBlocks": 1,
  "uncoveredExtraBlocks": 1,
  "uncoveredEndorsements": 1,
  "ownBlockRewards": 1,
  "extraBlockRewards": 1,
  "missedOwnBlockRewards": 1,
  "missedExtraBlockRewards": 1,
  "uncoveredOwnBlockRewards": 1,
  "uncoveredExtraBlockRewards": 1,
  "uncoveredEndorsementRewards": 1,
  "ownBlockFees": 1,
  "extraBlockFees": 1,
  "missedOwnBlockFees": 1,
  "missedExtraBlockFees": 1,
  "uncoveredOwnBlockFees": 1,
  "uncoveredExtraBlockFees": 1,
  "doubleBakingLostDeposits": 1,
  "doubleBakingLostRewards": 1,
  "doubleBakingLostFees": 1,
  "doubleEndorsingLostDeposits": 1,
  "doubleEndorsingLostRewards": 1,
  "doubleEndorsingLostFees": 1,
  "revelationLostRewards": 1,
  "revelationLostFees": 1,
  "futureBlockDeposits": 1,
  "blockDeposits": 1,
  "futureEndorsementDeposits": 1,
  "endorsementDeposits": 1
}

Get reward split delegator

get

Returns delegator from the reward split for the specified cycle.

Authorizations

Path parameters

bakerstringRequired

Baker address

cycleinteger · int32Required

Reward split cycle

delegatorstringRequired

Delegator address

Responses

200Success

application/json

get

GET /v1/rewards/split/{baker}/{cycle}/{delegator} HTTP/1.1
Host: xtz-index.nownodes.io
api-key: YOUR_API_KEY
Accept: */*

200Success

{
  "address": "text",
  "delegatedBalance": 1,
  "stakedBalance": 1,
  "currentDelegatedBalance": 1,
  "currentStakedBalance": 1,
  "emptied": true,
  "balance": 1,
  "currentBalance": 1
}