Basic usage

Learn the basics of using the Token Metadata API.

Usage

The Token Metadata API is built on REST principles, enforcing HTTPS for all requests to ensure data security, integrity, and privacy.

Base URL

https://api.hiro.so

Making requests

To make a request to the Token Metadata API, you can paste the curl command below in your terminal.

Terminal
$
curl -L 'https://api.hiro.so/metadata/v1/ft' \
-H 'Accept: application/json'

Authentication

If you are using an api-key, replace $HIRO_API_KEY with your secret API key.

Terminal
$
curl -L 'https://api.hiro.so/metadata/v1/ft' \
-H 'Accept: application/json' \
-H 'X-API-Key: $HIRO_API_KEY'

Response codes

The Token Metadata API uses standard HTTP response codes to indicate request success or failure.

CodeDescription
200Successful request
400Check that the parameters were correct
401Missing API key
403Invalid API key
404Resource not found
429Rate limit exceeded
5xxServer errors