Skip to main content

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

FieldTypeRequiredDescription
credentialIdsstring[]NoFilter by specific credential IDs
credentialTypestringNoFilter by type (API_KEY, OAUTH)
statusstringNoFilter by status (PENDING, VERIFIED, REVOKED)

Result

Returns an array of credential objects.

Credential Object

FieldTypeDescription
credentialIdstringUnique credential identifier (UUID)
venuestringExchange venue
credentialTypestringCredential type
nicknamestringUser-defined name
statusstringCredential status
createdAtintegerCreation timestamp (ms)
updatedAtintegerLast update timestamp (ms)
revokedAtintegerRevocation timestamp (ms), if revoked

Credential Status Values

StatusDescription
PENDINGCredential created but not verified
VERIFIEDCredential verified and ready for use
REVOKEDCredential 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