Skip to main content

API Keys

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

What Is an API Key?​

API keys are alpha-numeric codes that identify and authenticate an application or developer. You can use API keys to control access to your API calls.

How to Get an API Key?​

If you're interested in obtaining an API key, you can generate a free key in the Hiro Platform.

Steps to Use an API Key​

Follow these steps to interact with the API using your API key:

caution

The API key is passed in the header of your HTTP API request and is used only for private use, like in server-side applications. This key is not to be exposed or shared; if you use the API key in your client-side application (E.g., frontend, browser-based applications), attackers can capture it using the client tools (E.g., browser console) and abuse your API key.

There are multiple ways to interact with API endpoints. In this guide, we will walk through the following approaches with the help of an API endpoint.

  • cURL
  • Typescript client

Using cURL​

Using cURL, you will pass the API key in an x-hiro-api-key header. Use the following command as an example to call the API endpoint https://api.hiro.so/<your-api-endpoint>.

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

Using the API Key in Typescript​

The following Typescript snippet demonstrates the instantiation of RESTful HTTP requests with an API key.

function <your-api-function>(apiKey: string) {
  const url = `https://api.hiro.so/<your-api-endpoint>`;
  const headers = new Headers();
  headers.append("x-hiro-api-key", ${apiKey});

  return fetch(url, {
    headers: headers
  })
    .then(response => response.json());
}