Skip to main content

List Credentials

List trading account credentials.

Endpoint

GET /api/v3/credential/list

Description

Retrieves a list of all credentials belonging to the authenticated user.

Authentication

Requires Bearer token authentication.

Authorization: Bearer {access_token}

Request Parameters

ParameterTypeRequiredDescription
typestringNoFilter by credential type
statusstringNoFilter by status (ACTIVE, REVOKED)
credentialIdsstringNoComma-separated credential IDs

Response

Returns an array of credential objects.

FieldTypeDescription
credentialIdstringUnique credential identifier
userIdstringUser ID
venuestringExchange venue
namestringCredential name
typestringCredential type
apiKeystringAPI key (masked)
statusstringCredential status
createdAtintegerCreation timestamp (milliseconds)
updatedAtintegerLast update timestamp (milliseconds)

Usage

import requests

headers = {"Authorization": f"Bearer {access_token}"}

# List all credentials
response = requests.get(
"https://cadenza-api-uat.algo724.com/api/v3/credential/list",
headers=headers
)

credentials = response.json()["data"]
for cred in credentials:
print(f"{cred['venue']}: {cred['name']} ({cred['status']})")

# List only active credentials
response = requests.get(
"https://cadenza-api-uat.algo724.com/api/v3/credential/list",
headers=headers,
params={"status": "ACTIVE"}
)
curl "https://cadenza-api-uat.algo724.com/api/v3/credential/list?status=ACTIVE" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

Example Response

{
"data": [
{
"credentialId": "660e8400-e29b-41d4-a716-446655440000",
"userId": "user-uuid-here",
"venue": "BINANCE",
"name": "My Binance API Key",
"type": "EXCHANGE",
"apiKey": "abc123***",
"status": "ACTIVE",
"createdAt": 1703052635110,
"updatedAt": 1703052635110
},
{
"credentialId": "660e8400-e29b-41d4-a716-446655440001",
"userId": "user-uuid-here",
"venue": "COINBASE",
"name": "My Coinbase API Key",
"type": "EXCHANGE",
"apiKey": "xyz789***",
"status": "ACTIVE",
"createdAt": 1703052600000,
"updatedAt": 1703052600000
}
],
"success": true,
"errno": 0,
"error": null
}

Error Responses

HTTP CodeErrorDescription
400Invalid requestInvalid parameter values
401UnauthorizedInvalid or expired access token

Notes

  • API secrets are never returned in responses
  • Only credentials owned by the authenticated user are returned
  • Revoked credentials are still returned but with status REVOKED