Onchain API Reference

URL: https://rgb-node.thunderstack.org/api/

Generate new wallet keys (mnemonic, xpub, account xpubs, master fingerprint)

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/generate_keys

Responses

200

Successful response

application/json

mnemonicstringRequired

BIP39 mnemonic phrase

xpubstringRequired

Extended public key

account_xpub_vanillastringRequired

Account vanilla extended public key

account_xpub_coloredstringRequired

Account colored extended public key

master_fingerprintstringRequired

Master fingerprint

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/generate_keys

HTTPcURLJavaScriptPython

POST /wallet/generate_keys HTTP/1.1
Host: rgb-node.thunderstack.org
Accept: */*

{
  "mnemonic": "text",
  "xpub": "text",
  "account_xpub_vanilla": "text",
  "account_xpub_colored": "text",
  "master_fingerprint": "text"
}

Register a new wallet with the RGB Node

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/register

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses

200

Successful response

application/json

addressstringRequired

Bitcoin address

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/register

HTTPcURLJavaScriptPython

POST /wallet/register HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Accept: */*

{
  "address": "text",
  "btc_balance": {
    "vanilla": {
      "settled": 1,
      "future": 1,
      "spendable": 1
    },
    "colored": {
      "settled": 1,
      "future": 1,
      "spendable": 1
    }
  }
}

Get the BTC balance for the wallet

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/btcbalance

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses

200

Successful response

application/json

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/btcbalance

HTTPcURLJavaScriptPython

POST /wallet/btcbalance HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Accept: */*

{
  "vanilla": {
    "settled": 1,
    "future": 1,
    "spendable": 1
  },
  "colored": {
    "settled": 1,
    "future": 1,
    "spendable": 1
  }
}

Get a derived deposit address

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/address

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses

200

Successful response

application/json

stringOptional

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/address

HTTPcURLJavaScriptPython

POST /wallet/address HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Accept: */*

text

List all unspent UTXOs

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/listunspents

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses

200

Successful response

application/json

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/listunspents

HTTPcURLJavaScriptPython

POST /wallet/listunspents HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Accept: */*

[
  {
    "utxo": {
      "outpoint": {
        "txid": "text",
        "vout": 1
      },
      "btc_amount": 1,
      "colorable": true
    },
    "rgb_allocations": [
      {
        "asset_id": "text",
        "amount": 1,
        "settled": true
      }
    ]
  }
]

Start creating new UTXOs

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/createutxosbegin

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

up_tobooleanOptional

Create UTXOs up to a limit

numnumberOptional

Number of UTXOs to create

sizenumberOptional

Size of each UTXO in satoshis

fee_ratenumberOptional

Fee rate in sat/vB

Responses

200

Successful response

application/json

stringOptional

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/createutxosbegin

HTTPcURLJavaScriptPython

POST /wallet/createutxosbegin HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "up_to": true,
  "num": 1,
  "size": 1,
  "fee_rate": 1
}

text

Finalize UTXO creation with a signed PSBT

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/createutxosend

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

signed_psbtstringRequired

Signed PSBT in base64

Responses

200

Successful response

application/json

numberOptional

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/createutxosend

HTTPcURLJavaScriptPython

POST /wallet/createutxosend HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "signed_psbt": "text"
}

1

Begin sending RGB assets

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/sendbegin

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

invoicestringRequired

RGB invoice string

asset_idstringOptional

Asset ID (optional if in invoice)

amountnumberOptional

Amount to send (optional if in invoice)

fee_ratenumberOptional

Fee rate in sat/vB

Default: 1

min_confirmationsnumberOptional

Minimum confirmations

Default: 1

Responses

200

Successful response

application/json

stringOptional

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/sendbegin

HTTPcURLJavaScriptPython

POST /wallet/sendbegin HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "invoice": "text",
  "witness_data": {
    "amount_sat": 1,
    "blinding": 1
  },
  "asset_id": "text",
  "amount": 1,
  "fee_rate": 1,
  "min_confirmations": 1
}

text

Finalize sending RGB assets with a signed PSBT

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/sendend

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

signed_psbtstringRequired

Signed PSBT in base64

Responses

200

Successful response

application/json

txidstringRequired

Transaction ID

batch_transfer_idxnumberRequired

Batch transfer index

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/sendend

HTTPcURLJavaScriptPython

POST /wallet/sendend HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "signed_psbt": "text"
}

{
  "txid": "text",
  "batch_transfer_idx": 1
}

Begin sending BTC

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/sendbtcbegin

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

addressstringRequired

Bitcoin address to send to

amountnumberRequired

Amount in satoshis

fee_ratenumberRequired

Fee rate in sat/vB

skip_syncbooleanOptional

Skip wallet sync

Default: false

Responses

200

Successful response

application/json

stringOptional

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/sendbtcbegin

HTTPcURLJavaScriptPython

POST /wallet/sendbtcbegin HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "address": "text",
  "amount": 1,
  "fee_rate": 1,
  "skip_sync": false
}

text

Finalize sending BTC with a signed PSBT

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/sendbtcend

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

signed_psbtstringRequired

Signed PSBT in base64

skip_syncbooleanOptional

Skip wallet sync

Default: false

Responses

200

Successful response

application/json

stringOptional

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/sendbtcend

HTTPcURLJavaScriptPython

POST /wallet/sendbtcend HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "signed_psbt": "text",
  "skip_sync": false
}

text

Get fee estimation for a given number of blocks

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/get_fee_estimation

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

blocksnumberRequired

Number of blocks for fee estimation

Responses

200

Successful response

application/json

Fee estimation as object or number

or

numberOptional

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/get_fee_estimation

HTTPcURLJavaScriptPython

POST /wallet/get_fee_estimation HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "blocks": 1
}

{
  "ANY_ADDITIONAL_PROPERTY": 1
}

Generate blinded UTXO for receiving RGB assets

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/blindreceive

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

amountnumberRequired

Amount to receive

asset_idstringRequired

Asset ID

Responses

200

Successful response

application/json

invoicestringRequired

RGB invoice string

recipient_idstringRequired

Recipient ID

expiration_timestampnumberRequired

Expiration timestamp

batch_transfer_idxnumberRequired

Batch transfer index

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/blindreceive

HTTPcURLJavaScriptPython

POST /wallet/blindreceive HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "amount": 1,
  "asset_id": "text"
}

{
  "invoice": "text",
  "recipient_id": "text",
  "expiration_timestamp": 1,
  "batch_transfer_idx": 1
}

Generate witness UTXO for receiving RGB assets

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/witnessreceive

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

amountnumberRequired

Amount to receive

asset_idstringRequired

Asset ID

Responses

200

Successful response

application/json

invoicestringRequired

RGB invoice string

recipient_idstringRequired

Recipient ID

expiration_timestampnumberRequired

Expiration timestamp

batch_transfer_idxnumberRequired

Batch transfer index

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/witnessreceive

HTTPcURLJavaScriptPython

POST /wallet/witnessreceive HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "amount": 1,
  "asset_id": "text"
}

{
  "invoice": "text",
  "recipient_id": "text",
  "expiration_timestamp": 1,
  "batch_transfer_idx": 1
}

Get balance for a specific RGB asset

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/assetbalance

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

asset_idstringRequired

Asset ID

Responses

200

Successful response

application/json

settlednumberOptional

Settled balance

futurenumberOptional

Future balance

spendablenumberOptional

Spendable balance

offchainOutboundnumberOptional

Off-chain outbound balance

offchainInboundnumberOptional

Off-chain inbound balance

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/assetbalance

HTTPcURLJavaScriptPython

POST /wallet/assetbalance HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "asset_id": "text"
}

{
  "settled": 1,
  "future": 1,
  "spendable": 1,
  "offchainOutbound": 1,
  "offchainInbound": 1
}

Issue a new Non-Inflationary Asset (NIA)

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/issueassetnia

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

tickerstringRequired

Asset ticker symbol

namestringRequired

Asset name

amountsnumber[]Required

Initial amounts to issue

precisionnumberRequired

Decimal precision

Responses

200

Successful response

application/json

asset_idstringOptional

assetIfacestring · enumOptionalPossible values:

tickerstringOptional

namestringOptional

detailsstringOptional

precisionnumberOptional

issued_supplynumberOptional

timestampnumberOptional

added_atnumberOptional

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/issueassetnia

HTTPcURLJavaScriptPython

POST /wallet/issueassetnia HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "ticker": "text",
  "name": "text",
  "amounts": [
    1
  ],
  "precision": 1
}

{
  "asset_id": "text",
  "assetIface": "RGB20",
  "ticker": "text",
  "name": "text",
  "details": "text",
  "precision": 1,
  "issued_supply": 1,
  "timestamp": 1,
  "added_at": 1,
  "balance": {
    "vanilla": {
      "settled": 1,
      "future": 1,
      "spendable": 1
    },
    "colored": {
      "settled": 1,
      "future": 1,
      "spendable": 1
    }
  },
  "media": {
    "filePath": "text",
    "mime": "text"
  }
}

Issue a new Inflationary Asset (IFA)

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/issueassetifa

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

tickerstringRequired

Asset ticker symbol

namestringRequired

Asset name

precisionnumberRequired

Decimal precision

amountsnumber[]Required

Initial amounts to issue

inflation_amountsnumber[]Required

Inflation amounts

replace_rights_numnumberRequired

Number of replace rights

reject_list_urlstringOptional

Reject list URL

Responses

200

Successful response

application/json

asset_idstringRequired

tickerstringRequired

namestringRequired

detailsstringOptional

precisionnumberRequired

initial_supplynumberRequired

max_supplynumberRequired

known_circulating_supplynumberRequired

timestampnumberRequired

added_atnumberRequired

reject_list_urlstringOptional

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/issueassetifa

HTTPcURLJavaScriptPython

POST /wallet/issueassetifa HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "ticker": "text",
  "name": "text",
  "precision": 1,
  "amounts": [
    1
  ],
  "inflation_amounts": [
    1
  ],
  "replace_rights_num": 1,
  "reject_list_url": "text"
}

{
  "asset_id": "text",
  "ticker": "text",
  "name": "text",
  "details": "text",
  "precision": 1,
  "initial_supply": 1,
  "max_supply": 1,
  "known_circulating_supply": 1,
  "timestamp": 1,
  "added_at": 1,
  "balance": {
    "settled": 1,
    "future": 1,
    "spendable": 1
  },
  "media": {
    "filePath": "text",
    "mime": "text"
  },
  "reject_list_url": "text"
}

Begin inflating an IFA asset

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/inflatebegin

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

asset_idstringRequired

Asset ID to inflate

inflation_amountsnumber[]Required

Amounts to inflate

fee_ratenumberOptional

Fee rate in sat/vB

min_confirmationsnumberOptional

Minimum confirmations

Default: 1

Responses

200

Successful response

application/json

stringOptional

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/inflatebegin

HTTPcURLJavaScriptPython

POST /wallet/inflatebegin HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "asset_id": "text",
  "inflation_amounts": [
    1
  ],
  "fee_rate": 1,
  "min_confirmations": 1
}

text

Finalize asset inflation with a signed PSBT

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/inflateend

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

signed_psbtstringRequired

Signed PSBT in base64

Responses

200

Successful response

application/json

txidstringRequired

Transaction ID

batch_transfer_idxnumberRequired

Batch transfer index

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/inflateend

HTTPcURLJavaScriptPython

POST /wallet/inflateend HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "signed_psbt": "text"
}

{
  "txid": "text",
  "batch_transfer_idx": 1
}

List all RGB assets held in the wallet

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/listassets

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses

200

Successful response

application/json

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/listassets

HTTPcURLJavaScriptPython

POST /wallet/listassets HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Accept: */*

{
  "nia": [
    {
      "asset_id": "text",
      "assetIface": "RGB20",
      "ticker": "text",
      "name": "text",
      "details": "text",
      "precision": 1,
      "issued_supply": 1,
      "timestamp": 1,
      "added_at": 1,
      "balance": {
        "vanilla": {
          "settled": 1,
          "future": 1,
          "spendable": 1
        },
        "colored": {
          "settled": 1,
          "future": 1,
          "spendable": 1
        }
      },
      "media": {
        "filePath": "text",
        "mime": "text"
      }
    }
  ],
  "uda": [
    {
      "asset_id": "text",
      "assetIface": "RGB20",
      "ticker": "text",
      "name": "text",
      "details": "text",
      "precision": 1,
      "issued_supply": 1,
      "timestamp": 1,
      "added_at": 1,
      "balance": {
        "vanilla": {
          "settled": 1,
          "future": 1,
          "spendable": 1
        },
        "colored": {
          "settled": 1,
          "future": 1,
          "spendable": 1
        }
      },
      "media": {
        "filePath": "text",
        "mime": "text"
      }
    }
  ],
  "cfa": [
    {
      "asset_id": "text",
      "assetIface": "RGB20",
      "ticker": "text",
      "name": "text",
      "details": "text",
      "precision": 1,
      "issued_supply": 1,
      "timestamp": 1,
      "added_at": 1,
      "balance": {
        "vanilla": {
          "settled": 1,
          "future": 1,
          "spendable": 1
        },
        "colored": {
          "settled": 1,
          "future": 1,
          "spendable": 1
        }
      },
      "media": {
        "filePath": "text",
        "mime": "text"
      }
    }
  ]
}

Decode an RGB invoice string

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/decodergbinvoice

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

invoicestringRequired

RGB invoice string to decode

Responses

200

Successful response

application/json

recipient_idstringRequired

Recipient ID

asset_schemastringOptional

Asset schema type

asset_idstringOptional

Asset ID

networkstringRequired

Network name

assignment_namestringOptional

Assignment name

expiration_timestampnumberOptional

Expiration timestamp

transport_endpointsstring[]Required

Transport endpoints

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/decodergbinvoice

HTTPcURLJavaScriptPython

POST /wallet/decodergbinvoice HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "invoice": "text"
}

{
  "recipient_id": "text",
  "asset_schema": "text",
  "asset_id": "text",
  "network": "text",
  "assignment": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "assignment_name": "text",
  "expiration_timestamp": 1,
  "transport_endpoints": [
    "text"
  ]
}

Sync and refresh wallet state

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/refresh

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses

200

Successful response

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/refresh

HTTPcURLJavaScriptPython

POST /wallet/refresh HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Accept: */*

No content

Drop/delete the wallet from the RGB Node

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/drop

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses

200

Successful response

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/drop

HTTPcURLJavaScriptPython

POST /wallet/drop HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Accept: */*

No content

List all wallet transactions

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/listtransactions

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses

200

Successful response

application/json

transaction_typenumber · enumRequired

0=RGB_SEND, 1=DRAIN, 2=CREATE_UTXOS, 3=USER

Possible values:

txidstringRequired

receivednumberRequired

sentnumberRequired

feenumberRequired

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/listtransactions

HTTPcURLJavaScriptPython

POST /wallet/listtransactions HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Accept: */*

[
  {
    "transaction_type": 0,
    "txid": "text",
    "received": 1,
    "sent": 1,
    "fee": 1,
    "confirmation_time": {
      "height": 1,
      "timestamp": 1
    }
  }
]

List transfers for a specific asset

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/listtransfers

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

asset_idstringRequired

Asset ID

Responses

200

Successful response

application/json

idxnumberRequired

batch_transfer_idxnumberRequired

created_atnumberRequired

updated_atnumberRequired

statusnumber · enumRequired

0=WAITING_COUNTERPARTY, 1=WAITING_CONFIRMATIONS, 2=SETTLED, 3=FAILED

Possible values:

amountnumberRequired

kindnumber · enumRequired

Transfer kind: 0=ISSUANCE, 1=RECEIVE_BLIND, 2=RECEIVE_WITNESS, 3=SEND, 4=INFLATION

Possible values:

txidstring · nullableOptional

recipient_idstringRequired

expirationnumberRequired

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/listtransfers

HTTPcURLJavaScriptPython

POST /wallet/listtransfers HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "asset_id": "text"
}

[
  {
    "idx": 1,
    "batch_transfer_idx": 1,
    "created_at": 1,
    "updated_at": 1,
    "status": 0,
    "amount": 1,
    "kind": 0,
    "txid": "text",
    "recipient_id": "text",
    "receive_utxo": {
      "txid": "text",
      "vout": 1
    },
    "change_utxo": {
      "txid": "text",
      "vout": 1
    },
    "expiration": 1,
    "transport_endpoints": [
      {
        "endpoint": "text",
        "transport_type": 1,
        "used": true
      }
    ]
  }
]

Trigger wallet sync without additional refresh logic

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/sync

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses

200

Successful response

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/sync

HTTPcURLJavaScriptPython

POST /wallet/sync HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Accept: */*

No content

Mark transfers as failed

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/failtransfers

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

batch_transfer_idxnumberRequired

Batch transfer index

no_asset_onlybooleanOptional

Fail only transfers with no asset

Default: false

skip_syncbooleanOptional

Skip wallet sync

Default: false

Responses

200

Successful response

application/json

booleanOptional

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/failtransfers

HTTPcURLJavaScriptPython

POST /wallet/failtransfers HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "batch_transfer_idx": 1,
  "no_asset_only": false,
  "skip_sync": false
}

true

Create a wallet backup

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/backup

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

application/json

passwordstringRequired

Backup password

Responses

200

Successful response

application/json

messagestringRequired

download_urlstringRequired

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/backup

HTTPcURLJavaScriptPython

POST /wallet/backup HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "password": "text"
}

{
  "message": "text",
  "download_url": "text"
}

Download a wallet backup file

get

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/backup/{backupId}

Path parameters

backupIdstringRequired

The backupId parameter

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Responses

200

Successful response

application/json

string · binaryOptional

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

get

/wallet/backup/{backupId}

HTTPcURLJavaScriptPython

GET /wallet/backup/{backupId} HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Accept: */*

binary

Restore a wallet from a backup file

post

https://rgb-node.thunderstack.orghttps://rgb-node.test.thunderstack.orghttp://127.0.0.1:8000

/wallet/restore

Header parameters

xpub-vanstringRequired

Vanilla extended public key

xpub-colstringRequired

Colored extended public key

master-fingerprintstringRequired

Master fingerprint

Body

multipart/form-data

filestring · binaryRequired

Wallet backup file

passwordstringRequired

Backup password

xpub_vanstringOptional

Vanilla extended public key (optional)

xpub_colstringOptional

Colored extended public key (optional)

master_fingerprintstringOptional

Master fingerprint (optional)

Responses

200

Successful response

application/json

messagestringRequired

400

Bad request - RGB library error (default status for unlisted RGB errors)

application/json

404

Not found - Wallet or asset not found

application/json

409

Conflict - File already exists

application/json

422

Unprocessable Entity - Insufficient bitcoins or invalid amount

application/json

428

Precondition Required - Wallet sync needed

application/json

500

Internal server error

application/json

post

/wallet/restore

HTTPcURLJavaScriptPython

POST /wallet/restore HTTP/1.1
Host: rgb-node.thunderstack.org
xpub-van: text
xpub-col: text
master-fingerprint: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 99

{
  "file": "binary",
  "password": "text",
  "xpub_van": "text",
  "xpub_col": "text",
  "master_fingerprint": "text"
}

{
  "message": "text"
}