跳至主要内容

查詢API Key相關信息

獲取API key的相關信息。使用待查詢的api key調用接口。適用於母、子帳戶的api key。

提示

任意權限可以訪問該接口

HTTP 請求

GET /v5/user/query-api

請求參數

返回參數

參數類型說明
idstring唯一id. 內部使用
notestring備註
apiKeystringApi key
readOnlyinteger0:可讀可寫. 1:只讀
secretstring總是""
permissionsObject權限類型
> ContractTradearray合約交易的權限 Order, Position
> Spotarray現貨交易的權限 SpotTrade
> Walletarray錢包的權限 AccountTransfer, SubMemberTransfer(母帳戶), SubMemberTransferList(子帳戶), Withdraw(母帳戶)
> OptionsarrayUSDC合約的權限. 該權限支持USDC合約下的期權和永續交易 OptionsTrade
> Derivativesarray
  • 統一交易帳戶的默認勾選權限
  • 經典帳戶總是[]
  • > CopyTradingarray總是[], 因為帶單帳戶現在只需要通過ContractTrade權限項來進行API帶單
    > BlockTradearray大宗交易的權限. 子帳戶暫不支持,總是[]
    > Exchangearray兌換的權限 ExchangeHistory
    > NFTarrayNFT的權限 NFTQueryProductList. 子帳戶暫不支持, 總是[]
    > Affiliatearray代理商權限. 僅代理商可以擁有此權限, 否則總是[]
    ipsarray綁定的IP
    typeintegerApi key類型. 1:個人使用, 2:綁定到第三方應用
    deadlineDayintegerAPI key失效的倒數日. 針對那些未綁定IP的api key或者修改過密碼的帳戶
    expiredAtdatetimeAPI key的過期日. 針對那些未綁定IP的api key或者修改過密碼的帳戶
    createdAtdatetimeAPI key的創建日
    unifiedinteger該字段已廢棄
    utaintegerAPI Key所屬的帳戶是否為統一交易帳戶. 0:經典帳戶; 1:統一交易账户
    userIDinteger用戶 ID
    inviterIDinteger邀請人 ID(邀請該賬號加入平台的賬號的UID)
    vipLevelstringVIP用戶等級
    mktMakerLevelstringmarket maker等級
    affiliateIDinteger代理商Id. 0: 表示無任何代理綁定關係
    rsaPublicKeystringRSA公鑰
    isMasterboolean是否為主帳戶下的api key
    parentUidstring主帳戶uid. 如果是主帳戶本身調用, 則返回"0"
    kycLevelstring個人帳戶的kyc等級. LEVEL_DEFAULT, LEVEL_1LEVEL_2
    kycRegionstring個人帳戶的kyc地區

    請求示例

    GET /v5/user/query-api HTTP/1.1
    Host: api.bybit.com
    X-BAPI-API-KEY: XXXXXX
    X-BAPI-TIMESTAMP: 1676430842094
    X-BAPI-RECV-WINDOW: 5000
    X-BAPI-SIGN: XXXXXX

    響應示例

    {
    "retCode": 0,
    "retMsg": "",
    "result": {
    "id": "13770661",
    "note": "readwrite api key",
    "apiKey": "XXXXXX",
    "readOnly": 0,
    "secret": "",
    "permissions": {
    "ContractTrade": [
    "Order",
    "Position"
    ],
    "Spot": [
    "SpotTrade"
    ],
    "Wallet": [
    "AccountTransfer",
    "SubMemberTransfer"
    ],
    "Options": [
    "OptionsTrade"
    ],
    "Derivatives": [],
    "CopyTrading": [],
    "BlockTrade": [],
    "Exchange": [],
    "NFT": [],
    "Affiliate": []
    },
    "ips": [
    "*"
    ],
    "type": 1,
    "deadlineDay": 66,
    "expiredAt": "2023-12-22T07:20:25Z",
    "createdAt": "2022-10-16T02:24:40Z",
    "unified": 0,
    "uta": 0,
    "userID": 24617703,
    "inviterID": 0,
    "vipLevel": "No VIP",
    "mktMakerLevel": "0",
    "affiliateID": 0,
    "rsaPublicKey": "",
    "isMaster": true,
    "parentUid": "0",
    "kycLevel": "LEVEL_DEFAULT",
    "kycRegion": ""
    },
    "retExtInfo": {},
    "time": 1697525990798
    }