API 参考
本章节提供了AlphaFinance API的全面技术参考。API遵循RESTful设计原则,使用标准HTTP方法进行请求,并返回JSON格式的响应。API基础
基本URL
所有API请求都使用以下基本URL:请求格式
API支持以下HTTP方法:- GET:获取资源
- POST:创建资源
- PUT:更新资源
- DELETE:删除资源
身份验证
所有API请求都需要使用API密钥进行身份验证。您可以在请求头中包含您的API密钥:响应格式
所有API响应都以JSON格式返回,并包含以下标准字段:code:HTTP状态码,表示请求的结果message:对结果的简短描述data:包含请求的实际数据
API类别
AlphaFinance API按功能分为以下主要类别:股票信息
股票基本信息相关接口,包括股票搜索、基本信息、上市状态等。行情数据
提供股票价格和交易相关的数据,包括日线数据、分钟线数据、实时行情等。日线数据
获取股票的日K线数据,包括开盘价、收盘价、最高价、最低价、交易量等。
分钟线数据
获取股票的分钟K线数据,支持1分钟、5分钟、15分钟等多种时间周期。
实时行情
获取股票的实时行情数据,包括最新价、涨跌幅、成交量等。
财务数据
提供公司财务报表相关数据,包括利润表、资产负债表、现金流量表等。利润表
获取公司的利润表数据,包括营业收入、营业利润、净利润等。
资产负债表
获取公司的资产负债表数据,包括总资产、总负债、股东权益等。
现金流量表
获取公司的现金流量表数据,包括经营活动、投资活动、筹资活动现金流等。
公司事件
提供公司公告、分红、IPO等事件数据。行业数据
提供行业分类和行业表现相关数据。指数数据
提供股票指数相关数据,包括指数列表、成分股、指数表现等。通用参数
以下是适用于多个API端点的通用参数:| 参数名 | 类型 | 描述 |
|---|---|---|
fields | 字符串 | 指定返回的字段,用逗号分隔 |
symbol | 字符串 | 股票代码或指数代码 |
begin_date | 字符串 | 起始日期,格式为YYYY-MM-DD |
end_date | 字符串 | 结束日期,格式为YYYY-MM-DD |
limit | 整数 | 返回结果的最大数量 |
page | 整数 | 分页参数,指定要返回的页码 |
错误处理
API使用标准HTTP状态码指示请求的成功或失败:| 状态码 | 描述 |
|---|---|
| 200 | 成功 |
| 400 | 错误的请求,可能是缺少必需参数或参数格式不正确 |
| 401 | 未授权,API密钥无效 |
| 403 | 禁止访问,没有足够的权限 |
| 404 | 未找到请求的资源 |
| 429 | 请求过多,超出速率限制 |
| 500 | 服务器内部错误 |
速率限制
为了保护服务质量,API实施了速率限制。具体限制取决于您的订阅计划。超出限制的请求将收到429状态码响应。 详细的速率限制信息请参阅速率限制文档。版本控制
当前API版本为v1。我们会提前通知重大的API变更,并提供足够的时间进行迁移。