Skip to content

API reference ​

Methods, parameters and response types exported by @siebly/kraken-api. The same API is available in JavaScript and TypeScript.

Clients ​

Market data ​

TaskMethod
Read Spot tickersSpotClient.getTicker()
Read a Spot order bookSpotClient.getOrderBook()
Read Spot pair metadataSpotClient.getAssetPairs()
Read Futures tickersDerivativesClient.getTickers()
Read a Futures order bookDerivativesClient.getOrderbook()
Subscribe to updatesWebsocketClient.subscribe()

Account and orders ​

TaskMethod
Read Spot balancesgetAccountBalance()
Validate or place a Spot ordersubmitOrder()
Query Spot orders by IDgetOrders()
Read open Spot ordersgetOpenOrders()
Read closed Spot ordersgetClosedOrders()
Cancel a Spot ordercancelOrder()

Use Authentication for credentials, Order validation for a non-trading request, and Private account updates for streaming changes. Requests use Kraken's live services; see environment availability.

Search methods and types with ⌘K / Ctrl+K.

Reference index · Kraken API documentation

Built by Siebly. Open source SDKs for exchange APIs.