Retrieve trading portfolio list under primary user.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Lists the RapidX Portfolios under the main user, including the Main Portfolio and Sub Portfolios. Each record contains the Portfolio ID, name, main/sub type, creation time and last update time.
Use this endpoint to identify a Portfolio for subsequent RapidX API calls. It returns Portfolio metadata, not balances, positions or margin information. A Portfolio is one trading unit; it is not an individual exchange venue or a DMA sub-account.
Recommended for Portfolio listing: use Get Trading Account List V2 with
primeType=RAPIDX&hideDust=false. This V1 endpoint remains supported. See the migration notes below.
API key access
Requires a signed LTP Open API request with READ permission.
| API key type | Can call | Scope |
|---|---|---|
| Main User Level API key (also the main Portfolio key) | Yes | Main Portfolio and Sub Portfolios under the main user. |
| Sub-user Level API key | No | This V1 endpoint supports main-user keys only. |
| Dedicated Sub Portfolio API key | No | This V1 endpoint is not Portfolio-scoped. |
Rate limit
3 requests per 10 seconds. This is the V1 endpoint's limit; the V2 alternative has its own rate limit.
Query parameters
All parameters are optional. Without Portfolio filters, the endpoint returns a paginated list of Portfolios under the main user.
| Name | Type | Required | Description |
|---|---|---|---|
portfolioId | integer (int64) | No | Filter by RapidX Portfolio ID. This is the portfolioId returned by this endpoint, not a user UID or DMA account ID. |
name | string | No | Filter by Portfolio name. Omit it when no name filter is needed. |
belongingTo | integer | No | Filter by Portfolio type: 0 = Main Portfolio; 2 = Sub Portfolio. Omit it to include both types. |
page | integer | No | One-based page number. Defaults to 1. |
pageSize | integer | No | Number of records per page. Defaults to 100. Use pagination to retrieve subsequent pages. |
For example, belongingTo=2&page=1&pageSize=100 requests the first page of Sub Portfolios. Continue through subsequent pages when more results are available.
Response fields
Result and pagination
| Field | Type | Description |
|---|---|---|
code | integer | Application result code. 200 means success. |
message | string | Result message. |
data | object | Paginated Portfolio result. |
data.page | integer | Current page number. |
data.pageSize | integer | Page size used for the result. |
data.pageNum | integer | Total number of pages. This is not the current page number; use data.page for that. |
data.totalSize | integer | Total number of Portfolio records matching the filters. |
data.list | array | Portfolio records on the current page. |
Portfolio record: data.list[]
data.list[]| Field | Type | Description |
|---|---|---|
portfolioId | integer (int64) | RapidX Portfolio identifier. Preserve the full integer value when storing it or passing it to another endpoint. |
name | string | Portfolio name. Corresponds to accountName in Account Assets V2. |
belongingTo | integer | Portfolio type: 0 = Main Portfolio; 2 = Sub Portfolio. This describes the Portfolio type, not its status or its assigned user. |
createAt | integer (int64) | Portfolio creation time, as a Unix timestamp in milliseconds. |
updateAt | integer (int64) | Portfolio's last update time, as a Unix timestamp in milliseconds. This is not an asset-balance snapshot time. |
This V1 response uses numeric Portfolio IDs. Use a lossless integer parser or preserve IDs as strings internally; do not round identifiers through a floating-point conversion.
Moving Portfolio listing to V2
Use Get Trading Account List V2 with primeType=RAPIDX&hideDust=false, and retrieve all result pages.
| V1 response field | V2 response field |
|---|---|
portfolioId | id (string) |
name | accountName |
belongingTo = 0 / 2 | portfolioType = MAIN / SUB |
- Use the V2
accountFilterparameter to filter by Portfolio ID. For name or main/sub filtering, filter the returnedaccountNameorportfolioTypein your client. - V2 defaults to 20 records per page and supports Main User Level and Sub-user Level keys within their permitted scope. Dedicated Sub Portfolio keys are not supported.
- V2 allows 10 requests per minute per API key.
- V2 does not return Portfolio creation/update timestamps. Its
updatedAtfield is the asset snapshot time.
For balances and RapidX-specific margin or transfer-limit details, see Get All Portfolio Assets. For other V1-to-V2 query mappings, see Account Assets migration guidance.
Error responses
An unsupported API key type returns application code 2003 (permission denied), even when the HTTP status is 200. See Error codes for common authentication and request errors.