Skip to main content

Reset Sub-Account API Key

API Description

This interface allows the Master Account to reset the permissions of a specified sub-account API Key to its default state.

Note: Reset Sub-Account API Key is only available via RESTful API.

Precautions

  1. Master Account Only: This endpoint can only be called using the API Key of a Master Account.

Authentication

This is a Private interface. It requires authentication using the Master Account's API Key and Secret Key. For details on signature generation, please refer to Introduction > Authentication & Code Snippet > Spot > RESTful Private Interface.

Request Method

POST

Endpoint

/api/v1/private?command=reset_subAccount_apikey

Frequency Limit

The frequency limit for this interface is 3 requests/s per user ID. For detailed information on Global rate limits and API Rate Limiting Policy, please refer to the "Frequency Limit" section here.

Request Parameters

ParameterMandatoryTypeDescription
subAccount_apiKeytrueStringSubaccount API Key

Response Parameters

ParameterTypeDescription
dataObjectReturns None upon success.

Request Example

The following Python code shows how to reset a sub-account API key.

Note: For a complete code example, please refer to Introduction > Authentication & Code Snippet > Spot > RESTful Private Interface.

api_url = "/api/v1/private?command=reset_subAccount_apikey"
method = "post"
params = {"subAccount_apiKey": "********-fdbc-4888-ba06-**********"}

SpotRestfulPrivate(host, api_url, method, api_key, params, secret_key) # function SpotRestfulPrivate() is defined in section (Introduction > Authentication & Code Snippet > Spot > RESTful Private Interface)

Response Example

The following is an example response returned by the above request:

{
"code": "200",
"data": None,
"msg": "SUCCESS",
"success": true,
"failed": false
}