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

# Overview

Airaa's API provides programmatic access to creator intelligence, campaign leaderboards, and platform analytics. It is designed for brands, agencies, and analytics teams building on top of Airaa's data.

## Available data

| Resource                                       | What it provides                                                    |
| ---------------------------------------------- | ------------------------------------------------------------------- |
| [Contributors](/api-reference/contributors.md) | Creator profiles, engagement metrics, mention history, top rankings |
| [Projects](/api-reference/projects.md)         | Project intelligence profiles, sentiment, community metrics         |
| [Narratives](/api-reference/narratives.md)     | Trending narratives with historical momentum                        |
| [Leaderboards](/api-reference/leaderboards.md) | Custom leaderboards with weighted scoring                           |
| Discovery                                      | Search and filter creators by ecosystem, category, and platform     |

## Access

The API is not publicly available. To request credentials, contact the Airaa team on [Telegram](https://t.me/airaaHQ) or email <api@airaa.xyz>.

API keys are issued per organization. Include your key in all requests as a header:

```
Authorization: Bearer YOUR_API_KEY
```

## Base URL

```
https://api.airaa.xyz/v1
```

## Response format

All responses are JSON. Successful responses return a `data` object. Errors return an `error` object with a `code` and `message`.

```json
{
  "data": { ... }
}
```

```json
{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}
```

## Rate limits

Rate limits are enforced per API key. Contact the Airaa team for your specific limits. Exceeding your limit returns a `429 Too Many Requests` response with a `Retry-After` header.

***

* [Authentication →](/api-reference/authentication.md)
* [Contributors →](/api-reference/contributors.md)
* [Leaderboards →](/api-reference/leaderboards.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.airaa.xyz/api-reference/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.