> For the complete documentation index, see [llms.txt](https://docs.hyprearn.com/HnETD1HQdaN5QhTwmV4l/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyprearn.com/HnETD1HQdaN5QhTwmV4l/developers/api-authentication.md).

# API Authentication

#### Base URL

All API requests are made to the following base URL:

> <mark style="color:orange;">`https://api.hyprearn.com/v1`</mark>

#### **Authentication**

This endpoint supports **two authentication methods**:

<table data-header-hidden><thead><tr><th width="254.30078125"></th><th></th></tr></thead><tbody><tr><td><strong>Method</strong></td><td><strong>Description</strong></td></tr><tr><td><strong>API Key</strong></td><td>Provide your HyprEarn API key using the <mark style="color:orange;"><code>api_key</code></mark> parameter for authenticated access.</td></tr></tbody></table>

> **💡 Tips**
>
> * To get access to your API key, please reach out to the [**HyprEarn**](https://hyprearn.com/) team

#### Status Codes

| Code                    | Description                                                                          |
| ----------------------- | ------------------------------------------------------------------------------------ |
| 200 (Successful)        | Returned when the request is successful                                              |
| 400 (Bad Request)       | Invalid request and the server could not process the user's request                  |
| 401 (Unauthorized)      | Invalid API key for the requested resource by the user                               |
| 402 (Payment Required)  | Uses the [x402 protocol](https://x402.gitbook.io/x402) for on-chain payment required |
| 423 (Too many requests) | Likely indicating that the rate limit has reached                                    |

#### Rate Limit

* Default Rate Limit: 30 calls per minute.
* Can be configured based on subscription tier you chose