Retrieve Collected and Pending Rewards

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

Returns the collected and pending rewards for a given Core address.

Request

Query Parameters

coreAddress stringrequired

The Core address for which to retrieve reward details.

Responses

200

Reward details retrieved successfully.

application/json

Schema

Schema

codestring

Status code indicating the result of the operation.

messagestring

Additional information or message about the response.

data object

Reward details for the given Core address.

pendingCoreRewardstring

Pending CORE rewards for the Core address.

pendingHashRewardstring

Pending HASH rewards for the Core address.

pendingBTCRewardstring

Pending BTC rewards for the Core address.

claimedCoreRewardstring

Collected CORE rewards for the Core address.

claimedHashRewardstring

Collected HASH rewards for the Core address.

claimedBTCRewardstring

Collected BTC rewards for the Core address.

Example (auto)

{
  "code": "string",
  "message": "string",
  "data": {
    "pendingCoreReward": "string",
    "pendingHashReward": "string",
    "pendingBTCReward": "string",
    "claimedCoreReward": "string",
    "claimedHashReward": "string",
    "claimedBTCReward": "string"
  }
}

400

Invalid Core address or an error occurred while retrieving reward details.

application/json

Schema

Schema

codestring

Error code indicating the result of the operation.

messagestring

Error message explaining the issue.

Example (auto)

{
  "code": "string",
  "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/rewards/detail");
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

coreAddress — queryrequired

ResponseClear

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