query.credential.list
List trading account credentials.
Method
query.credential.list
Description
Returns a list of API credentials. Credentials are used to authenticate with exchange venues for trading operations.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
credentialIds | string[] | No | Filter by specific credential IDs |
credentialType | string | No | Filter by type (API_KEY, OAUTH) |
status | string | No | Filter by status (PENDING, VERIFIED, REVOKED) |
Result
Returns an array of credential objects.
Credential Object
| Field | Type | Description |
|---|---|---|
credentialId | string | Unique credential identifier (UUID) |
venue | string | Exchange venue |
credentialType | string | Credential type |
nickname | string | User-defined name |
status | string | Credential status |
createdAt | integer | Creation timestamp (ms) |
updatedAt | integer | Last update timestamp (ms) |
revokedAt | integer | Revocation timestamp (ms), if revoked |
Credential Status Values
| Status | Description |
|---|---|
PENDING | Credential created but not verified |
VERIFIED | Credential verified and ready for use |
REVOKED | Credential has been revoked |
Usage
# List all credentials
result = await client.rpc("query.credential.list", {})
# List verified credentials only
result = await client.rpc("query.credential.list", {
"status": "VERIFIED"
})
Example Response
{
"data": [
{
"credentialId": "660e8400-e29b-41d4-a716-446655440001",
"venue": "BINANCE",
"credentialType": "API_KEY",
"nickname": "Main API Key",
"status": "VERIFIED",
"createdAt": 1703052635110,
"updatedAt": 1703052635110
}
]
}
Notes
- API secrets are never returned in responses
- Only credentials owned by the current user are returned