Skip to main content

command.credential.revoke

Revoke a trading account credential.

Method

command.credential.revoke

Description

Revokes an API credential, preventing it from being used for trading operations. Associated trading accounts will be disconnected.

Parameters

FieldTypeRequiredDescription
credentialIdstringYesCredential ID to revoke

Result

Returns the revoked credential object.

Credential Object

FieldTypeDescription
credentialIdstringCredential identifier
venuestringExchange venue
statusstringUpdated status (REVOKED)
revokedAtintegerRevocation timestamp (ms)

Usage

result = await client.rpc("command.credential.revoke", {
"credentialId": "660e8400-e29b-41d4-a716-446655440001"
})

Example Response

{
"credentialId": "660e8400-e29b-41d4-a716-446655440001",
"venue": "BINANCE",
"credentialType": "API_KEY",
"nickname": "Main Trading Key",
"status": "REVOKED",
"createdAt": 1703052635110,
"updatedAt": 1703152635110,
"revokedAt": 1703152635110
}

Notes

  • Revoking a credential disconnects all associated trading accounts
  • Revoked credentials cannot be restored
  • You should also revoke the API key on the exchange side