驗證
驗證
產生 API 金鑰
API KEY PERMISSIONS
建立請求
| Header | Required | Description |
|---|---|---|
| KC-API-KEY | Yes | 您的 API Key（字串）。 |
| KC-API-SIGN | Yes | 請求所產生的 Base64 編碼簽名。 |
| KC-API-TIMESTAMP | Yes | 請求時間戳（毫秒）。 |
| KC-API-PASSPHRASE | Yes | 建立 API Key 時設定的 Passphrase。 |
| KC-API-KEY-VERSION | Yes | API Key 版本，可於 API Management 頁面查看。 |
| Content-Type | Yes | 所有請求與回應皆使用 application/json 內容類型。 |
| X-SITE-TYPE | No | 用於公開接口以指定站點/區域。若未填，預設為 global。澳大利亞站客戶需填 australia，以確保查詢結果為澳大利亞站資料。對於 WebSocket，取得 token 的步驟在需要區分站點時也需在請求頭加入此資訊。 |
簽署訊息
例如：當 url 為 /api/v1/sub/api-key?apiKey=67b3&subName=test&passphrase=abc%21%40%2311
, 參與簽名的 URL 內容應該是原始資訊 /api/v1/sub/api-key?apiKey=67b3&subName=test&passphrase=abc!@#11
代碼範例
閘道時間戳
| 邊界 | 含義 | WebSocket 回參（Body） | REST 回參（Header） |
|---|---|---|---|
| 入站 | 請求到達 Gateway | inTime | x-in-time |
| 出站 | 回應從 Gateway 發出 | outTime | x-out-time |
說明
outTime - inTime（WebSocket）或 x-out-time - x-in-time（REST）計算。單位取決於目前啟用的精度。精度控制
| 協議 | 控制參數 | 參數位置 | 影響的回參位置 | 影響的欄位 | 預設單位 |
|---|---|---|---|---|---|
| REST | kc-enable-ns | Request Header | Response Header | x-in-time, x-out-time | 微秒（µs） |
| WebSocket | enable_ns | WSS Query Parameter | Response Body | inTime, outTime | 毫秒（ms） |
備註
1.
x-in-time 與 x-out-time 會在 Response Header 中返回，且任意 REST API 的回應皆可能包含這兩個欄位。5- 前綴僅用於表示該組時間戳由 Gateway 產生。目前僅提供 Gateway 側的入站與出站時間戳。2.
inTime 與 outTime 位於 Response Body，Pro WebSocket 的請求-回應類 API（例如下單/撤單）皆可能返回。3.
inTime 與 outTime 預設即以奈秒返回，因此不需要設定 enable_ns=true。啟用納秒
RESTful API
kc-enable-ns: true，即可讓 x-in-time 與 x-out-time 以奈秒返回。WebSocket 下單/撤單 API
enable_ns=true，即可讓 inTime 與 outTime 以奈秒返回。wss://wsapi.kucoin.com/v1/private?apikey=689***2b6×tamp=1768878266952&sign=H/G***%3D&passphrase=aLs***3D&enable_ns=true{
"code": "200000",
"data": {
"clientOid": "32dd404b1d724df59ee6f2bd8e8909f60522e89f",
"orderId": "403363205159706624",
"tradeType": "FUTURES",
"ts": 1768982484257000000
},
"id": "1b7ac024f4ee42e48d41104c10a21732",
"inTime": 1768982484219053000,
"op": "uta.order",
"outTime": 1768982484257824000,
"userRateLimit": {
"limit": 2000,
"remaining": 1999,
"reset": 30000
}
}Modified at 2026-01-29 03:33:33