API reference
Methods, parameters and response types exported by @siebly/kraken-api. The same API is available in JavaScript and TypeScript.
Clients
Market data
| Task | Method |
|---|---|
| Read Spot tickers | SpotClient.getTicker() |
| Read a Spot order book | SpotClient.getOrderBook() |
| Read Spot pair metadata | SpotClient.getAssetPairs() |
| Read Futures tickers | DerivativesClient.getTickers() |
| Read a Futures order book | DerivativesClient.getOrderbook() |
| Subscribe to updates | WebsocketClient.subscribe() |
Account and orders
| Task | Method |
|---|---|
| Read Spot balances | getAccountBalance() |
| Validate or place a Spot order | submitOrder() |
| Query Spot orders by ID | getOrders() |
| Read open Spot orders | getOpenOrders() |
| Read closed Spot orders | getClosedOrders() |
| Cancel a Spot order | cancelOrder() |
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.