Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tezos Rewards API

The Rewards API from Tezos — 8 operation(s) for rewards.

Tezos Rewards API is one of 34 APIs that Tezos publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Rewards. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 8 paths, and defines 15 schemas. It is described by OpenAPI 3.0.0, at version 1.17.1.

Requests are made against a single base URL, https://api.tzkt.io.

8 operations 8 paths 15 schemas 8 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.17.1
Base URL
https://api.tzkt.io/v1
Resource Areas
1

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 GET. Each is listed below with its method, path, parameters, and response codes.

Rewards 8
GET
/v1/rewards/bakers/{address}/count
Get baker cycle rewards count
Rewards_GetBakerRewardsCount 1 param → 200
GET
/v1/rewards/bakers/{address}
Get baker cycle rewards
Rewards_GetBakerRewards 7 params → 200
GET
/v1/rewards/delegators/{address}/count
Get delegator cycle rewards count
Rewards_GetDelegatorRewardsCount 1 param → 200
GET
/v1/rewards/delegators/{address}
Get delegator cycle rewards
Rewards_GetDelegatorRewards 7 params → 200
GET
/v1/rewards/stakers/{address}/count
Get staker cycle rewards count
Rewards_GetStakerRewardsCount 1 param → 200
GET
/v1/rewards/stakers/{address}
Get staker cycle rewards
Rewards_GetStakerRewards 7 params → 200
GET
/v1/rewards/split/{baker}/{cycle}
Get reward split
Rewards_GetRewardSplit 4 params → 200
GET
/v1/rewards/split/{baker}/{cycle}/{member}
Get reward split member
Rewards_GetRewardSplitMember 3 params → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are BakerRewards (80 properties), DelegatorRewards (66 properties), StakerRewards (10 properties), Int32Parameter (8 properties). Each schema is shown below with its type and property counts.

SelectionParameter
object
2 properties
QuoteShort
object
8 properties
Alias
object
2 properties
DelegatorRewards
object
66 properties
SortParameter
object
2 properties
SplitStaker
object
3 properties
RewardSplit
SplitActualStaker
object
4 properties
SplitDelegator
object
3 properties
BakerRewards
object
80 properties
OffsetParameter
object
3 properties
SplitMember
object
5 properties
Symbols
string
Int32Parameter
object
8 properties
StakerRewards
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tezos-rewards-api-openapi.yml Raw ↑

Other APIs Tezos publishes across the network.

TzKT Accounts API
TzKT Blocks API
TzKT Operations API
TzKT Contracts API
TzKT Big Maps API
TzKT Tokens API
TzKT Delegations and Staking API
TzKT Governance API
TzKT Protocols API
TzKT WebSocket API
Tezos Accounts API
Tezos BigMaps API