> ## 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

> 通过API密钥认证，程序化访问项目使用情况和计费数据。

Admin API提供对项目信用使用情况、订阅详情和每个服务请求计数的程序化访问。使用它可以构建内部仪表板、自动化使用警报或将Helius计费数据导入您自己的系统，所有这些都使用标准的Helius API密钥进行认证。

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

## 快速示例

检索项目当前计费周期的使用情况：

<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>

### 示例响应

```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
  }
}
```

## 认证

将您的Helius API密钥作为头部（推荐）或查询参数传递：

* **头部**: `X-Api-Key: YOUR_API_KEY`
* **查询参数**: `?api-key=YOUR_API_KEY`

<Note>
  API密钥必须属于您查询的项目。API密钥的项目与路径中的项目ID不匹配的请求将返回`400`错误。
</Note>

## 速率限制

Admin API的速率限制为每个项目每秒**5个请求**。

## 端点

<CardGroup cols={2}>
  <Card title="获取项目使用情况" href="/zh/api-reference/admin/get-project-usage">
    检索当前计费周期的信用使用情况、订阅详情和每个服务请求计数。
  </Card>
</CardGroup>