> ## Documentation Index
> Fetch the complete documentation index at: https://www.helius.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Admin API

> Programmatic access to project usage and billing data via API key authentication.

The Admin API provides programmatic access to your project's credit usage, subscription details, and per-service request counts. Use it to build internal dashboards, automate usage alerts, or pipe Helius billing data into your own systems, all authenticated with your standard Helius API key.

**Base URL**: `https://admin-api.helius.xyz`

## Quick Example

Retrieve the current billing cycle's usage for a project:

<CodeGroup>
  ```bash cURL theme={"system"}
  curl "https://admin-api.helius.xyz/v0/admin/projects/YOUR_PROJECT_ID/usage" \
    -H "X-Api-Key: YOUR_API_KEY"
  ```

  ```javascript JavaScript theme={"system"}
  const response = await fetch(
    `https://admin-api.helius.xyz/v0/admin/projects/${PROJECT_ID}/usage`,
    { headers: { "X-Api-Key": API_KEY } }
  );
  const usage = await response.json();
  ```

  ```python Python theme={"system"}
  import requests

  response = requests.get(
      f"https://admin-api.helius.xyz/v0/admin/projects/{PROJECT_ID}/usage",
      headers={"X-Api-Key": API_KEY},
  )
  usage = response.json()
  ```
</CodeGroup>

### Sample Response

```json theme={"system"}
{
  "creditsRemaining": 487500,
  "creditsUsed": 12500,
  "prepaidCreditsRemaining": 50000,
  "prepaidCreditsUsed": 0,
  "subscriptionDetails": {
    "billingCycle": {
      "start": "2026-04-01",
      "end": "2026-05-01"
    },
    "creditsLimit": 500000,
    "plan": "business"
  },
  "usage": {
    "api": 1200,
    "archival": 0,
    "das": 5000,
    "grpc": 300,
    "grpcGeyser": 0,
    "photon": 0,
    "rpc": 4500,
    "stream": 100,
    "webhook": 800,
    "websocket": 600
  }
}
```

## Authentication

Pass your Helius API key either as a header (recommended) or a query parameter:

* **Header**: `X-Api-Key: YOUR_API_KEY`
* **Query parameter**: `?api-key=YOUR_API_KEY`

<Note>
  The API key must belong to the project you're querying. Requests where the API key's project does not match the project ID in the path will return a `400` error.
</Note>

## Rate Limits

The Admin API is rate-limited to **5 requests per second** per project.

## Endpoints

<CardGroup cols={2}>
  <Card title="Get Project Usage" href="/api-reference/admin/get-project-usage">
    Retrieve credit usage, subscription details, and per-service request counts for the current billing cycle.
  </Card>
</CardGroup>