Update Portfolio API

Authentication required. Permission: TRADE. Primary user API keys only.

Rate limit: 3 requests per 10 seconds.

Update the configuration of an existing portfolio API key.

Request Parameters

FieldTypeRequiredDescription
portfolioIdLongYesPortfolio identifier.
portfolioApiKeyStringYesThe public API key to update.
apiNameStringNoNew label for the API key.
ipStringNoUpdated IP whitelist. Up to 20 addresses, comma-separated.
permissionStringNoUpdated permissions. Comma-separated: READ, TRANSFER, WITHDRAW, TRADE.

Response Fields

FieldTypeDescription
portfolioIdLongPortfolio identifier.
apiNameStringUpdated API key label.
accessKeyStringPublic API key.
statusInteger1: Normal, 2: Frozen.
ipStringWhitelisted IP addresses. Empty string if no restriction.
permissionStringAssigned permissions, comma-separated.
createdAtLongCreation time, in milliseconds since Unix epoch.
updatedAtLongLast update time, in milliseconds since Unix epoch.

Example Request

{
  "portfolioId": 2154503491108165,
  "portfolioApiKey": "6**4",
  "apiName": "my-trading-key-v2",
  "permission": "READ,TRADE"
}

Example Response

{
  "code": 200,
  "message": "success",
  "data": {
    "portfolioId": 2154503491108165,
    "apiName": "my-trading-key-v2",
    "accessKey": "6**4",
    "status": 1,
    "ip": "",
    "permission": "READ,TRADE",
    "createdAt": 1744466400000,
    "updatedAt": 1744466410000
  }
}
Query Params
int64
required

Trading Portfolio ID

string
required

API Public Key

string

API note

string

ip

string

READ, TRANSFER, WITHDRAW, TRADE

Responses

Language
Response
Choose an example:
application/json