Light Client 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.

---

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

tickstring

Token name of BRC-20,example: btcs

walletstring

Address of tick

Body

object

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

500

200

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

Success

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

tickstring

Token name

pkscriptstring

the pkscript of tick

Body

object

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

500

200

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

Success

brc20_verifiable_light_block_height

Get the latest synced block height of the brc20 indexer.

get

/v1/brc20_verifiable/light/block_height

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

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

200

200

800000

Success

brc20_verifiable_light_current_checkpoints

get

/v1/brc20_verifiable/light/checkpoints

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/brc20_verifiable/light/checkpoints'

200

500

200

成功示例

成功示例

成功示例

{
  "error": "Internal Server Error",
  "code": 500
}

Success

brc20_verifiable_light_last_checkpoint

get

/v1/brc20_verifiable/light/last_checkpoint

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/brc20_verifiable/light/last_checkpoint'

200

500

200

{
  "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"
  }
}

Success

brc20_verifiable_light_state

get

/v1/brc20_verifiable/light/state

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/brc20_verifiable/light/state'

200

200

{
  "state": "system is ready"
}

Success