​

API 参考

本章节提供了AlphaFinance API的全面技术参考。API遵循RESTful设计原则，使用标准HTTP方法进行请求，并返回JSON格式的响应。

​

API基础

​

基本URL

所有API请求都使用以下基本URL：

https://api.alphafin.x-pai.com/v1

​

请求格式

API支持以下HTTP方法：

• GET：获取资源
• POST：创建资源
• PUT：更新资源
• DELETE：删除资源

​

身份验证

所有API请求都需要使用API密钥进行身份验证。您可以在请求头中包含您的API密钥：

curl -X GET "https://api.alphafin.x-pai.com/v1/stock/basic-info?symbol=600519" \
  -H "X-API-KEY: your_api_key_here"

详细的身份验证说明请参阅身份验证文档。

​

响应格式

所有API响应都以JSON格式返回，并包含以下标准字段：

{
  "code": 200,
  "message": "success",
  "data": {
    // 响应数据...
  }
}

• code：HTTP状态码，表示请求的结果
• message：对结果的简短描述
• data：包含请求的实际数据

对于出错的请求，响应包含错误详情：

{
  "code": 400,
  "message": "Bad Request: Missing required parameter 'symbol'",
  "error": "missing_parameter"
}

​

API类别

AlphaFinance API按功能分为以下主要类别：

​

股票信息

股票基本信息相关接口，包括股票搜索、基本信息、上市状态等。

​

行情数据

提供股票价格和交易相关的数据，包括日线数据、分钟线数据、实时行情等。

​

财务数据

提供公司财务报表相关数据，包括利润表、资产负债表、现金流量表等。

​

公司事件

提供公司公告、分红、IPO等事件数据。

​

行业数据

提供行业分类和行业表现相关数据。

​

指数数据

提供股票指数相关数据，包括指数列表、成分股、指数表现等。

​

通用参数

以下是适用于多个API端点的通用参数：

​

错误处理

API使用标准HTTP状态码指示请求的成功或失败：

详细的错误码列表请参阅错误码文档。

​

速率限制

为了保护服务质量，API实施了速率限制。具体限制取决于您的订阅计划。超出限制的请求将收到429状态码响应。

详细的速率限制信息请参阅速率限制文档。

​

版本控制

当前API版本为v1。我们会提前通知重大的API变更，并提供足够的时间进行迁移。

​

开始使用

选择一个API端点开始使用：

• 股票搜索
• 日线数据
• 利润表

或者查看快速入门指南，了解如何开始使用API。