跳轉到內容

造市商 (Maker) API 接口

接口介紹

造市商 API 接口面向認證的機構客戶(Web3 用戶)提供,支持創建訂單、管理持倉、查詢訂單狀態等功能,通過 JWT 認證接入平台進行掛單交易。

快速開始

基礎信息

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

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

測試指南:如果使用測試環境,請參閱測試指南了解訂單數量規則和測試場景。

統一響應格式

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

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

成功響應示例

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

接口概覽

賬戶接口

  • 賬戶連接 - 進行錢包連接,獲取 JWT 令牌
  • 個人資料 - 獲取賬戶資料信息

訂單接口

  • 創建訂單 - 創建新的買入或賣出訂單
  • 取消訂單 - 取消未成交的訂單
  • 查詢訂單 - 查詢訂單列表,支持多種過濾條件
  • 查詢 Nonce - 獲取下一個可用的訂單 nonce 值
  • 預估手續費 - 預估訂單的手續費
  • 查詢持倉 - 查詢持有的股票 token 信息

WebSocket

  • 實時推送 - 訂閱訂單狀態變更的實時通知

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


枚舉類型說明

OrderStatus - 訂單狀態

枚舉項說明是否終態描述
pending待處理訂單已創建,等待 Taker 鎖定。例如等待美股開市時也會處於此狀態
locked已鎖定訂單被 Taker 鎖定,可能正在交易中
partially_filled部分成交訂單部分成交,剩餘部分已退還。通常是用戶在成交過程中發起撤單請求,最終有部分成交
filled完全成交訂單完全成交
cancelled已取消訂單被 Maker 取消
expired已過期訂單超過有效期
rejected已拒絕訂單驗證失敗或被 Taker 拒絕,一般會提供拒絕原因
suspended已暫停訂單被掛起,需人工介入處理

終態說明:標記為終態(是)的狀態無法再轉換到其他狀態。

Exchange - 交易所代碼

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

Market - 市場代碼

枚舉項說明
usex美股市場

MakerStatus - 用戶狀態

下標說明
1啟用
2禁用
3掛起

注意事項

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