BRC 20

Endpoints to query BRC-20 token balances and events

BRC-20 Tokens

get

Retrieves information for BRC-20 tokens

Query parameters

tickerstring[]Optional

order_byany ofOptional

Parameter to order results by

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

offsetintegerOptional

Result offset

limitinteger · min: 1 · max: 60Optional

Results per page

Responses

200

Default Response

application/json

get

HTTPcURLJavaScriptPython

GET /ordinals/v1/brc-20/tokens HTTP/1.1
Host: api.rebarlabs.io
Accept: */*

200

Default Response

{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "id": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218i0",
      "number": 248751,
      "block_height": 752860,
      "tx_id": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218",
      "address": "bc1pvwh2dl6h388x65rqq47qjzdmsqgkatpt4hye6daf7yxvl0z3xjgq247aq8",
      "ticker": "PEPE",
      "max_supply": "21000000",
      "mint_limit": "100000",
      "decimals": 18,
      "deploy_timestamp": 1677733170000,
      "minted_supply": "1000000",
      "tx_count": 300000,
      "self_mint": true
    }
  ]
}

BRC-20 Token Details

get

Retrieves information for a BRC-20 token including supply and holders

Path parameters

tickerstringRequired

Responses

200

Default Response

application/json

404

Default Response

application/json

get

HTTPcURLJavaScriptPython

GET /ordinals/v1/brc-20/tokens/{ticker} HTTP/1.1
Host: api.rebarlabs.io
Accept: */*

{
  "token": {
    "id": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218i0",
    "number": 248751,
    "block_height": 752860,
    "tx_id": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218",
    "address": "bc1pvwh2dl6h388x65rqq47qjzdmsqgkatpt4hye6daf7yxvl0z3xjgq247aq8",
    "ticker": "PEPE",
    "max_supply": "21000000",
    "mint_limit": "100000",
    "decimals": 18,
    "deploy_timestamp": 1677733170000,
    "minted_supply": "1000000",
    "tx_count": 300000,
    "self_mint": true
  },
  "supply": {
    "max_supply": "21000000",
    "minted_supply": "1000000",
    "holders": 240
  }
}

BRC-20 Token Holders

get

Retrieves a list of holders and their balances for a BRC-20 token

Path parameters

tickerstringRequired

Query parameters

offsetintegerOptional

Result offset

limitinteger · min: 1 · max: 60Optional

Results per page

Responses

200

Default Response

application/json

404

Default Response

application/json

get

HTTPcURLJavaScriptPython

GET /ordinals/v1/brc-20/tokens/{ticker}/holders HTTP/1.1
Host: api.rebarlabs.io
Accept: */*

{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "address": "bc1pvwh2dl6h388x65rqq47qjzdmsqgkatpt4hye6daf7yxvl0z3xjgq247aq8",
      "overall_balance": "2000.00000"
    }
  ]
}

BRC-20 Balances

get

Retrieves BRC-20 token balances for a Bitcoin address

Path parameters

addressstringRequired

Bitcoin address

Example: bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5

Query parameters

tickerstring[]Optional

block_heightstringOptional

Bitcoin block height

Example: 777678Pattern: ^[0-9]+$

offsetintegerOptional

Result offset

limitinteger · min: 1 · max: 60Optional

Results per page

Responses

200

Default Response

application/json

get

HTTPcURLJavaScriptPython

GET /ordinals/v1/brc-20/balances/{address} HTTP/1.1
Host: api.rebarlabs.io
Accept: */*

200

Default Response

{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "ticker": "PEPE",
      "available_balance": "1500.00000",
      "transferrable_balance": "500.00000",
      "overall_balance": "2000.00000"
    }
  ]
}

BRC-20 Activity

get

Retrieves BRC-20 activity filtered by ticker, address, operation, or at a specific block height

Query parameters

tickerstring[]Optional

block_heightstringOptional

Bitcoin block height

Example: 777678Pattern: ^[0-9]+$

addressstringOptional

Bitcoin address

Example: bc1p8aq8s3z9xl87e74twfk93mljxq6alv4a79yheadx33t9np4g2wkqqt8kc5

offsetintegerOptional

Result offset

limitinteger · min: 1 · max: 60Optional

Results per page

Responses

200

Default Response

application/json

get

HTTPcURLJavaScriptPython

GET /ordinals/v1/brc-20/activity HTTP/1.1
Host: api.rebarlabs.io
Accept: */*

200

Default Response

{
  "limit": 20,
  "offset": 0,
  "total": 1,
  "results": [
    {
      "operation": "deploy",
      "ticker": "PEPE",
      "inscription_id": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218i0",
      "block_height": 778921,
      "block_hash": "0000000000000000000452773967cdd62297137cdaf79950c5e8bb0c62075133",
      "tx_id": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218",
      "location": "1463d48e9248159084929294f64bda04487503d30ce7ab58365df1dc6fd58218:0:0",
      "address": "bc1pvwh2dl6h388x65rqq47qjzdmsqgkatpt4hye6daf7yxvl0z3xjgq247aq8",
      "timestamp": 1677733170000,
      "mint": {
        "amount": "1000000"
      },
      "deploy": {
        "max_supply": "21000000",
        "mint_limit": "100000",
        "decimals": 18
      },
      "transfer": {
        "amount": "1000000",
        "from_address": "bc1pvwh2dl6h388x65rqq47qjzdmsqgkatpt4hye6daf7yxvl0z3xjgq247aq8"
      },
      "transfer_send": {
        "amount": "1000000",
        "from_address": "bc1pvwh2dl6h388x65rqq47qjzdmsqgkatpt4hye6daf7yxvl0z3xjgq247aq8",
        "to_address": "bc1pvwh2dl6h388x65rqq47qjzdmsqgkatpt4hye6daf7yxvl0z3xjgq247aq8"
      }
    }
  ]
}