Token Metadata API (v0.2.1)
Download OpenAPI specification:Download
Service that indexes metadata for every SIP-009, SIP-010, and SIP-013 Token in the Stacks blockchain and exposes it via REST API endpoints.
Fungible Tokens
Retrieves a list of Fungible Tokens
query Parameters
| name | string |
| symbol | string |
| address | string (Stacks Address) ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41} Example: address=SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9 Stacks Address |
| offset | integer (Offset) >= 0 Result offset |
| limit | integer (Limit) [ 1 .. 60 ] Results per page |
Order By (string) or Order By (string) (Order By) Parameter to order results by | |
Order (string) or Order (string) (Order) Results order |
Responses
Response samples
- 200
Content type
application/json
{- "limit": 20,
- "offset": 0,
- "total": 1,
- "results": [
- {
- "name": "Wrapped USD",
- "symbol": "xUSD",
- "decimals": 8,
- "total_supply": "9999980000000",
- "token_uri": "ipfs://ipfs/Qmf9yDYuPTrp8NRUFf8xxDd5Ud24Dx9uYMwMn8o8G2cWPW/12200.json",
- "description": "Heavy hitters, all-stars and legends of the game join forces to create a collection of unique varsity jackets",
- "image_canonical_uri": "ipfs://ipfs/QmZMqhh2ztwuZ3Y8PyEp2z5auyH3TCm3nnr5ZfjjgDjd5q/12199.png",
- "tx_id": "0xef2ac1126e16f46843228b1dk4830e19eb7599129e4jf392cab9e65ae83a45c0",
- "sender_address": "ST399W7Z9WS0GMSNQGJGME5JAENKN56D65VGMGKGA"
}
]
}
Fungible Token Metadata
Retrieves metadata for a SIP-010 Fungible Token
path Parameters
| principal required | string (Fungible Token Contract Principal) ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[... Example: SP32XCD69XPS3GKDEXAQ29PJRDSD5AR643GNEEBXZ.fari-token Principal for the contract which owns the SIP-010 token |
query Parameters
| locale | string (Localization) Examples:
Metadata localization to retrieve |
Responses
Response samples
- 200
- 404
- 422
Content type
application/json
{- "name": "Wrapped USD",
- "symbol": "xUSD",
- "decimals": 8,
- "total_supply": "9999980000000",
- "token_uri": "ipfs://ipfs/Qmf9yDYuPTrp8NRUFf8xxDd5Ud24Dx9uYMwMn8o8G2cWPW/12200.json",
- "description": "Heavy hitters, all-stars and legends of the game join forces to create a collection of unique varsity jackets",
- "image_canonical_uri": "ipfs://ipfs/QmZMqhh2ztwuZ3Y8PyEp2z5auyH3TCm3nnr5ZfjjgDjd5q/12199.png",
- "tx_id": "0xef2ac1126e16f46843228b1dk4830e19eb7599129e4jf392cab9e65ae83a45c0",
- "sender_address": "ST399W7Z9WS0GMSNQGJGME5JAENKN56D65VGMGKGA",
- "metadata": {
- "sip": 16,
- "name": "Satoshi's Team #12200",
- "description": "Heavy hitters, all-stars and legends of the game join forces to create a collection of unique varsity jackets",
- "image": "ipfs://ipfs/QmZMqhh2ztwuZ3Y8PyEp2z5auyH3TCm3nnr5ZfjjgDjd5q/12199.png",
- "attributes": [
- {
- "trait_type": "Background",
- "display_type": "string",
- "value": "value"
}
], - "properties": {
- "collection": "Foo Collection",
- "total_supply": "10000"
}, - "localization": {
- "default": "en",
- "locales": [
- "en",
- "jp"
]
}
}
}Non-Fungible Token Metadata
Retrieves metadata for a SIP-009 Non-Fungible Token
path Parameters
| principal required | string (Non-Fungible Token Contract Principal) ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[... Example: SP497E7RX3233ATBS2AB9G4WTHB63X5PBSP5VGAQ.boomboxes-cycle-12 SIP-009 compliant smart contract principal |
| token_id required | integer (Token ID) Example: 35 Token ID to retrieve |
query Parameters
| locale | string (Localization) Examples:
Metadata localization to retrieve |
Responses
Response samples
- 200
- 404
- 422
Content type
application/json
{- "token_uri": "ipfs://ipfs/Qmf9yDYuPTrp8NRUFf8xxDd5Ud24Dx9uYMwMn8o8G2cWPW/12200.json",
- "metadata": {
- "sip": 16,
- "name": "Satoshi's Team #12200",
- "description": "Heavy hitters, all-stars and legends of the game join forces to create a collection of unique varsity jackets",
- "image": "ipfs://ipfs/QmZMqhh2ztwuZ3Y8PyEp2z5auyH3TCm3nnr5ZfjjgDjd5q/12199.png",
- "attributes": [
- {
- "trait_type": "Background",
- "display_type": "string",
- "value": "value"
}
], - "properties": {
- "collection": "Foo Collection",
- "total_supply": "10000"
}, - "localization": {
- "default": "en",
- "locales": [
- "en",
- "jp"
]
}
}
}Semi-Fungible Token Metadata
Retrieves metadata for a SIP-013 Semi-Fungible Token
path Parameters
| principal required | string (Semi-Fungible Token Contract Principal) ^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[... Example: SP3K8BC0PPEVCV7NZ6QSRWPQ2JE9E5B6N3PA0KBR9.key-alex-autoalex-v1 SIP-013 compliant smart contract principal |
| token_id required | integer (Token ID) Example: 35 Token ID to retrieve |
query Parameters
| locale | string (Localization) Examples:
Metadata localization to retrieve |
Responses
Response samples
- 200
- 404
- 422
Content type
application/json
{- "token_uri": "ipfs://ipfs/Qmf9yDYuPTrp8NRUFf8xxDd5Ud24Dx9uYMwMn8o8G2cWPW/12200.json",
- "decimals": 6,
- "total_supply": "250",
- "metadata": {
- "sip": 16,
- "name": "Satoshi's Team #12200",
- "description": "Heavy hitters, all-stars and legends of the game join forces to create a collection of unique varsity jackets",
- "image": "ipfs://ipfs/QmZMqhh2ztwuZ3Y8PyEp2z5auyH3TCm3nnr5ZfjjgDjd5q/12199.png",
- "attributes": [
- {
- "trait_type": "Background",
- "display_type": "string",
- "value": "value"
}
], - "properties": {
- "collection": "Foo Collection",
- "total_supply": "10000"
}, - "localization": {
- "default": "en",
- "locales": [
- "en",
- "jp"
]
}
}
}Response samples
- 200
Content type
application/json
{- "server_version": "token-metadata-api v0.0.1 (master:a1b2c3)",
- "status": "ready",
- "tokens": {
- "ft": 512,
- "nft": 493452,
- "sft": 44
}, - "token_contracts": {
- "sip-009": 3101,
- "sip-010": 512,
- "sip-013": 11
}, - "job_queue": {
- "pending": 430562,
- "queued": 512,
- "done": 12532,
- "failed": 11
}
}