Tokens
Last updated
Was this helpful?
Last updated
Was this helpful?
The Tokens endpoints in the Hedera Mirror Node REST API allow developers to retrieve token details, token balances, NFT metadata, and transaction history. These endpoints are essential for tracking tokenized assets and interactions on the Hedera network.
The following endpoints are available for the Tokens object:
Endpoint
Description
GET /api/v1/tokens
Retrieves a list of all tokens on the network.
GET /api/v1/tokens/balances
Lists token balances across accounts.
GET /api/v1/tokens/{id}
Fetches details of a specific token by ID.
GET /api/v1/tokens/nfts
Retrieves a list of all NFTs on the network.
GET /api/v1/tokens/nfts/{serialNumber}
Fetches metadata and details for a specific NFT.
GET /api/v1/tokens/nfts/{id}/transactions
Retrieves the transaction history of a specific NFT.
token_Id
The ID of the token in x.y.z format
symbol
The symbol of the token
admin_key
The admin key for the token
type
The type of token (fungible or non-fungible)
decimals
The decimal numbers of the token
metadata
The metadata of the token
/api/v1/tokens?publickey=3c3d546321ff6f63d70 1d2ec5c277095874e19f4a235bee1e6bb19258bf362be
All tokens with matching admin key
/api/v1/tokens?account.id=0.0.8
All tokens for matching account
/api/v1/tokens?token.id=gt:0.0.1001
All tokens in range
/api/v1/tokens?order=desc
All tokens in descending order of token.id
/api/v1/tokens?limit=x
All tokens taking the first x number of tokens
timestamp
The timestamp of the recorded balances in seconds.nanoseconds
balances
The balance of the tokens in those accounts
account
The ID of the account that has the token balance
balances.balance
The balance of the token associated with the account
/api/v1/tokens/<token_id>/balances?order=asc
The balance of the token in ascending order
/api/v1/tokens/<token_id>/balances?account.id=0.0.1000
The balance of the token for account ID 0.0.1000
/api/v1/tokens/<token_id>/balances?account.balance=gt:1000
The balance for the token greater than 1000
/api/v1/tokens/<token_id>/balances?timestamp=1566562500.040961001
The token balances for the specified timestamp
admin_key
The token's admin key, if specified
auto_renew_account
The auto renew account ID
auto_renew_period
The period at which the auto renew account will be charged a renewal fee
created_timestamp
The timestamp of when the token was created
decimals
The number of decimal places a token is divisible by
expiry_timestamp
The epoch second at which the token should expire
freeze_default
Whether or not accounts created
fee_schedule_key
The fee schedule key, if any
freeze_key
The freeze key for the token, if specified
initial_supply
The initial supply of the token
kyc_key
The KYC key for the token, if specified
modified_timestamp
The last time the token properties were modified
name
The name of the token
supply_key
The supply key for the token, if specified
symbol
The token symbol
token_id
The token ID
total_supply
The total supply of the token
treasury_account_id
The treasury account of the token
type
whether a token is a fungible or non-fungible token
wipe_key
The wipe key for the token, if specified
custom_fees
The custom fee schedule for the token, if any
pause_key
The pause key for a token, if specified
pause_status
Whether or not the token is paused
account_id
The account ID of the account associated with the NFT
created_timestamp
The timestamp of when the NFT was created
deleted
Whether the token was deleted or not
metadata
The meta data of the NFT
modified_timestamp
The last time the token properties were modified
serial_number
The serial number of the NFT
token_id
The token ID of the NFT
account_id
The account ID of the account associated with the NFT
created_timestamp
The timestamp of when the NFT was created
deleted
Whether the token was deleted or not
metadata
The meta data of the NFT
modified_timestamp
The last time the token properties were modified
serial_number
The serial number of the NFT
token_id
The token ID of the NFT
consensus_timestamp
The timestamp of the transaction
receiver_account_id
The account that received the NFT
sender_account_id
The account that sent the NFT
type
The type of transaction
transaction_id
The ID of the transaction
token_id
The token ID of the NFT
Returns a list of tokens on the network.
The ID of the account to return information for
{"summary":"--","value":""}Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$The maximum number of items to return
25Example: 2Partial or full token name. Not allowed to be used with token.id or account.id parameter. Pagination is not supported with the use of this parameter and results are ordered by token.id with respect to the order parameter.
The order in which items are listed
ascExample: descPossible values: The public key to compare against
3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362beThe ID of the token to return information for
{"summary":"--","value":""}Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$["ALL","FUNGIBLE_COMMON","NON_FUNGIBLE_UNIQUE"]Returns a list of token balances given the id. This represents the Token supply distribution across the network
Network entity ID in the format of shard.realm.num
0.0.2Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$The optional balance value to compare against
{"summary":"--","value":""}Pattern: ^((gte?|lte?|eq|ne)\:)?\d{1,10}$The ID of the account to return information for
{"summary":"--","value":""}Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$The account's public key to compare against
3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362beThe maximum number of items to return
25Example: 2The order in which items are listed
descExample: ascPossible values: The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.
{"summary":"--","value":""}Returns token entity information given the id
Network entity ID in the format of shard.realm.num
0.0.2Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$The Unix timestamp in seconds.nanoseconds format. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.
{"summary":"--","value":""}Pattern: ^((eq|lt|lte):)?\d{1,10}(.\d{1,9})?$Returns a list of non-fungible tokens
Network entity ID in the format of shard.realm.num
0.0.2Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$The ID of the account to return information for
{"summary":"--","value":""}Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$The maximum number of items to return
25Example: 2The order in which items are listed
descExample: ascPossible values: The nft serial number (64 bit type). Requires a tokenId value also be populated.
{"summary":"--","value":""}Pattern: ^((eq|gt|gte|lt|lte):)?\d{1,19}?$Returns information for a non-fungible token
Network entity ID in the format of shard.realm.num
0.0.2Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$The nft serial number
1Example: 1Returns a list of transactions for a given non-fungible token
Network entity ID in the format of shard.realm.num
0.0.2Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$The nft serial number
1Example: 1The maximum number of items to return
25Example: 2The order in which items are listed
descExample: ascPossible values: The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.
{"summary":"--","value":""}