Modular Indexer (Light Client) APIs

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.

---

brc20_verifiable_light_current_balance_of_wallet

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

GET/v1/brc20_verifiable/light/current_balance_of_wallet

Query parameters

Body

application/json

object

Response

200500

Success

Body

application/json

error*null

The error message.

result*BRC20Balance (object)

proof*string

The proof of the result, use Base64 to encode the binary.

Request

JavaScriptCurl

const response = await fetch('/v1/brc20_verifiable/light/current_balance_of_wallet', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

brc20_verifiable_light_current_balance_of_pkscript

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

GET/v1/brc20_verifiable/light/current_balance_of_pkscript

Query parameters

Body

application/json

object

Response

200500

Success

Body

application/json

error*null

The error message.

result*brc20balancePkscript (object)

proof*string

The proof of the result, use Base64 to encode the binary.

Request

JavaScriptCurl

const response = await fetch('/v1/brc20_verifiable/light/current_balance_of_pkscript', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "result": {
    "availableBalance": "text",
    "overallBalance": "text"
  },
  "proof": "text"
}

brc20_verifiable_light_block_height

Get the latest synced block height of the brc20 indexer.

GET/v1/brc20_verifiable/light/block_height

Response

200

Success

Body

*/*

object

Request

JavaScriptCurl

const response = await fetch('/v1/brc20_verifiable/light/block_height', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{}

brc20_verifiable_light_current_checkpoints

GET/v1/brc20_verifiable/light/checkpoints

Response

200500

Success

Body

application/json

checkPoint*checkpoint (object)

sourceS3*sourceS3 (object)

sourceDa*sourceDa (object)

Request

JavaScriptCurl

const response = await fetch('/v1/brc20_verifiable/light/checkpoints', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "checkPoint": {
      "url": "text",
      "name": "text",
      "version": "text",
      "metaProtocol": "text",
      "height": "text",
      "hash": "text",
      "commitment": "text"
    },
    "sourceS3": {
      "region": "text",
      "bucket": "text",
      "name": "text"
    },
    "sourceDa": {
      "network": "text",
      "namespaceID": "text",
      "name": "text"
    }
  }
]

brc20_verifiable_light_last_checkpoint

GET/v1/brc20_verifiable/light/last_checkpoint

Response

200500

Success

Body

application/json

checkPoint*checkpoint (object)

sourceS3*sourceS3 (object)

sourceDa*sourceDa (object)

Request

JavaScriptCurl

const response = await fetch('/v1/brc20_verifiable/light/last_checkpoint', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "checkPoint": {
    "url": "text",
    "name": "text",
    "version": "text",
    "metaProtocol": "text",
    "height": "text",
    "hash": "text",
    "commitment": "text"
  },
  "sourceS3": {
    "region": "text",
    "bucket": "text",
    "name": "text"
  },
  "sourceDa": {
    "network": "text",
    "namespaceID": "text",
    "name": "text"
  }
}

brc20_verifiable_light_state

GET/v1/brc20_verifiable/light/state

Response

200

Success

Body

application/json

state*enum

The state of light indexer.

system is readysystem is syncingsystem is verifying

Request

JavaScriptCurl

const response = await fetch('/v1/brc20_verifiable/light/state', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "state": "system is ready"
}