List Portfolio API keys under the main user. Main User Level key with READ required.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Lists API keys associated with RapidX Portfolios under the main user. Filter by Portfolio ID or access key, or paginate through the result. Secret Keys are not returned.
API key access
Requires a signed LTP Open API request with READ permission on the calling key.
| API key type | Can call | Scope |
|---|---|---|
| Main User Level API key (also the Main Portfolio key) | Yes | API keys for RapidX Portfolios under the main user. |
| Sub-user Level API key | No | This Open API endpoint does not support Sub-user Level keys. |
| Sub Portfolio Level API key | No | TRADE on a Sub Portfolio key does not grant API key management access. |
Client UI access and Open API access are different. A sub-user's ability to manage an assigned Portfolio's keys in the client does not allow their Sub-user Level key to call this endpoint. See API Management.
Rate limit
3 requests per 10 seconds.
Query parameters
All query parameters are optional.
| Name | Type | Required | Description |
|---|---|---|---|
portfolioId | integer (int64) | No | Filter by RapidX Portfolio ID under the main user. |
portfolioApiKey | string | No | Filter by the key's accessKey. |
page | integer | No | One-based page number. Defaults to 1. |
pageSize | integer | No | Records per page. Defaults to 100; maximum 1000. |
Response fields
| Field | Type | Description |
|---|---|---|
code | integer | Application result code. 200 means success. |
message | string | Result message. |
data | object | Paginated API key list. |
Pagination
| Field | Type | Description |
|---|---|---|
data.page | integer | Current page number. |
data.pageSize | integer | Page size used for this query. |
data.pageNum | integer | Total number of pages, not the current page. |
data.totalSize | integer | Total matching key records. |
data.list | array | Key records on this page. Empty when no records match. |
Key record: data.list[]
data.list[]| Field | Type | Description |
|---|---|---|
portfolioId | integer (int64) | Portfolio identifier. Preserve the full integer value. |
apiName | string | Key label. |
accessKey | string | The key identifier; use it as portfolioApiKey when filtering, updating or deleting. |
status | integer | 1 = Normal; 2 = Frozen. |
ip | string | Comma-separated IP whitelist; empty string means no IP restriction. |
permission | string | Granted permissions, comma-separated. |
createdAt | integer (int64) | Creation time, Unix timestamp in milliseconds. |
updatedAt | integer (int64) | Last update time, Unix timestamp in milliseconds. |
The 200 response example shows the successful response structure. Credentials in examples are placeholders.
Error responses
Check the application code even when the HTTP status is 200.
| Code | Meaning / action |
|---|---|
2003 | Permission denied. The calling key type is not supported by this endpoint. |
See Error codes for common authentication and request errors.