Modular Indexer API

Streamlined interfaces for querying balances, verifying transactions, and accessing brc-20 data efficiently.

Note: We are in the Alpha Testnet stage, so the API may undergo incompatible changes in the future. If you encounter any issues, please join our Discord to get in touch with the Nubit Team.

PreviousAPI Documentation NextLight Client API

Last updated 8 months ago

brc20_verifiable_current_balance_of_wallet

Get the latest balance of the wallet on its latest pkscript.

get

/v1/brc20_verifiable/current_balance_of_wallet

Query parameters

tickstring

walletstring

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/brc20_verifiable/current_balance_of_wallet' \
  --header 'Content-Type: application/json'

200

500

{
  "error": null,
  "proof": "text",
  "result": {
    "availableBalance": "text",
    "overallBalance": "text",
    "pkscript": "text"
  }
}

Success

brc20_verifiable_current_balance_of_pkscript

Get the latest balance of the wallet on its latest pkscript.

get

/v1/brc20_verifiable/current_balance_of_pkscript

Query parameters

tickstring

pkscriptstring

Body

object

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/brc20_verifiable/current_balance_of_pkscript' \
  --header 'Content-Type: application/json'

200

500

{
  "error": null,
  "result": {
    "availableBalance": "text",
    "overallBalance": "text",
    "pkscript": "text"
  },
  "proof": "text"
}

Success

brc20_verifiable_block_height

Get the latest synced block height of the brc20 indexer.

get

/v1/brc20_verifiable/block_height

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/brc20_verifiable/block_height'

200

Success

brc20_verifiable_latest_state_proof

Get the state difference, proof, and the transactions between the last block height and the current one.

get

/v1/brc20_verifiable/latest_state_proof

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1/brc20_verifiable/latest_state_proof'

200

500

{
  "error": null,
  "proof": "text",
  "result": {
    "ordTransfers": [
      {
        "ID": 1,
        "inscriptionID": "text",
        "newSatpoint": "text",
        "newPkscript": "text",
        "newWallet": "text",
        "sentAsFee": true,
        "content": "text",
        "contentType": "text"
      }
    ],
    "stateDiff": [
      "text"
    ]
  }
}

Success