Create Portfolio API

Create an API for Trading Portfolio by a primary user

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

Rate limit: 3 requests per 10 seconds.

Create an API key for a trading portfolio. Maximum 10 API keys per portfolio.

Request Parameters

FieldTypeRequiredDescription
portfolioIdLongYesPortfolio identifier.
apiNameStringYesLabel for the API key.
ipStringNoIP address whitelist. Up to 20 addresses, comma-separated. If omitted, all IPs are allowed.
permissionStringNoComma-separated list of permissions: READ, TRANSFER, WITHDRAW, TRADE.

Permission descriptions:

  • READ — Access account data and order history.
  • TRANSFER — Move assets between account types.
  • WITHDRAW — Withdraw funds from the account.
  • TRADE — Place and manage orders on the portfolio.

Response Fields

FieldTypeDescription
portfolioIdLongPortfolio identifier.
apiNameStringAPI key label.
accessKeyStringPublic API key.
secretKeyStringSecret API key. Only returned at creation time. Store it securely — it cannot be retrieved again.
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,
  "apiName": "my-trading-key",
  "permission": "READ,TRADE"
}

Example Response

{
  "code": 200,
  "message": "success",
  "data": {
    "portfolioId": 2154503491108165,
    "apiName": "my-trading-key",
    "accessKey": "6**4",
    "secretKey": "2**B",
    "status": 1,
    "ip": "",
    "permission": "READ,TRADE",
    "createdAt": 1744466400000,
    "updatedAt": 1744466400000
  }
}
Body Params
int64
required
string
required
string
string
Response

Language
Response
Choose an example:
application/json