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

# REST API 说明

> AlphaFeed RESTful API 使用指南

## Base URL

```
https://api.alphafeed.org
```

## 认证

所有请求需要在 Header 中携带 API Key：

```bash theme={null}
curl https://api.alphafeed.org/v1/quotes \
  -H "X-API-Key: your-api-key" \
  -G -d "symbols=600519.SH"
```

也支持通过 URL 参数传递（适合浏览器调试）：

```
https://api.alphafeed.org/v1/quotes?symbols=600519.SH&api_key=your-api-key
```

## 响应格式

成功时返回 `{"data": ...}` 结构，错误时返回：

```json theme={null}
{"code": 403, "message": "错误描述"}
```

| code | 说明               |
| ---- | ---------------- |
| 401  | API Key 无效或缺失    |
| 403  | 无权限（套餐不包含该功能或市场） |
| 429  | 请求频率超限           |

## 标的代码格式

统一使用 `{代码}.{交易所后缀}` 格式：

| 后缀    | 交易所     | 示例                |
| ----- | ------- | ----------------- |
| `.SH` | 上海证券交易所 | `600519.SH`（贵州茅台） |
| `.SZ` | 深圳证券交易所 | `000001.SZ`（平安银行） |
| `.BJ` | 北京证券交易所 | `430047.BJ`       |
| `.US` | 美股      | `AAPL.US`（苹果）     |
| `.HK` | 港股      | `00700.HK`（腾讯）    |

## 在线调试

在接下来的各接口页面中，你可以：

* 直接查看每个接口的**请求参数**和**响应格式**
* 点击右上角 **"试一试"** 按钮，在浏览器中在线调试接口
* 填入你的 API Key 和参数后即可实时查看返回结果

<Note>
  在线调试使用的是真实 API，请确保使用有效的 API Key。
</Note>