Retrieve Full List of BTC Staking Transactions

GET 
https://staking-api.test2.btcs.network//staking/btc/transactions/all

Returns full list of BTC staking transactions (including all active and historical data) by bitcoin address. Page size limited to 100.

Request

Query Parameters

btcAddress stringrequired

The Bitcoin address for which staking transactions are being requested.

pkHash stringrequired

The public key hash associated with the given Bitcoin address.

pageNum integer

The page number for pagination. Defaults to 1 if not provided.

pageSize integer

The number of transactions per page. Defaults to 100 if not provided.

Responses

200

BTC staking transactions retrieved successfully.

application/json

Schema

Schema

codestring
A status code indicating the result of the operation.
messagestring
Additional information or message about the response.
data object
stakedBTCTxList object[]
List of BTC staking transactions.
Array [
candidateAddressstring
The address of the candidate related to the transaction.
btcAddressstring
The Bitcoin address associated with the transaction.
btcTXIdstring
The unique transaction ID for the BTC staking transaction.
confirmedTxHashstring
The confirmed transaction hash for the BTC transaction.
btcAmountstring
The amount of BTC staked in the transaction.
scriptstring
The script associated with the transaction.
startRoundinteger
The starting round of the transaction.
endRoundinteger
The ending round of the transaction.
delegateRoundinteger
The delegate round for the transaction.
outputIndexinteger
The output index for the transaction.
rewardAddressstring
The reward address associated with the transaction.
unlockTimeinteger
The unlock time for the transaction.
redeemAddressstring
The redeem address for the transaction.
statusinteger
The status of the transaction.
redeemTxIdstring
The transaction ID for the redeem transaction.
pkHashstring
Public key hash associated with the given Bitcoin address.
]

Example (auto)

{
  "code": "string",
  "message": "string",
  "data": {
    "stakedBTCTxList": [
      {
        "candidateAddress": "string",
        "btcAddress": "string",
        "btcTXId": "string",
        "confirmedTxHash": "string",
        "btcAmount": "string",
        "script": "string",
        "startRound": 0,
        "endRound": 0,
        "delegateRound": 0,
        "outputIndex": 0,
        "rewardAddress": "string",
        "unlockTime": 0,
        "redeemAddress": "string",
        "status": 0,
        "redeemTxId": "string",
        "pkHash": "string"
      }
    ]
  }
}

400

An error occurred while retrieving the BTC staking transactions.

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/btc/transactions/all");
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

btcAddress — queryrequired

pkHash — queryrequired

pageNum — query

pageSize — query

ResponseClear

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