Stacks Token Metadata Service (0.0.1)

Download OpenAPI specification:Download

A microservice that indexes metadata for every SIP-009, SIP-010, and SIP-013 Token in the Stacks blockchain and exposes it via REST API endpoints.

Source Repository

Tokens

Token metadata endpoints

Fungible Token Metadata

Retrieves metadata for a SIP-010 Fungible Token

path Parameters

principal

required

string[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a...

Example: SP32XCD69XPS3GKDEXAQ29PJRDSD5AR643GNEEBXZ.fari-token

Principal for the contract which owns the SIP-010 token

query Parameters

locale

string

Examples:

locale=es-MX -
locale=jp -

Metadata localization to retrieve

Responses

Response samples

200
404
422

Content type

application/json

{"name": "string",
"symbol": "string",
"decimals": 0,
"total_supply": "string",
"token_uri": "http://example.com",
"metadata": {"sip": 0,
"name": "string",
"description": "string",
"image": "http://example.com",
"attributes": [{"trait_type": "string",
"value": null,
"display_type": "string"
}
],
"properties": {"property1": null,
"property2": null
},
"localization": {"uri": "http://example.com",
"default": "string",
"locales": ["string"
]
}
}
}

Non-Fungible Token Metadata

Retrieves metadata for a SIP-009 Non-Fungible Token

path Parameters

principal required	string[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{28,41}\.[a... Example: SP497E7RX3233ATBS2AB9G4WTHB63X5PBSP5VGAQ.boomboxes-cycle-12 SIP-009 compliant smart contract principal
token_id required	integer Example: 35 Token ID to retrieve

query Parameters

locale

string

Examples:

locale=es-MX -
locale=jp -

Metadata localization to retrieve

Responses

Response samples

200
404
422

Content type

application/json

{"token_uri": "http://example.com",
"metadata": {"sip": 0,
"name": "string",
"description": "string",
"image": "http://example.com",
"attributes": [{"trait_type": "string",
"value": null,
"display_type": "string"
}
],
"properties": {"property1": null,
"property2": null
},
"localization": {"uri": "http://example.com",
"default": "string",
"locales": ["string"
]
}
}
}

Status

Service status endpoints

Service Status

Displays the status of the Token Metadata Service and its current workload

Responses

Response samples

200

Content type

application/json

{"status": "string",
"tokens": {"property1": 0,
"property2": 0
},
"token_contracts": {"property1": 0,
"property2": 0
},
"job_queue": {"property1": 0,
"property2": 0
}
}