Skip to content

User API (v2) ​

Query API Key Permissions (USER_DATA) ​

Query basic information and permissions for the current API Key.

  • GET /api/v2/user/query-api

Weight: 1

Parameters ​

NameTypeMandatoryDescription
recvWindowLONGNORequest validity window in milliseconds. Defaults to 5000 if omitted
timestampLONGYESRequest timestamp in milliseconds
signatureSTRINGYESHMAC SHA256 signature calculated with the API Secret

Response ​

On success, the endpoint returns:

json
{
  "code": 200,
  "msg": "success",
  "data": {
    "userId": "10001",
    "masterUserId": "90001",
    "leadTradingApiKey": false,
    "permissions": {
      "spot": {
        "accessMode": "READ_ONLY"
      },
      "contract": {
        "accessMode": "NONE"
      }
    }
  }
}
NameTypeDescription
userIdSTRINGUID of the user associated with the current API Key
masterUserIdSTRINGUser ID of the parent user
leadTradingApiKeyBOOLEANWhether this is a copy-trading leader API Key: true for yes, false for no
permissionsOBJECTSpot and contract account permissions
permissions.spotOBJECTSpot account permission
permissions.contractOBJECTContract account permission
permissions.*.accessModeSTRINGAccount domain access mode: NONE (no access), READ_ONLY (read-only), or READ_WRITE (read-write)

Released under the MIT License.