快速入門
接入準備
如需使用 API ，請先登入網頁端，完成 API key 的申請與權限配置，再據此文件詳情進行開發與交易。
您可以點選 這裡 建立 API Key。
每個使用者可建立 10 組 Api Key，每個 Api Key 可對應設定讀取、交易兩種權限。
權限說明如下：
- 讀取權限：讀取權限用於資料的查詢，例如：行情資料。
- 交易權限：交易權限用於下訂單、撤單等接口。
創建成功後請務必記住以下資訊：
APIKey API交易的身份標識，隨機演算法產生。Secretkey私鑰，由系統隨機生成，用於簽署的生成。Passphrase口令，由使用者自己設定，需要注意的是，Passphrase 忘記之後是無法找回的，需要重新建立 APIKey。
💡 提示
建立 APIKey 時可以綁定 IP 位址，未綁定 IP 位址的 APIKey 出於安全考慮，強烈建議您綁定 IP 位址。
⚠️ 注意
風險提示 ：這三個金鑰與帳號安全密切相關，請牢記 Passphrase，無論何時都請勿向他人透露。 這三個密鑰任一洩漏可能會造成您的資產損失，若發現 APIKey 洩漏請盡快刪除該 APIKey。
接口類型
本章節主要為接口類型分以下兩個面向：
- 公共接口
- 私有接口
公共接口
公共接口可用於取得設定資訊和行情資料。公共請求無需認證即可呼叫。
私有接口
私有接口可用於訂單管理和帳戶管理。每個私有請求必須使用規範的驗證形式進行簽署。
私有接口需要使用您的 APIKey 進行驗證。
訪問限制
本章節主要為存取限制：
- Rest API 當存取超過頻率限制時，將傳回 429 狀態：請求太頻繁。
Rest API
如果傳入有效的 APIKey 用 APIKey 限速；如果沒有則拿公網 IP 限速。
限速規則：各個接口上有單獨的說明，如果沒有一般接口限速為 10 次/秒。
特殊說明：批量下單時，若下 4 個幣對，每個幣對 10 個訂單時，計為一次請求。
API 公開參數
side (交易方向)
| 欄位 | 說明 |
|---|---|
sell | 賣 |
buy | 買 |
orderType (訂單類型)
| 欄位 | 說明 |
|---|---|
limit | 限價 |
market | 市價 |
orderType (訂單類型)
| 欄位 | 說明 |
|---|---|
normal | 不用特殊控制類型訂單 |
postOnly | postOnly 類型訂單 |
fok | 全部成交或立即取消（FOK） |
ioc | 立即成交並取消剩餘（IOC） |
status (訂單狀態)
| 欄位 | 說明 |
|---|---|
new | 未成交 |
partial_fill | 部分成交 |
full_fill | 全部成交 |
cancelled | 已撤銷 |
groupType (帳單流水大類型)
| 欄位 | 說明 |
|---|---|
deposit | 儲值 |
withdraw | 提取 |
transaction | 交易 |
transfer | 劃轉 |
other | 其他 |
bizType (帳單流水業務類型)
| 欄位 | 說明 |
|---|---|
deposit | 儲值 |
withdraw | 提取 |
buy | 買 |
sell | 賣 |
transfer-in | 轉入 |
transfer-out | 轉出 |
status (充提訂單狀態)
| 欄位 | 說明 |
|---|---|
cancel | 取消 |
reject | 拒絕 |
success | 成功 |
wallet-fail | 錢包失敗 |
wallet-processing | 錢包處理中 |
first-audit | 初審 |
recheck | 複審 |
first-reject | 初審拒絕 |
recheck-reject | 複審拒絕 |
type (用戶提幣地址查詢)
| 欄位 | 說明 |
|---|---|
chain-on | 鏈上 |
inner-transfer | 內部地址 |
accountType (帳戶類型)
不區分大小寫
| 欄位 | 說明 |
|---|---|
EXCHANGE | 現貨賬戶 |
OTC_SGD | OTC 賬戶 |
CONTRACT | 合約賬戶 |
USD_MIX | 混合合約賬戶 |
USDT_MIX | USDT 專業合約賬戶 |
K 線間隔 (granularity)
- 1min (1 分鐘)
- 5min (5 分鐘)
- 15min (15 分鐘)
- 30min (30 分鐘)
- 1h (1 小時)
- 4h (4 小時)
- 12h (12 小時)
- 1day (1 天)
- 1week (1 週)
WEEX唯客官網：www.weex.com
你也可以在 CMC｜ Coingecko｜非小號｜X(Twitter)｜Youtube｜Facebook｜Linkedin｜微博 上關注我们，第一时间获取更多投資導航和福利活動！了解平台幣 WXT 最新資訊請訪問 WXT專區
在線諮詢：
WEEX唯客中文交流群：https://t.me/weex_group
WEEX唯客英文交流群：https://t.me/Weex_Global
