For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tokens

Read-only endpoints to obtain STX, fungible token, and non-fungible token details

Get total STX supply

get

Retrieves the total liquid STX supply in micro-STX (µSTX) at the current chain tip: all STX minted (including vesting schedule unlocks) plus matured miner coinbase rewards, minus burned STX.

Responses
200

Default Response

application/json
totalstringRequired

Total liquid STX supply as a string-quoted integer of micro-STX (µSTX): all STX minted (including vesting schedule unlocks) plus matured miner coinbase rewards, minus burned STX

Example: 1470469916700000Pattern: ^[0-9]+$
projected_total_2050stringRequired

Projected total STX supply in the year 2050, as a string-quoted integer of micro-STX (µSTX).

Example: 2318000000000000Pattern: ^[0-9]+$
get/extended/v3/tokens/stx/supply
GET /extended/v3/tokens/stx/supply HTTP/1.1
Host: api.hiro.so/
Accept: */*
{
  "total": "1470469916700000",
  "projected_total_2050": "2318000000000000"
}

Get STX holders

get

Retrieves the principals holding STX, sorted by balance descending. Balances are the total µSTX held, including any STX locked for stacking — they are not the spendable balance reported as available by a principal's STX balance.

Query parameters
limitinteger · min: 1 · max: 200Optional

Number of results per page

Default: 100
cursorstringOptional

Cursor for paginating fungible token holders (sorted by balance descending, then holder principal). Format: balance:principal

Pattern: ^\d+:\S+$
Responses
200

Default Response

application/json
totalintegerRequiredExample: 1
limitinteger · min: 1 · max: 200Required

Number of results per page

Default: 100
get/extended/v3/tokens/stx/holders
GET /extended/v3/tokens/stx/holders HTTP/1.1
Host: api.hiro.so/
Accept: */*
{
  "total": 1,
  "limit": 100,
  "cursor": {
    "next": "text",
    "previous": "text",
    "current": "text"
  },
  "results": [
    {
      "principal": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP",
      "balance": "174823763"
    }
  ]
}

Get fungible token holders

get

Retrieves the principals holding a given fungible token, sorted by balance descending. Balances are in the token's own base units.

Path parameters
asset_identifierstringRequired

Asset Identifier

Example: SP000000000000000000002Q6VF78.pox-3::stx-tokenPattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$
Query parameters
limitinteger · min: 1 · max: 200Optional

Number of results per page

Default: 100
cursorstringOptional

Cursor for paginating fungible token holders (sorted by balance descending, then holder principal). Format: balance:principal

Pattern: ^\d+:\S+$
Responses
200

Default Response

application/json
totalintegerRequiredExample: 1
limitinteger · min: 1 · max: 200Required

Number of results per page

Default: 100
get/extended/v3/tokens/ft/{asset_identifier}/holders
GET /extended/v3/tokens/ft/{asset_identifier}/holders HTTP/1.1
Host: api.hiro.so/
Accept: */*
{
  "total": 1,
  "limit": 100,
  "cursor": {
    "next": "text",
    "previous": "text",
    "current": "text"
  },
  "results": [
    {
      "principal": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP",
      "balance": "174823763"
    }
  ]
}

Get total fungible token supply

get

Retrieves the total supply of a fungible token: the sum of every holder balance, equivalent to the token's mints minus its burns. Returns a zero supply for a token with no recorded balances.

Path parameters
asset_identifierstringRequired

Asset Identifier

Example: SP000000000000000000002Q6VF78.pox-3::stx-tokenPattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$
Responses
200

Default Response

application/json
asset_identifierstringRequired

Asset Identifier

Example: SP000000000000000000002Q6VF78.pox-3::stx-tokenPattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$
totalstringRequired

Total supply of the token, as a string-quoted integer in the token's own base units.

Example: 5817609278457Pattern: ^[0-9]+$
get/extended/v3/tokens/ft/{asset_identifier}/supply
GET /extended/v3/tokens/ft/{asset_identifier}/supply HTTP/1.1
Host: api.hiro.so/
Accept: */*
{
  "asset_identifier": "SP000000000000000000002Q6VF78.pox-3::stx-token",
  "total": "5817609278457"
}

Get non-fungible token history

get

Retrieves the event history of a single non-fungible token instance, newest first. Useful for determining an asset's ownership history. Mints have a null sender and burns a null recipient. The instance is addressed by a SIP-009 token id, or by its serialized Clarity value when the collection is not keyed by a uint.

Path parameters
asset_identifierstringRequired

Asset Identifier

Example: SP000000000000000000002Q6VF78.pox-3::stx-tokenPattern: ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a-zA-Z]([a-zA-Z0-9]|[-_]){0,39}::[a-zA-Z]([a-zA-Z0-9]|[-_!?+<>=/*]){0,127}$
valuestringRequired

The token instance's identifier, either as a plain integer (a SIP-009 token id, which is serialized as a Clarity uint) or as a 0x-prefixed serialized Clarity value.

Example: {"value":"2051"}Pattern: ^(\d+|0x[a-fA-F0-9]+)$
Query parameters
limitinteger · min: 1 · max: 200Optional

Number of results per page

Default: 50
cursorstringOptional

Cursor for paginating individual events by their position in the chain. Format: block_height:microblock_sequence:tx_index:event_index

Pattern: ^[0-9]+:[0-9]+:[0-9]+:[0-9]+$
Responses
200

Default Response

application/json
totalintegerRequiredExample: 1
limitinteger · min: 1 · max: 200Required

Number of results per page

Default: 50
get/extended/v3/tokens/nft/{asset_identifier}/{value}/history
GET /extended/v3/tokens/nft/{asset_identifier}/{value}/history HTTP/1.1
Host: api.hiro.so/
Accept: */*
{
  "total": 1,
  "limit": 50,
  "cursor": {
    "next": "text",
    "previous": "text",
    "current": "text"
  },
  "results": [
    {
      "sender": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP",
      "recipient": "SP318Q55DEKHRXJK696033DQN5C54D9K2EE6DHRWP",
      "transaction": {
        "tx_id": "0xf6bd5f4a7b26184a3466340b2e99fd003b4962c0e382a7e4b6a13df3dd7a91c6",
        "event_index": 1
      },
      "block": {
        "height": 1,
        "hash": "text",
        "index_hash": "text",
        "time": 1,
        "time_iso": "2026-10-08T19:18:41.000Z",
        "tx_index": 1
      }
    }
  ]
}

Last updated

Was this helpful?