Skip to main content
API docs by Redocly

🦊 TzPro Tezos Token API

The TzPro Token API provides the most complete view on Tezos assets including metadata, supply, mint/burn/transfer events and ownership.

Supported token types

  • Financial Assets (FA tokens like FA1, FA1.2 and FA2 with TZIP16 metadata)
  • Non-fungible Tokens and NFT collections (FA2 with TZIP16, TZIP21 and custom metadata)
  • Liquidity Provider Tokens (LP) issued by DEX pools
  • Tezos Domains

Ledgers

Get info about token ledgers, list ledger-wide events and balances.

Get ledger by address

Returns a token ledger at the specified address.

path Parameters
address
required
string <contract-address>

Contract address.

Responses

Response Schema: application/json
category
string
Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more

Token category.

code_hash
string <hex> ^[0-9a-fA-F]{16}$

Contract code hash.

contract
string <contract-address>

Ledger contract address.

creator
string <address>

Wallet address who created the ledger contract.

description
string

Ledger description from metadata (may be empty or non-unique).

first_block
integer <int64>

Block height where ledger was created.

first_time
string <date-time>

Block timestamp where ledger was created.

homepage
string

Ledger homepage from metadata (may be empty).

id
integer <int64>

Internal database id.

name
string

Ledger name from metadata (may be empty or non-unique).

num_holders
integer <int64>

Number of current token owners.

num_minters
integer <int64>

Number of token minters.

num_tokens
integer <int64>

Number of unique tokens (token_ids) managed.

num_users
integer <int64>

Number of all-time total users.

tags
Array of strings
Items Enum: "deprecated" "insecure" "broken" "non-transferable" "scam" … 2 more

Optional tags for the ledger.

token_kind
string
Enum: "tez" "fa" "nft" "lp" "domain"

Token kind.

token_type
string
Enum: "native" "internal" "fa1" "fa1.2" "fa2" … 1 more

Token interface standard.

version
string

Ledger version from metadata (may be empty).

Response samples

Content type
application/json
{
  • "category": "art",
  • "code_hash": "1ab42d9942710e12",
  • "contract": "KT1RJ6PbjHpwc3M5rw5s2Nbmefwbuwbdxton",
  • "creator": "tz1UBZUkXpKGhYsP5KtzDNqLLchwF4uHrGjw",
  • "description": "OBJKTs FA2 collectibles",
  • "first_block": 1365143,
  • "first_time": "2021-03-01T01:59:41Z",
  • "homepage": "https://hicetnunc.xyz",
  • "id": 78,
  • "name": "OBJKTs",
  • "num_holders": 138739,
  • "num_tokens": 833224,
  • "num_users": 115310,
  • "tags": [ ],
  • "token_kind": "nft",
  • "token_type": "fa2",
  • "version": "2.0.0"
}

List token balances

Returns a list of token balances.

path Parameters
address
required
string <contract-address>

Contract address.

query Parameters
object

Filters by token id.

object

Filter by token balance.

object

Include zero balances.

offset
integer <int32> >= 0
Default: 0

Skips a number of items at the front of a list. Applied after sorting. Use in combination with limit to paginate results.

Performance hint: Prefer cursor in favor of offset/limit for pagination in large data sets.

Example: ?offset=100

limit
integer <int32> [ 0 .. 10000 ]
Default: 100

Maximum number of items to return.

cursor
integer <int64>

Skips list items with an id field less than the specified value (ascending sort order) or greater than (descending order).

Performance hint: Always prefer this method in favor of offset/limit for pagination when an id field is present.

Example: ?cursor=12345678

order
string
Default: "asc"
Enum: "asc" "desc"

Sorts results by id field in specified order.

Responses

Response Schema: application/json
Array
balance
string <bigint>

Balance (raw, without decimals).

category
string
Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more

Token category.

contract
string <contract-address>

Ledger address.

decimals
integer

Token decimals from metadata.

first_block
integer <int64>

Block height from which the current balance was valid.

id
integer <int64>

Internal database id.

last_block
integer <int64>

Block height until which the current balance was valid (may be zero for currently active balances).

name
string

Token name from metadata (may be empty or non-unique).

num_burns
integer <int64>

Number of token burn calls performed by owner.

num_mints
integer <int64>

Number of token mint calls performed by owner.

num_transfers
integer <int64>

Number of all-time token transfers sent and received by owner.

owner
string <address>

Owner address.

price_usd
string <fixed>

Current token price in USD (18 decimals).

symbol
string

Token symbol from metadata (may be empty or non-unique).

token_id
string <bigint>

Unique numeric token id within the ledger.

token_kind
string
Enum: "tez" "fa" "nft" "lp" "domain"

Token kind.

token_type
string
Enum: "native" "internal" "fa1" "fa1.2" "fa2" … 1 more

Token interface standard.

value_usd
string <fixed>

Current balance value in USD (18 decimals).

vol_burn
string <bigint>

Amount of tokens burned by the owner (raw, without decimals).

vol_mint
string <bigint>

Amount of tokens minted by the owner (raw, without decimals).

vol_recv
string <bigint>

Amount of tokens received by the owner (raw, without decimals).

vol_sent
string <bigint>

Amount of tokens sent by the owner (raw, without decimals).

Response samples

Content type
application/json
[
  • {
    }
]

List token events

Returns a list of token events from the ledger.

path Parameters
address
required
string <contract-address>

Contract address.

query Parameters
object

Filters by token id.

object

Filter by ledger event type.

object

Filter by token kind.

object

Filter by token category.

object

Filter by transaction signer.

object

Filter by token sender.

object

Filter by token receiver.

address
string <address>

Filter by any address in signer, sender, receiver.

object

Filter by token amount.

object

Filter by transaction hash.

object

Filter by transaction fee.

object

Filter by block height.

object

Filter by transaction date and time.

offset
integer <int32> >= 0
Default: 0

Skips a number of items at the front of a list. Applied after sorting. Use in combination with limit to paginate results.

Performance hint: Prefer cursor in favor of offset/limit for pagination in large data sets.

Example: ?offset=100

limit
integer <int32> [ 0 .. 10000 ]
Default: 100

Maximum number of items to return.

cursor
integer <int64>

Skips list items with an id field less than the specified value (ascending sort order) or greater than (descending order).

Performance hint: Always prefer this method in favor of offset/limit for pagination when an id field is present.

Example: ?cursor=12345678

order
string
Default: "asc"
Enum: "asc" "desc"

Sorts results by id field in specified order.

Responses

Response Schema: application/json
Array
amount
string <bigint>

Token amount.

block
integer <int64>

Block height for the event.

category
string
Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more

Token category.

contract
string <contract-address>

Ledger contract address.

decimals
integer

Token decimals from metadata.

event_type
string
Enum: "transfer" "mint" "burn"
id
integer <int64>

Internal database id.

name
string

Token name from metadata (may be empty or non-unique).

receiver
string <address>

Token receiver address.

sender
string <address>

Token sender address.

signer
string <address>

Transaction signer address.

symbol
string

Token symbol from metadata (may be empty or non-unique).

time
string <date-time>

Block timestamp for the event.

token_id
string <bigint>

Unique numeric token id within the ledger.

token_kind
string
Enum: "tez" "fa" "nft" "lp" "domain"

Token kind.

token_type
string
Enum: "native" "internal" "fa1" "fa1.2" "fa2" … 1 more

Token interface standard.

tx_fee
string <bigint>

Transaction fee paid (raw, no decimals).

tx_hash
string <hash>

Transaction hash related to the event.

Response samples

Content type
application/json
[
  • {
    }
]

List ledger tokens

Returns a list of tokens from the ledger.

path Parameters
address
required
string <contract-address>

Contract address.

query Parameters
object

Filters by token id.

object

Filters by token id as int64.

object

Filter by token kind.

object

Filter by token type.

object

Filter by token category.

object

Filter by token creator.

object

Filter by token name.

object

Filter by token symbol.

object

Filter by token decimals.

object

Filter by ledger tags.

object

Filter by first block seen.

object

Filter by first time seen.

offset
integer <int32> >= 0
Default: 0

Skips a number of items at the front of a list. Applied after sorting. Use in combination with limit to paginate results.

Performance hint: Prefer cursor in favor of offset/limit for pagination in large data sets.

Example: ?offset=100

limit
integer <int32> [ 0 .. 10000 ]
Default: 100

Maximum number of items to return.

cursor
integer <int64>

Skips list items with an id field less than the specified value (ascending sort order) or greater than (descending order).

Performance hint: Always prefer this method in favor of offset/limit for pagination when an id field is present.

Example: ?cursor=12345678

order
string
Default: "asc"
Enum: "asc" "desc"

Sorts results by id field in specified order.

Responses

Response Schema: application/json
Array
category
string
Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more

Token category.

contract
string <contract-address>

Ledger contract address.

creator
string <address>

Wallet address who signed the token mint transaction.

decimals
integer >= 0

Token decimals from metadata.

first_block
integer <int64>

Block height where token was minted.

first_time
string <date-time>

Block timestamp where token was minted.

id
integer <int64>

Internal database id.

last_supply_change_block
integer

Block height of most recent supply change as result of mint or burn.

last_supply_change_time
string <date-time>

Block timestamp of most recent supply change as result of mint or burn.

mcap_usd
string <fixed>

Current token market capitalization in USD (18 decimals).

name
string

Token name from metadata (may be empty or non-unique).

num_holders
integer <int64>

Number of current token owners.

num_minters
integer <int64>

Number of unique token minters.

num_users
integer <int64>

Number of all-time total users.

price_usd
string <fixed>

Current token price in USD (18 decimals).

symbol
string

Token symbol from metadata (may be empty or non-unique).

tags
Array of strings
Items Enum: "deprecated" "insecure" "broken" "non-transferable" "scam" … 2 more

Optional tags associated with the token.

token_id
string <bigint>

Unique numeric token id within the ledger.

token_kind
string
Enum: "tez" "fa" "nft" "lp" "domain"

Token kind.

token_type
string
Enum: "native" "internal" "fa1" "fa1.2" "fa2" … 1 more

Token interface standard.

total_burned
string <bigint>

Total number of tokens burned (raw, without decimals).

total_minted
string <bigint>

Total number of tokens minted (raw, without decimals).

total_supply
string <bigint>

Total number of tokens in existence (raw, without decimals).

Response samples

Content type
application/json
[
  • {
    }
]

Tokens

Get info about individual tokens inside a ledger, list events and balances.

Get token by address

Returns a token at the specified address.

path Parameters
address
required
string <token-address>

Token address.

Responses

Response Schema: application/json
category
string
Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more

Token category.

contract
string <contract-address>

Ledger contract address.

creator
string <address>

Wallet address who signed the token mint transaction.

decimals
integer >= 0

Token decimals from metadata.

first_block
integer <int64>

Block height where token was minted.

first_time
string <date-time>

Block timestamp where token was minted.

id
integer <int64>

Internal database id.

last_supply_change_block
integer

Block height of most recent supply change as result of mint or burn.

last_supply_change_time
string <date-time>

Block timestamp of most recent supply change as result of mint or burn.

mcap_usd
string <fixed>

Current token market capitalization in USD (18 decimals).

name
string

Token name from metadata (may be empty or non-unique).

num_holders
integer <int64>

Number of current token owners.

num_minters
integer <int64>

Number of unique token minters.

num_users
integer <int64>

Number of all-time total users.

price_usd
string <fixed>

Current token price in USD (18 decimals).

symbol
string

Token symbol from metadata (may be empty or non-unique).

tags
Array of strings
Items Enum: "deprecated" "insecure" "broken" "non-transferable" "scam" … 2 more

Optional tags associated with the token.

token_id
string <bigint>

Unique numeric token id within the ledger.

token_kind
string
Enum: "tez" "fa" "nft" "lp" "domain"

Token kind.

token_type
string
Enum: "native" "internal" "fa1" "fa1.2" "fa2" … 1 more

Token interface standard.

total_burned
string <bigint>

Total number of tokens burned (raw, without decimals).

total_minted
string <bigint>

Total number of tokens minted (raw, without decimals).

total_supply
string <bigint>

Total number of tokens in existence (raw, without decimals).

Response samples

Content type
application/json
{
  • "category": "stablecoin",
  • "contract": "KT1XnTn74bUtxHfDtBmm2bGZAQfhPbvKWR8o",
  • "creator": "tz1RZpNZYKtpmQhs8AxKcYVaKEek1kp8YbLZ",
  • "decimals": 6,
  • "first_block": 2494057,
  • "first_time": "2022-06-30T13:12:59Z",
  • "id": 3293416,
  • "last_supply_change_block": 2632919,
  • "last_supply_change_time": "2022-08-18T14:33:44Z",
  • "mcap_usd": "140921040.999440000000000000",
  • "name": "Tether USD",
  • "price_usd": "0.999440000000000000",
  • "symbol": "USDt",
  • "tags": [ ],
  • "token_id": "0",
  • "token_kind": "fa",
  • "token_type": "fa2",
  • "total_burned": "0",
  • "total_minted": "141000001000000",
  • "total_supply": "141000001000000"
}

List token balances

Returns a list of current token balances.

path Parameters
address
required
string <token-address>

Token address.

query Parameters
object

Filter by token balance.

object

Include zero balances.

offset
integer <int32> >= 0
Default: 0

Skips a number of items at the front of a list. Applied after sorting. Use in combination with limit to paginate results.

Performance hint: Prefer cursor in favor of offset/limit for pagination in large data sets.

Example: ?offset=100

limit
integer <int32> [ 0 .. 10000 ]
Default: 100

Maximum number of items to return.

cursor
integer <int64>

Skips list items with an id field less than the specified value (ascending sort order) or greater than (descending order).

Performance hint: Always prefer this method in favor of offset/limit for pagination when an id field is present.

Example: ?cursor=12345678

order
string
Default: "asc"
Enum: "asc" "desc"

Sorts results by id field in specified order.

Responses

Response Schema: application/json
Array
balance
string <bigint>

Balance (raw, without decimals).

category
string
Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more

Token category.

contract
string <contract-address>

Ledger address.

decimals
integer

Token decimals from metadata.

first_block
integer <int64>

Block height from which the current balance was valid.

id
integer <int64>

Internal database id.

last_block
integer <int64>

Block height until which the current balance was valid (may be zero for currently active balances).

name
string

Token name from metadata (may be empty or non-unique).

num_burns
integer <int64>

Number of token burn calls performed by owner.

num_mints
integer <int64>

Number of token mint calls performed by owner.

num_transfers
integer <int64>

Number of all-time token transfers sent and received by owner.

owner
string <address>

Owner address.

price_usd
string <fixed>

Current token price in USD (18 decimals).

symbol
string

Token symbol from metadata (may be empty or non-unique).

token_id
string <bigint>

Unique numeric token id within the ledger.

token_kind
string
Enum: "tez" "fa" "nft" "lp" "domain"

Token kind.

token_type
string
Enum: "native" "internal" "fa1" "fa1.2" "fa2" … 1 more

Token interface standard.

value_usd
string <fixed>

Current balance value in USD (18 decimals).

vol_burn
string <bigint>

Amount of tokens burned by the owner (raw, without decimals).

vol_mint
string <bigint>

Amount of tokens minted by the owner (raw, without decimals).

vol_recv
string <bigint>

Amount of tokens received by the owner (raw, without decimals).

vol_sent
string <bigint>

Amount of tokens sent by the owner (raw, without decimals).

Response samples

Content type
application/json
[
  • {
    }
]

List token events

Returns a list of token events.

path Parameters
address
required
string <token-address>

Token address.

query Parameters
object

Filter by ledger event type.

object

Filter by transaction signer.

object

Filter by token sender.

object

Filter by token receiver.

address
string <address>

Filter by any address in signer, sender, receiver.

object

Filter by token amount.

object

Filter by transaction hash.

object

Filter by transaction fee.

object

Filter by block height.

object

Filter by transaction date and time.

offset
integer <int32> >= 0
Default: 0

Skips a number of items at the front of a list. Applied after sorting. Use in combination with limit to paginate results.

Performance hint: Prefer cursor in favor of offset/limit for pagination in large data sets.

Example: ?offset=100

limit
integer <int32> [ 0 .. 10000 ]
Default: 100

Maximum number of items to return.

cursor
integer <int64>

Skips list items with an id field less than the specified value (ascending sort order) or greater than (descending order).

Performance hint: Always prefer this method in favor of offset/limit for pagination when an id field is present.

Example: ?cursor=12345678

order
string
Default: "asc"
Enum: "asc" "desc"

Sorts results by id field in specified order.

Responses

Response Schema: application/json
Array
amount
string <bigint>

Token amount.

block
integer <int64>

Block height for the event.

category
string
Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more

Token category.

contract
string <contract-address>

Ledger contract address.

decimals
integer

Token decimals from metadata.

event_type
string
Enum: "transfer" "mint" "burn"
id
integer <int64>

Internal database id.

name
string

Token name from metadata (may be empty or non-unique).

receiver
string <address>

Token receiver address.

sender
string <address>

Token sender address.

signer
string <address>

Transaction signer address.

symbol
string

Token symbol from metadata (may be empty or non-unique).

time
string <date-time>

Block timestamp for the event.

token_id
string <bigint>

Unique numeric token id within the ledger.

token_kind
string
Enum: "tez" "fa" "nft" "lp" "domain"

Token kind.

token_type
string
Enum: "native" "internal" "fa1" "fa1.2" "fa2" … 1 more

Token interface standard.

tx_fee
string <bigint>

Transaction fee paid (raw, no decimals).

tx_hash
string <hash>

Transaction hash related to the event.

Response samples

Content type
application/json
[
  • {
    }
]

Metadata

Get token and ledger metadata.

Get ledger metadata

Returns Tzip-16 contract metadata if available.

path Parameters
address
required
string <contract-address>

Contract address.

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{
  • "authors": [
    ],
  • "description": "OBJKTs FA2 collectibles",
  • "homepage": "https://hicetnunc.xyz",
  • "interfaces": [
    ],
  • "license": {
    },
  • "name": "OBJKTs",
  • "repository": "https://github.com/hic2nc2000",
  • "version": "2.0.0"
}

Get token metadata

Returns token metadata compliant with a public standard (Tzip-12 or Tzip-21 or private metadata as used by several NFT projects.

path Parameters
address
required
string <token-address>

Token address.

Responses

Response Schema: application/json
object

A token metadata object with public or private properties. For details see standards linked above.

Response samples

Content type
application/json
Example
{
  • "decimals": 5,
  • "isTransferable": true,
  • "name": "DOGAMI",
  • "shouldPreferSymbol": true,
  • "symbol": "DOGA",
  • "thumbnailUri": "ipfs://QmW8sa5UygUKg58LLzK7NoEDtCRyAQU4wZh1rbpFa6j7kP"
}

Wallets

Get info in indiviudal token holders like events and balances.

List wallet balances

Returns a list of token balances owned by a wallet.

path Parameters
address
required
string

Wallet address.

query Parameters
object

Filters by token.

object

Filters by token ledger.

object

Filters by token id.

object

Filter by token kind.

object

Filter by token category.

object

Filter by token balance.

object

Include zero balances.

offset
integer <int32> >= 0
Default: 0

Skips a number of items at the front of a list. Applied after sorting. Use in combination with limit to paginate results.

Performance hint: Prefer cursor in favor of offset/limit for pagination in large data sets.

Example: ?offset=100

limit
integer <int32> [ 0 .. 10000 ]
Default: 100

Maximum number of items to return.

cursor
integer <int64>

Skips list items with an id field less than the specified value (ascending sort order) or greater than (descending order).

Performance hint: Always prefer this method in favor of offset/limit for pagination when an id field is present.

Example: ?cursor=12345678

order
string
Default: "asc"
Enum: "asc" "desc"

Sorts results by id field in specified order.

Responses

Response Schema: application/json
Array
balance
string <bigint>

Balance (raw, without decimals).

category
string
Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more

Token category.

contract
string <contract-address>

Ledger address.

decimals
integer

Token decimals from metadata.

first_block
integer <int64>

Block height from which the current balance was valid.

id
integer <int64>

Internal database id.

last_block
integer <int64>

Block height until which the current balance was valid (may be zero for currently active balances).

name
string

Token name from metadata (may be empty or non-unique).

num_burns
integer <int64>

Number of token burn calls performed by owner.

num_mints
integer <int64>

Number of token mint calls performed by owner.

num_transfers
integer <int64>

Number of all-time token transfers sent and received by owner.

owner
string <address>

Owner address.

price_usd
string <fixed>

Current token price in USD (18 decimals).

symbol
string

Token symbol from metadata (may be empty or non-unique).

token_id
string <bigint>

Unique numeric token id within the ledger.

token_kind
string
Enum: "tez" "fa" "nft" "lp" "domain"

Token kind.

token_type
string
Enum: "native" "internal" "fa1" "fa1.2" "fa2" … 1 more

Token interface standard.

value_usd
string <fixed>

Current balance value in USD (18 decimals).

vol_burn
string <bigint>

Amount of tokens burned by the owner (raw, without decimals).

vol_mint
string <bigint>

Amount of tokens minted by the owner (raw, without decimals).

vol_recv
string <bigint>

Amount of tokens received by the owner (raw, without decimals).

vol_sent
string <bigint>

Amount of tokens sent by the owner (raw, without decimals).

Response samples

Content type
application/json
[
  • {
    }
]

List wallet events

Returns a list of ledger events for a wallet.

path Parameters
address
required
string

Wallet address.

query Parameters
object

Filters by token ledger.

object

Filters by token.

object

Filter by ledger event type.

object

Filter by token kind.

object

Filter by token category.

object

Filter by transaction signer.

object

Filter by token sender.

object

Filter by token receiver.

object

Filter by token amount.

object

Filter by transaction hash.

object

Filter by transaction fee.

object

Filter by block height.

object

Filter by transaction date and time.

offset
integer <int32> >= 0
Default: 0

Skips a number of items at the front of a list. Applied after sorting. Use in combination with limit to paginate results.

Performance hint: Prefer cursor in favor of offset/limit for pagination in large data sets.

Example: ?offset=100

limit
integer <int32> [ 0 .. 10000 ]
Default: 100

Maximum number of items to return.

cursor
integer <int64>

Skips list items with an id field less than the specified value (ascending sort order) or greater than (descending order).

Performance hint: Always prefer this method in favor of offset/limit for pagination when an id field is present.

Example: ?cursor=12345678

order
string
Default: "asc"
Enum: "asc" "desc"

Sorts results by id field in specified order.

Responses

Response Schema: application/json
Array
amount
string <bigint>

Token amount.

block
integer <int64>

Block height for the event.

category
string
Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more

Token category.

contract
string <contract-address>

Ledger contract address.

decimals
integer

Token decimals from metadata.

event_type
string
Enum: "transfer" "mint" "burn"
id
integer <int64>

Internal database id.

name
string

Token name from metadata (may be empty or non-unique).

receiver
string <address>

Token receiver address.

sender
string <address>

Token sender address.

signer
string <address>

Transaction signer address.

symbol
string

Token symbol from metadata (may be empty or non-unique).

time
string <date-time>

Block timestamp for the event.

token_id
string <bigint>

Unique numeric token id within the ledger.

token_kind
string
Enum: "tez" "fa" "nft" "lp" "domain"

Token kind.

token_type
string
Enum: "native" "internal" "fa1" "fa1.2" "fa2" … 1 more

Token interface standard.

tx_fee
string <bigint>

Transaction fee paid (raw, no decimals).

tx_hash
string <hash>

Transaction hash related to the event.

Response samples

Content type
application/json
[
  • {
    }
]

Firehose

List, filter and compare across all ledgers, tokens and events. Firehose access is limited to MAX subscribers only.

List all ledgers

Returns a list of ledgers.

query Parameters
object

Filters by ledger address.

object

Filter by contract creator.

object

Filter by token kind.

object

Filter by token type.

object

Filter by token category.

object

Filter by ledger tags.

string

Filter by code hash.

object

Filter by first block seen.

object

Filter by first time seen.

offset
integer <int32> >= 0
Default: 0

Skips a number of items at the front of a list. Applied after sorting. Use in combination with limit to paginate results.

Performance hint: Prefer cursor in favor of offset/limit for pagination in large data sets.

Example: ?offset=100

limit
integer <int32> [ 0 .. 10000 ]
Default: 100

Maximum number of items to return.

cursor
integer <int64>

Skips list items with an id field less than the specified value (ascending sort order) or greater than (descending order).

Performance hint: Always prefer this method in favor of offset/limit for pagination when an id field is present.

Example: ?cursor=12345678

order
string
Default: "asc"
Enum: "asc" "desc"

Sorts results by id field in specified order.

Responses

Response Schema: application/json
Array
category
string
Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more

Token category.

code_hash
string <hex> ^[0-9a-fA-F]{16}$

Contract code hash.

contract
string <contract-address>

Ledger contract address.

creator
string <address>

Wallet address who created the ledger contract.

description
string

Ledger description from metadata (may be empty or non-unique).

first_block
integer <int64>

Block height where ledger was created.

first_time
string <date-time>

Block timestamp where ledger was created.

homepage
string

Ledger homepage from metadata (may be empty).

id
integer <int64>

Internal database id.

name
string

Ledger name from metadata (may be empty or non-unique).

num_holders
integer <int64>

Number of current token owners.

num_minters
integer <int64>

Number of token minters.

num_tokens
integer <int64>

Number of unique tokens (token_ids) managed.

num_users
integer <int64>

Number of all-time total users.

tags
Array of strings
Items Enum: "deprecated" "insecure" "broken" "non-transferable" "scam" … 2 more

Optional tags for the ledger.

token_kind
string
Enum: "tez" "fa" "nft" "lp" "domain"

Token kind.

token_type
string
Enum: "native" "internal" "fa1" "fa1.2" "fa2" … 1 more

Token interface standard.

version
string

Ledger version from metadata (may be empty).

Response samples

Content type
application/json
[
  • {
    }
]

List all events

Returns a list of ledger events.

query Parameters
object

Filters by ledger address.

object

Filters by token address.

object

Filter by ledger event type.

object

Filter by token kind.

object

Filter by token category.

object

Filter by transaction signer.

object

Filter by token sender.

object

Filter by token receiver.

address
string <address>

Filter by any address in signer, sender, receiver.

object

Filter by token amount.

object

Filter by transaction hash.

object

Filter by transaction fee.

object

Filter by block height.

object

Filter by transaction date and time.

offset
integer <int32> >= 0
Default: 0

Skips a number of items at the front of a list. Applied after sorting. Use in combination with limit to paginate results.

Performance hint: Prefer cursor in favor of offset/limit for pagination in large data sets.

Example: ?offset=100

limit
integer <int32> [ 0 .. 10000 ]
Default: 100

Maximum number of items to return.

cursor
integer <int64>

Skips list items with an id field less than the specified value (ascending sort order) or greater than (descending order).

Performance hint: Always prefer this method in favor of offset/limit for pagination when an id field is present.

Example: ?cursor=12345678

order
string
Default: "asc"
Enum: "asc" "desc"

Sorts results by id field in specified order.

Responses

Response Schema: application/json
Array
amount
string <bigint>

Token amount.

block
integer <int64>

Block height for the event.

category
string
Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more

Token category.

contract
string <contract-address>

Ledger contract address.

decimals
integer

Token decimals from metadata.

event_type
string
Enum: "transfer" "mint" "burn"
id
integer <int64>

Internal database id.

name
string

Token name from metadata (may be empty or non-unique).

receiver
string <address>

Token receiver address.

sender
string <address>

Token sender address.

signer
string <address>

Transaction signer address.

symbol
string

Token symbol from metadata (may be empty or non-unique).

time
string <date-time>

Block timestamp for the event.

token_id
string <bigint>

Unique numeric token id within the ledger.

token_kind
string
Enum: "tez" "fa" "nft" "lp" "domain"

Token kind.

token_type
string
Enum: "native" "internal" "fa1" "fa1.2" "fa2" … 1 more

Token interface standard.

tx_fee
string <bigint>

Transaction fee paid (raw, no decimals).

tx_hash
string <hash>

Transaction hash related to the event.

Response samples

Content type
application/json
[
  • {
    }
]

List all tokens

Returns a list of tokens.

query Parameters
object

Filters by ledger address.

object

Filters by token id.

object

Filter by token kind.

object

Filter by token type.

object

Filter by token category.

object

Filter by token creator.

object

Filter by token name.

object

Filter by token symbol.

object

Filter by token decimals.

object

Filter by ledger tags.

object

Filter by first block seen.

object

Filter by first time seen.

offset
integer <int32> >= 0
Default: 0

Skips a number of items at the front of a list. Applied after sorting. Use in combination with limit to paginate results.

Performance hint: Prefer cursor in favor of offset/limit for pagination in large data sets.

Example: ?offset=100

limit
integer <int32> [ 0 .. 10000 ]
Default: 100

Maximum number of items to return.

cursor
integer <int64>

Skips list items with an id field less than the specified value (ascending sort order) or greater than (descending order).

Performance hint: Always prefer this method in favor of offset/limit for pagination when an id field is present.

Example: ?cursor=12345678

order
string
Default: "asc"
Enum: "asc" "desc"

Sorts results by id field in specified order.

Responses

Response Schema: application/json
Array
category
string
Enum: "none" "governance" "stablecoin" "bridged" "derivative" … 6 more

Token category.

contract
string <contract-address>

Ledger contract address.

creator
string <address>

Wallet address who signed the token mint transaction.

decimals
integer >= 0

Token decimals from metadata.

first_block
integer <int64>

Block height where token was minted.

first_time
string <date-time>

Block timestamp where token was minted.

id
integer <int64>

Internal database id.

last_supply_change_block
integer

Block height of most recent supply change as result of mint or burn.

last_supply_change_time
string <date-time>

Block timestamp of most recent supply change as result of mint or burn.

mcap_usd
string <fixed>

Current token market capitalization in USD (18 decimals).

name
string

Token name from metadata (may be empty or non-unique).

num_holders
integer <int64>

Number of current token owners.

num_minters
integer <int64>

Number of unique token minters.

num_users
integer <int64>

Number of all-time total users.

price_usd
string <fixed>

Current token price in USD (18 decimals).

symbol
string

Token symbol from metadata (may be empty or non-unique).

tags
Array of strings
Items Enum: "deprecated" "insecure" "broken" "non-transferable" "scam" … 2 more

Optional tags associated with the token.

token_id
string <bigint>

Unique numeric token id within the ledger.

token_kind
string
Enum: "tez" "fa" "nft" "lp" "domain"

Token kind.

token_type
string
Enum: "native" "internal" "fa1" "fa1.2" "fa2" … 1 more

Token interface standard.

total_burned
string <bigint>

Total number of tokens burned (raw, without decimals).

total_minted
string <bigint>

Total number of tokens minted (raw, without decimals).

total_supply
string <bigint>

Total number of tokens in existence (raw, without decimals).

Response samples

Content type
application/json
[
  • {
    }
]