API keys

Developers have open access to Hiro's APIs without the use of an API key, but are subject to Hiro's rate limit policy. For developers who need access beyond these rate limits, we provide API keys.

Manage your keys

In the Hiro Platform, you can create, copy, and revoke API keys.

1. 1Sign in or create an account.
2. 2Select Create key, enter a name and an optional description, then create the key.
3. 3Copy the key into your application's server-side configuration. You can reveal or copy it again later.

To stop using a key, select Revoke. Revoking a key permanently deletes it, so update any applications that use it first.

Usage with cURL

The API key is passed in the header of your HTTP API request with x-api-key.

$ 
curl https://api.hiro.so/... -H 'x-api-key: <your-api-key>'Copy

Usage with Node

This snippet shows how to perform a fetch request with your API key by including it in the request headers.

async function makeApiRequest(apiKey: string) {
  const url = `https://api.hiro.so/<your-api-endpoint>`;
  const response = await fetch(url, {
    headers: {
      "x-api-key": apiKey
    }
  });
  return response.json();
}