API Reference

Get payment address, network, and fee information

get

Returns payment address and fee information required for using Shield

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://shield.rebarlabs.io/v1/info'

200

200

{
  "height": 800000,
  "payment": {
    "p2wpkh": "bc1q..."
  },
  "fees": [
    {
      "estimated_hashrate": 0.65,
      "feerate": 10
    },
    {
      "estimated_hashrate": 0.85,
      "feerate": 15
    },
    {
      "estimated_hashrate": 0.95,
      "feerate": 20
    }
  ]
}

Successful response

Submit raw transaction

post

Bitcoin Core compatible JSON-RPC endpoint for submitting transactions

Body

jsonrpcstring · enumrequired

JSON-RPC version

Options: 1.0

idstringrequired

Request identifier

methodstring · enumrequired

RPC method (must be 'sendrawtransaction')

Options: sendrawtransaction

paramsstring[] · min: 1 · max: 1required

Array containing the hex-encoded transaction

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://shield.rebarlabs.io/v1/rpc' \
  --header 'Content-Type: application/json' \
  --data '{
    "jsonrpc": "1.0",
    "id": "1",
    "method": "sendrawtransaction",
    "params": [
      "<RAW_TX>"
    ]
  }'

200

200

{
  "result": "<TX_ID>",
  "error": null,
  "id": "1"
}

Successful response

Check transaction status

get

Check if a transaction exists in Shield's internal mempool

Query parameters

txidstringrequired

The transaction ID to check for

Responses

text/plain

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://shield.rebarlabs.io/v1/txstatus?txid=text'

200

404

200

text

Transaction exists in Shield's internal mempool

Important Notes

1. Fee Payment: Transactions must include an output that pays the Shield service fee to the address provided in the /info endpoint

2. Fee Calculation: The fee rate calculation must include the Shield service fee output

3. Multiple Outputs: Do not split the Shield fee across multiple outputs; it must be paid in a single output

4. Pool Discretion: Each mining pool reserves the right to reject transactions based on their fee policies

5. P2P Broadcasting: Transactions that pay the Shield fee and have remaining change may be broadcast over the P2P network by mining pools