Basic usage

Usage

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

https://api.platform.hiro.so

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

Terminal

$ curl -L 'https://api.platform.hiro.so/v1/ext/{apiKey}/chainhooks' \
  -H 'Accept: application/json'

The Platform API uses path-based authentication. Replace {apiKey} in the URL path with your Platform API key.

Terminal

$ curl -L 'https://api.platform.hiro.so/v1/ext/{apiKey}/chainhooks' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json'

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

Code	Description
`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