Usage

Base URL

The Stacks API is built on REST principles, enforcing HTTPS for all requests to ensure data security, integrity, and privacy. The base URL for all API requests is:

https://api.mainnet.hiro.so

Making requests

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

curl -L 'https://api.hiro.so/extended' \
-H 'Accept: application/json'

Authentication

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

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

Response codes

The Stacks API uses standard HTTP response codes to indicate the success or failure of an API request:

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

Rate limits