跳轉到內容

公共 API 接口

接口介紹

公共 API 接口面向所有用戶開放,無需認證即可訪問。這些接口提供平台的統計數據、訂單簿信息和股票標的統計,為所有用戶提供透明的市場數據訪問。

快速開始

基礎信息

  • 測試環境: https://api-qa.proto.stove.finance
  • 生產環境: https://proto.stove.finance
  • Content-Type: application/json
  • 數據格式: JSON (snake_case 命名風格)

說明:接口示例中顯示相對路徑(如 /api/v1/orders),實際請求時請在路徑前添加環境地址。

統一響應格式

所有接口都遵循統一的響應結構:

字段類型說明
codeint結果碼,0 表示成功,非 0 表示錯誤
messagestring錯誤消息,簡短描述(僅在出錯時返回)
detailsstring額外錯誤信息(僅在出錯時返回)
dataobject業務數據(僅在成功時返回)

成功響應示例

json
{
	"code": 0,
	"data": {
		// 具體業務數據
	}
}

錯誤響應示例

json
{
	"code": 400001,
	"message": "Invalid parameter",
	"details": "The wallet_address field is required"
}

接口概覽

公共 API 提供以下主要功能:

  • 平台統計 - 查詢平台的用戶數、訂單數和股票 Token 數量
  • 訂單簿 - 查詢指定股票的買賣盤信息
  • 標的統計 - 查詢股票的基本信息和交易統計

請點擊左側導航欄查看各個接口的詳細文檔。


枚舉類型說明

Exchange - 交易所代碼

下標說明
0納斯達克(美股交易所)

Market - 市場代碼

枚舉項說明
usex美股市場

注意事項

  • 數據格式: 所有接口使用 snake_case 命名風格
  • 金額精度: 金額字段使用字符串類型,避免精度損失
  • 地址格式: 以太坊地址必須包含 0x 前綴
  • 時間格式: 如無特別說明,時間格式默認使用ISO 8601 標準格式,如2025-11-17T03:00:24Z