API 常見問答
“Passphrase”指的是什麼？
這是您申請 API key 時填寫的密碼。您需要自行記住它。一旦忘記，無法找回，您需要創建新的 API key。
我如何創建 API key？
在應用內：
1. 登錄您的 OKX 賬號 > 選擇 九宮格圖標 (⋮⋮⋮) > 向下滾動並選擇 API > 創建 API key
2. 填寫 API 名稱 > 選擇 賬戶 和 用途 > 輸入 IP 地址白名單 > 選擇 權限 > 輸入 助記詞
網頁版：
1. 登錄您的 OKX 賬號 > 進入您的 個人資料，選擇 API 和連接 > 創建 API key
2. 填寫 API key 名稱 > 選擇 賬戶 和 用途
3. 輸入 IP 地址白名單 > 選擇 權限 > 輸入 助記詞
注意：
IP 地址有助於保護您的 API key。每個 API key 最多可綁定 20 個地址，地址之間用逗號或空格分隔。
您需要查看 API 信息並訪問其接口。請妥善保管您的密碼。如果您丟失密碼，可以創建新的 API，因為我們無法恢復已創建的 API。
我如何管理或編輯 API key？
在 OKX 管理或編輯您的API key：
登錄您的 OKX 賬號，進入 個人資料 > API。
您將看到您現有的 API 密鑰列表。點擊您想要管理的那個。
您可以從這裡進行：
查看 API key 名稱、權限和關聯的 IP 白名單。
編輯密鑰名稱、權限（讀取、交易、提幣）或綁定的IP地址。
如果不再需要，請刪除該密鑰。
注意：創建後您無法查看助記詞。如果丟失，您需要刪除現有密鑰並重新創建。請務必妥善保管您的憑證。
如果我使用 API 進行交易，如何區分是現貨交易還是槓桿交易？
現貨和槓桿交易在 API 中的區分方式可能因您的賬戶類型和設置而異。我們建議您參考OKX API 文檔，以獲取適用於您賬戶設置的最準確和最新的參數。
如果您需要進一步的說明，請聯繫OKX 智能客服，獲取個性化指導。
我如何創建一個演示磁盤 API key？
要在模擬盤 API 上進行交易，您需要在模擬盤上創建一個 API key。請按照以下步驟操作：
登錄您的 OKX 賬號 > 交易 > 模擬交易 > 個人中心 > 創建模擬賬戶 API key > 開始模擬交易
API key 會過期嗎？
未綁定IP且具有交易或提幣權限的API密鑰，在14天無活動後將被自動刪除。如果API密鑰用於調用需要身份認證的私有或賬戶相關接口（如查看賬戶餘額、賬單數據或下單），則不會被視為無活動狀態。
只有綁定了 IP 或特定權限的只讀 API 密鑰才不會過期。
借幣、賺幣和劃轉權限是什麼？
劃轉： 允許密鑰在您的賬戶之間劃轉資金。適用於所有賬戶。
借幣： 允許該密鑰借幣、還幣及管理借幣。僅當您的賬戶具備相應功能資格時可見。
賺取： 允許該密鑰訂閱和贖回賺取產品。僅當您的賬戶具備所需功能資格時可見。
如果您的 API Key 之前已啟用交易權限，則在此次更新後，所有三項權限將自動激活，無需手動設置。
通過界面下單時，可以以貨幣單位下單嗎？
不；對於合約委託，界面默認以合約數量為單位。如果您需要計算合約數量與代幣之間的轉換，可以參考合約與代幣轉換接口，詳情見這裡。
如何獲取界面的波動率？
界面無法直接獲取價格漲跌，但可以通過計算公式計算得出。
最新交易價格相較於24小時前K線開盤價的漲跌幅度，除以24小時前K線開盤價的100%。
上述期貨數據可通過市場接口此處獲取。
下單時出現“51000 Parameter posSide error”錯誤提示的原因是什麼？
您需要先檢查賬戶模式；買賣模式/開倉和平倉模式，可在此處查看以獲取 posMode。
注意：
在使用合約開倉和平倉以及下單時，必須填寫 posSide 參數，且填寫做多或做空。
如果是買賣模式，或者在開倉和平倉模式下進行數字貨幣或槓桿交易，posSide 僅支持淨額或不傳輸。
哪個接口可以用來獲取合約面值和最小委託數量？
您可以使用該界面獲取交易產品的基本信息，詳情請見這裡。
合約面值：ctVal，最小委託數量：minSz。
instId 的格式是什麼？
您可以直接使用界面在此處獲取交易產品的基本信息。
如何設置止損和止盈？
如果訂單附加了止盈止損，您可以參考訂單界面 這裡：attachAlgoOrds 數組參數。
但是，如果是單獨的委託止損，您可以參考策略返佣界面，詳情請見這裡。
為什麼設置止盈和止損的觸發價格時會報錯：51046、51047、51048、51049？
設置止損觸發價格/止盈觸發價格的規則——在賣出時，止盈觸發價格高於最新交易價格，止損觸發價格低於最新交易價格；在買入時，止盈觸發價格低於最新交易價格，止損觸發價格高於最新交易價格。
“接口錯誤：50102 時間戳請求已過期”是什麼意思？
此錯誤發生在時間戳已過期時。您需要調用系統時間接口，將本地時間與我們服務器的時間同步。保持時間差在30秒以內有助於避免此問題。
注意：請求頭中的時間為 UTC0。調用服務器時間接口時，時間以 UTC+8 提供。
“接口錯誤：50101 APIKey 與當前環境不匹配”是什麼意思？
這是由於 API key 與當前環境不匹配所致。真實賬戶調用需要使用真實賬戶的 API key，且請求頭中的 x-simulated-trading 參數值需為 0。模擬賬戶調用需要使用模擬賬戶的 API key，且請求頭中的 x-simulated-trading 參數值需為 1。
“接口錯誤：51010 當前賬戶模式下請求不支持”是什麼意思？
這與您的賬戶模式有關。如果您想使用單一貨幣槓桿或合約，您需要調整為除現貨模式外的其他三種模式！您可以通過界面設置這裡進行設置，或者在網頁版或APP上進行設置。
注意：第一個設置必須在交易頁面主菜單的設置選項中進行；賬戶模式。
“界面錯誤：51121 委託數量必須是批量大小的整數倍”是什麼意思？
在 API 中，合約訂單以張為單位，且必須是幣對最小委託數量的整數倍。最小委託數量可通過產品接口的 minSz 字段獲取，詳情見這裡。
“提幣錯誤：58207 提幣地址未在認證豁免白名單中”；為什麼在提幣頁面關閉白名單認證後，仍然報告錯誤？
要通過 API 接口提幣，需在頁面添加提幣地址並勾選“非 Visa 認證”按鈕。頁面上的白名單認證是否開啟不會影響接口功能。
“接口錯誤：50004 API端口請求超時”是什麼意思（這不表示請求成功或失敗，請檢查請求結果）？
50004 錯誤通常是由於服務器壓力過大引起的。每天的 8 點、16 點和 24 點是收取資金費用的時間點，此時服務器壓力較大。建議避開這些時間段進行交易。如果在其他時間出現 50004 錯誤，可以稍後重試。如果下單時出現 50004 錯誤，這並不代表接口請求的實際結果，請求可能成功也可能失敗。請以實際結果為準。
“50119 API key 不存在”錯誤是什麼意思？
此錯誤通常發生在您的賬戶域與您的地區不匹配時。
對於 EEA 用戶，請將您的 API 請求域名更改為 eea.okx.com，而非 www.okx.com。
對於 美國用戶，請將您的 API 請求域名更改為 us.okx.com，而非 www.okx.com。
如果您使用第三方軟件連接 OKX 並看到此錯誤，請與軟件提供商確認其是否支持區域域名。例如，歐洲經濟區（EEA）用戶必須通過 eea.okx.com 連接，否則請求將失敗。
為什麼綁定第三方軟件時會顯示錯誤“50110”？
如果當前的API key類型與第三方軟件綁定不兼容，可能會出現此錯誤。請嘗試申請API key的交易類型，且不綁定IP列表，然後重新連接第三方軟件。
我如何獲取某個幣對的最新交易價格？
有關幣種信息，請使用此處，有關單個幣種信息，請使用此處。幣種接口用於批量獲取幣對的最新交易價格，ticker接口用於獲取單個幣對的最新交易價格。
幣種部分中最新成交價響應參數示例
創建 API key 的要求是什麼？
創建 API key 需要最低 100 USD 的資產管理餘額（AUM）。
創建 API key 需要資產管理規模（AUM）大於 100 USD（AUM > 100U）。
對於主賬戶或子賬戶，只有資產管理規模（AUM）大於100U的賬戶才允許創建API密鑰
注意： 此要求僅適用於特定地區的用戶
如果 WebSocket 無法連接或頻繁斷開，我該怎麼辦？
請確認您正在使用正確的 WebSocket URL 連接您的網站和 API 服務。檢查您的網絡、代理、TLS 設置、訂閱參數、Ping/Pong 心跳以及重連邏輯。如果問題仍然存在，請提供頻道、發生時間、完整錯誤信息和已脫敏的日誌。
我應該如何排查 API 錯誤代碼或無效請求參數？
在您網站的官方 API 文檔中查找錯誤代碼，然後認證端口、HTTP 方法、請求參數、賬戶模式和產品限制。如果原因仍不明確，請提供完整的錯誤代碼、sCode/sMsg、發生時間以及已脫敏的請求和響應。
為什麼我的 API 委託下單、修改或取消失敗？
請使用 API 返回的錯誤消息和錯誤代碼來確定具體原因。如果您不確定錯誤的含義，請提供完整的請求參數和錯誤詳情，以便我們進一步調查。
如果市場數據、K線圖或訂單表數據看起來不正確，我應該怎麼辦？
確認頻道名稱、instId、訂閱參數和請求頻率，並區分快照數據與增量更新。對於訂單表，還需驗證序列ID和時間戳。如果數據似乎缺失，請記錄頻道、時間範圍和已脫敏的原始響應。
為什麼API中的餘額、倉位或保證金數值與網站或應用程序顯示的不同？
首先區分交易賬戶和資金賬戶，然後認證賬戶模式、貨幣維度、端口和數據更新時間。對於餘額、倉位和保證金的計算，請使用適用於該站點的最新產品和API文檔。
如果API充入、提幣或劃轉失敗，我該怎麼辦？
檢查 API 權限、貨幣、網絡、目標賬戶以及任何地址簿或白名單要求，然後根據返回的錯誤代碼進行故障排除。賬戶安全、合規或風險限制可能需要相關站點的客服進一步審核。
如何為子賬戶創建和使用 API key？
在目標子賬戶下創建 API key，並使用該子賬戶的權限、密碼短語和站點域名。請勿混用主賬戶和子賬戶的 API Key、Secret 或密碼短語。
觸發 API 速率限制後我應該怎麼辦？
根據特定端口的限制減少請求速率，並在適當情況下使用請求排隊、指數退避或批量端口。速率限制的範圍和配額可能因端口而異，因此不要假設所有端口共享相同的配額。
我在哪裡可以找到 API 文檔、SDK 和代碼示例？
API 文檔（V5）— www.okx.com/docs-v5/en。REST + WebSocket 參考，更新日誌，錯誤代碼，每個端口的請求/響應示例。官方 SDK（GitHub）— github.com/okxapi 代碼示例可在 SDK 中找到。
如果我只能說“API無法使用”，我應該提供哪些信息？
請提供端口、HTTP 方法、預期操作、完整的錯誤代碼或消息、發生時間、賬戶站點、網絡環境，以及已脫敏的請求和響應。切勿發送 API Secret、Passphrase、認證碼或未脫敏的簽名。
注意：
如果您對 WebSocket 或其他 API 相關主題有疑問，請點擊文章鏈接，並使用 OKX App 掃描文章底部的二維碼，加入群組，與我們的 API 支持專家聯繫。
如何掃描：在應用中，點擊九宮格圖標 > 掃描圖標，然後掃描二維碼。