Get Portfolio API

Retrieve trading portfolio's API List under the primary user

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

Rate limit: 3 requests per 10 seconds.

Retrieve API keys for trading portfolios under the primary user. The secretKey is not returned by this endpoint — it is only available at the time of creation.

Request Parameters

FieldTypeRequiredDescription
portfolioIdLongNoFilter by portfolio ID.
portfolioApiKeyStringNoFilter by API public key.
pageIntegerNoPage number. Default: 1.
pageSizeIntegerNoResults per page. Default: 100, max: 1000.

Response Fields

FieldTypeDescription
portfolioIdLongPortfolio identifier.
apiNameStringAPI 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

GET /api/v1/apiKey/portfolio?portfolioId=2154503491108165&page=1&pageSize=10

Example Response

{
  "code": 200,
  "message": "success",
  "data": {
    "page": 1,
    "pageSize": 10,
    "pageNum": 1,
    "totalSize": 1,
    "list": [
      {
        "portfolioId": 2154503491108165,
        "apiName": "my-trading-key",
        "accessKey": "63**4",
        "status": 1,
        "ip": "",
        "permission": "READ,TRADE",
        "createdAt": 1744466400000,
        "updatedAt": 1744466400000
      }
    ]
  }
}
Query Params
int64

portfolio id

string

portfolio api key

int32
Defaults to 1

Current page, default=1, the min value=1

int32
Defaults to 100

Page size, default=100, the max value=1000

Response

Language
Response
Choose an example:
application/json