Retrieve BTC staking transactions

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

Returns the list of valid/active staking trasactions of a given bitcoin address or public key hash.

Request

Query Parameters

btcAddress stringrequired

The BTC address to retrieve staking transactions for.

pkHash stringrequired

Public key hash associated with the given BTC address.

Responses

200

Active BTC staking transactions retrieved successfully.

application/json

Schema

Schema

codestring

Code indicating the success of the operation.

messagestring

Additional information or message about the response.

data object

stakedBTCTxList object[]

List of active BTC staking transactions.

Array [

candidateAddressstring

The address of the candidate for the staking transaction.

btcAddressstring

The BTC address associated with the staking transaction.

btcTXIdstring

The transaction ID of the BTC staking.

confirmedTxHashstring

The hash of the confirmed BTC transaction.

btcAmountstring

The amount of BTC staked.

scriptstring

The script associated with the staking transaction.

startRoundinteger

The round when the staking transaction started.

endRoundinteger

The round when the staking transaction ends.

delegateRoundinteger

The round when the staking was delegated.

outputIndexinteger

The index of the output in the BTC transaction.

rewardAddressstring

The address to receive rewards from the staking transaction.

unlockTimeinteger

The unlock time for the BTC staking transaction.

redeemAddressstring

The address to redeem BTC from the staking transaction.

pkHashstring

Public key hash associated with the BTC address.

statusinteger

Integer indicating the status of the stake.

]

stakedBTCAmountinteger

Total amount of BTC currently staked.

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",
        "pkHash": "string",
        "status": 0
      }
    ],
    "stakedBTCAmount": 0
  }
}

400

Invalid BTC address or public key hash supplied.

application/json

Schema

Schema

codestring

Error code for 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

Request Collapse all

Base URL

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

Parameters

btcAddress — queryrequired

pkHash — queryrequired

ResponseClear

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