Retrieve Reward Distribution of a Round

GET 
https://staking-api.test2.btcs.network//staking/summary/rewards

Returns the reward distribution for a specific staking round, including overall rewards distributed, burnt rewards, commission fees, and staking sharing.

Request

Query Parameters

round integerrequired

The round number for which reward distribution is being requested.

Responses

200

Reward distribution for the round retrieved successfully.

application/json

Schema

Schema

statusinteger

Status code indicating the result of the operation.

messagestring

Additional information or message about the response.

result object

roundinteger

The round number for which the reward distribution is reported.

overallRewardsDistributedinteger

The total rewards distributed in the given round.

rewardsBurntinteger

The amount of rewards burnt in the given round.

rewardsCommissionFeesinteger

The amount of rewards used for commission fees in the given round.

rewardsStakingSharinginteger

The amount of rewards distributed for staking sharing in the given round.

Example (auto)

{
  "status": 0,
  "message": "string",
  "result": {
    "round": 0,
    "overallRewardsDistributed": 0,
    "rewardsBurnt": 0,
    "rewardsCommissionFees": 0,
    "rewardsStakingSharing": 0
  }
}

400

An error occurred while retrieving the reward distribution.

application/json

Schema

Schema

statusinteger

Status code of the error response.

messagestring

Error message explaining the issue.

Example (auto)

{
  "status": 0,
  "message": "string"
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://staking-api.test2.btcs.network/staking/summary/rewards");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://staking-api.test2.btcs.network

Parameters

round — queryrequired

ResponseClear

Click the Send API Request button above and see the response here!