Kraken

Kraken

Cryptocurrencies Exchange

Finance & banking#cryptocurrency

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Cryptocurrencies Exchange

Endpoints 81

Market Data

  • GETGet Server Time/public/TimeGet the server's time.
  • GETGet System Status/public/SystemStatusGet the current system status or trading mode, along with any scheduled maintenance or ongoing emergency advisories. The upcoming_maintenance and emergency…
  • GETGet Maintenance Schedule/public/MaintenanceScheduleGet all scheduled maintenance events in the next 7-day window, ordered by expected_start_utc ascending. This is the planning view. It differs from the…
  • GETGet Asset Info/public/AssetsGet information about the assets that are available for deposit, withdrawal, trading and earn.
  • GETGet Tradable Asset Pairs/public/AssetPairsGet tradable asset pairs
  • GETGet Ticker Information/public/TickerGet ticker information for all or requested markets. To clarify usage, note that * Today's prices start at midnight UTC * Leaving the pair parameter blank…
  • GETGet OHLC Data/public/OHLC?pair=XBTUSDRetrieve OHLC market data. The last entry in the OHLC array is for the current, not-yet-committed timeframe, and will always be present, regardless of the…
  • GETGet Order Book/public/Depth?pair=XBTUSDReturns level 2 (L2) order book, which describes the individual price levels in the book with aggregated order quantities at each level.
  • POSTQuery L3 Order Book/private/Level3Retrieve Level3 order book data, which provides individual order information at each price level. This includes order IDs and timestamps for each order in the…
  • GETGet Grouped Order Book/public/GroupedBook?pair=BTC/USDThe GroupedBook endpoint aggregates the volume in the order book over a specified tick range. It provides a summary of liquidity deep into the book, useful…
  • GETGet Recent Trades/public/Trades?pair=XBTUSDReturns the last 1000 trades by default
  • GETGet Recent Spreads/public/Spread?pair=XBTUSDReturns the last ~200 top-of-book spreads for a given pair

Account Data

  • POSTGet Account Balance/private/BalanceRetrieve all cash balances, net of pending withdrawals. Pass account_id to retrieve balances for a specific wallet. Omit it to use the authenticated user's…
  • POSTGet Extended Balance/private/BalanceExRetrieve all extended account balances, including credits and held amounts. Balance available for trading is calculated as: available balance = balance +…
  • POSTGet Credit Lines/private/CreditLinesRetrieve all credit line details for VIPs with this functionality. API Key Permissions Required: Funds permissions - Query
  • POSTGet Trade Balance/private/TradeBalanceRetrieve a summary of collateral balances, margin position valuations, equity and margin level. API Key Permissions Required: Orders and trades - Query open…
  • POSTGet Open Orders/private/OpenOrdersRetrieve information about currently open orders. API Key Permissions Required: Orders and trades - Query open orders & trades
  • POSTGet Closed Orders/private/ClosedOrdersRetrieve information about orders that have been closed (filled or cancelled). 50 results are returned at a time, the most recent by default. Note: If an…
  • POSTQuery Orders Info/private/QueryOrdersRetrieve information about specific orders. API Key Permissions Required: Orders and trades - Query open orders & trades or Orders and trades - Query closed…
  • POSTGet Order Amends/private/OrderAmendsRetrieves an audit trail of amend transactions on the specified order. The list is ordered by ascending amend timestamp. API Key Permissions Required: Orders…
  • POSTGet Trades History/private/TradesHistoryRetrieve information about trades/fills. By default, the most recent trades are returned. * Unless otherwise stated, costs, fees, prices, and volumes are…
  • POSTQuery Trades Info/private/QueryTradesRetrieve information about specific trades/fills. API Key Permissions Required: Orders and trades - Query closed orders & trades
  • POSTGet Open Positions/private/OpenPositionsGet information about open margin positions. API Key Permissions Required: Orders and trades - Query open orders & trades
  • POSTGet Ledgers Info/private/LedgersRetrieve information about ledger entries. 50 results are returned at a time, the most recent by default. Set with_cursor to page through results with cursor.…
  • POSTQuery Ledgers/private/QueryLedgersRetrieve information about specific ledger entries. > Note on Staking/Earn assets: We have begun to migrate assets from our legacy Staking system over to a…
  • POSTGet Trade Volume/private/TradeVolumeReturns 30 day USD trading volume and resulting fee schedule for any asset pair(s) provided. Fees will not be included if pair is not specified as Kraken fees…
  • POSTRequest Export Report/private/AddExportRequest export of trades or ledgers. API Key Permissions Required: Data - Export data
  • POSTGet Export Report Status/private/ExportStatusGet status of requested data exports. API Key Permissions Required: Data - Export data
  • POSTRetrieve Data Export/private/RetrieveExportRetrieve a processed data export API Key Permissions Required: Data - Export data
  • POSTDelete Export Report/private/RemoveExportDelete exported trades/ledgers report API Key Permissions Required: Data - Export data
  • POSTGet API Key Info/private/GetApiKeyInfoRetrieve information about the API key that is used to make the request, including its name, permissions, restrictions, and usage timestamps. API Key…
  • POSTList Wallet Accounts/private/ListWalletAccountsRetrieve the wallet accounts associated with the authenticated user. Each wallet account includes a public account_id that identifies that wallet. Other…

Trading

  • POSTAdd Order/private/AddOrderPlace a new order. Note: See the AssetPairs endpoint for details on the available trading pairs, their price and quantity precisions, order minimums,…
  • POSTAmend Order/private/AmendOrderThe amend request enables clients to modify the order parameters in-place without the need to cancel the existing order and create a new one. * The order…
  • POSTCancel Order/private/CancelOrderCancel a particular open order (or set of open orders) by txid, userref or cl_ord_id API Key Permissions Required: Orders and trades - Create & modify orders…
  • POSTCancel All Orders/private/CancelAllCancel all open orders API Key Permissions Required: Orders and trades - Create & modify orders or Orders and trades - Cancel & close orders
  • POSTCancel All Orders After X/private/CancelAllOrdersAfterCancelAllOrdersAfter provides a "Dead Man's Switch" mechanism to protect the client from network malfunction, extreme latency or unexpected matching engine…
  • POSTGet Websockets Token/private/GetWebSocketsTokenAn authentication token must be requested via this REST API endpoint in order to connect to and authenticate with our Websockets API. The token should be used…
  • POSTAdd Order Batch/private/AddOrderBatchSends a collection of orders (minimum of 2 and maximum 15): * Validation is performed on the whole batch prior to submission to the engine. If an order fails…
  • POSTCancel Order Batch/private/CancelOrderBatchCancel multiple open orders by txid, userref or cl_ord_id(maximum 50 total unique IDs/references) API Key Permissions Required: Orders and trades - Create &…
  • POSTEdit Order/private/EditOrderSends a request to edit the order parameters of a live order. When an order has been successfully modified, the original order will be cancelled and a new…

Algo Trading

  • POSTAdd Strategy/private/AddStrategyCreate a new algorithmic strategy. The only supported strategy_type today is twap. A TWAP executes the total volume evenly between starttm and expiretm, as…
  • POSTCancel Strategy/private/CancelStrategyCancel a pending or open strategy by strategy_id. Cancellation stops further child-order scheduling. An already-submitted child order may still fill while…
  • POSTGet Open Strategies/private/GetOpenStrategiesRetrieve the account's active strategies, i.e. those with status pending or open. Strategies in a terminal state are returned by GetClosedStrategies. When the…
  • POSTQuery Strategies/private/QueryStrategiesRetrieve specific strategies by strategy_ids, a comma delimited list. Up to 20 ids can be sent in one request. The strategies are returned in…
  • POSTGet Closed Strategies/private/GetClosedStrategiesRetrieve strategies in a terminal state (closed, expired or cancelled) as an ordered array in result.closed. Strategies are returned newest first by closing…

funding-beta

  • GETCalculate Funding Feeshttps://api.kraken.com/funding/v1/fees/:method_id?amount=5Calculate the fee for a funding method and amount. For withdrawals, the response also includes a unique withdrawal_fee_token that pins the quoted fee rate for…
  • PUTClaim Funding Deposit Addresshttps://api.kraken.com/funding/v1/deposit/addressClaim a deposit address for a funding method. This generates an address for receiving funds. API Key Permissions Required: Funds permissions - Deposit
  • GETList Funding Addresseshttps://api.kraken.com/funding/v1/addressesRetrieve saved withdrawal addresses for your account. Results are paginated; use the cursor parameter to iterate through the list of addresses (page size…
  • POSTCreate Funding Addresshttps://api.kraken.com/funding/v1/addressesSave a withdrawal address to the account for a funding method, network, or network group. See Adding a withdrawal address for how those scopes work. API Key…
  • GETList Funding Withdrawalshttps://api.kraken.com/funding/v1/withdrawalsRetrieve information about withdrawals. Results are sorted by recency; use the cursor parameter to iterate through the list of withdrawals (page size equal to…
  • POSTCreate Funding Withdrawalhttps://api.kraken.com/funding/v1/withdrawalsCreate a withdrawal to a saved address. Pass a withdrawal_fee_token from Calculate Funding Fees to pin the quoted fee rate, or omit it to use the current fee.…
  • PUTUpdate Funding Addresshttps://api.kraken.com/funding/v1/addresses/:idUpdate the name and/or description of a saved withdrawal address. API Key Permissions Required: Funds permissions - Add withdrawal addresses
  • DELETEDelete Funding Addresshttps://api.kraken.com/funding/v1/addresses/:idDelete a saved withdrawal address. API Key Permissions Required: Funds permissions - Add withdrawal addresses
  • GETList Funding Assetshttps://api.kraken.com/funding/v1/assets/:directionRetrieve assets available for the requested direction (deposit or withdraw). API Key Permissions Required: Funds permissions - Query
  • GETList Funding Claimed Addresses (v2)https://api.kraken.com/funding/v2/deposit/addressesRetrieve claimed deposit addresses. Results are paginated; use the cursor parameter to iterate through the list of addresses (page size equal to the value of…
  • GETList Funding Deposit Limitshttps://api.kraken.com/funding/v1/limits/deposit/:asset_class/:assetRetrieve deposit limits for an asset, including remaining and maximum amounts where applicable. API Key Permissions Required: Funds permissions - Query
  • GETList Funding Depositshttps://api.kraken.com/funding/v1/depositsRetrieve information about deposits. Results are sorted by recency; use the cursor parameter to iterate through the list of deposits (page size equal to the…
  • GETList Funding Methodshttps://api.kraken.com/funding/v1/methods/:directionRetrieve funding methods for the requested direction (deposit or withdraw). Results are paginated; use the cursor parameter to iterate through the list of…
  • GETList Funding Networkshttps://api.kraken.com/funding/v1/networksRetrieve networks and network groups available for funding, including which networks share an address format. API Key Permissions Required: Funds permissions…
  • GETList Funding Withdrawal Limitshttps://api.kraken.com/funding/v1/limits/withdrawal/:asset_class/:assetRetrieve withdrawal limits for an asset, including remaining and maximum amounts where applicable. API Key Permissions Required: Funds permissions - Query

Funding

  • POSTGet Deposit Methods/private/DepositMethodsDeprecated. This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding (Beta) API — see the…
  • POSTGet Deposit Addresses/private/DepositAddressesDeprecated. This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding (Beta) API — see the…
  • POSTGet Status of Recent Deposits/private/DepositStatusDeprecated. This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding (Beta) API — see the…
  • POSTGet Withdrawal Methods/private/WithdrawMethodsDeprecated. This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding (Beta) API — see the…
  • POSTGet Withdrawal Addresses/private/WithdrawAddressesDeprecated. This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding (Beta) API — see the…
  • POSTGet Withdrawal Information/private/WithdrawInfoDeprecated. This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding (Beta) API — see the…
  • POSTWithdraw Funds/private/WithdrawDeprecated. This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding (Beta) API — see the…
  • POSTGet Status of Recent Withdrawals/private/WithdrawStatusDeprecated. This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding (Beta) API — see the…
  • POSTRequest Withdrawal Cancellation/private/WithdrawCancelDeprecated. This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding (Beta) API — see the…
  • POSTRequest Wallet Transfer/private/WalletTransferDeprecated. This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding (Beta) API — see the…

Subaccounts

  • POSTCreate Subaccount/private/CreateSubaccountCreate a trading subaccount. Note: CreateSubaccount must be called using an API key from the master account. API Key Permissions Required: Funds permissions -…
  • POSTAccount Transfer/private/AccountTransferTransfer funds to and from master and subaccounts. Note: AccountTransfer must be called using an API key from the master account. API Key Permissions…

Earn

  • POSTAllocate Earn Funds/private/Earn/AllocateAllocate funds to the Strategy. Requires the Earn Funds API key permission. The amount must always be defined. This method is asynchronous. A couple of…
  • POSTDeallocate Earn Funds/private/Earn/DeallocateDeallocate funds from a strategy. Requires the Earn Funds API key permission. The amount must always be defined. This method is asynchronous. A couple of…
  • POSTGet Allocation Status/private/Earn/AllocateStatusGet the status of the last allocation request. Requires either the Earn Funds or Query Funds API key permission. (De)allocation operations are asynchronous…
  • POSTGet Deallocation Status/private/Earn/DeallocateStatusGet the status of the last deallocation request. Requires either the Earn Funds or Query Funds API key permission. (De)allocation operations are asynchronous…
  • POSTList Earn Strategies/private/Earn/StrategiesList earn strategies along with their parameters. Requires a valid API key but not specific permission is required. Returns only strategies that are available…
  • POSTList Earn Allocations/private/Earn/AllocationsList all allocations for the user. Requires the Query Funds API key permission. By default all allocations are returned, even for strategies that have been…

Transparency

  • GETPre-Trade Data/public/PreTrade?symbol=BTC/USDReturns the price levels in the order book with aggregated order quantities at each price level. The top 10 levels are returned for each trading pair.
  • GETPost-Trade Data/public/PostTradeReturns a list of trades on the spot exchange. If no filter parameters are specified, the last 1000 trades for all pairs are received.

API details

Base URL
https://api.kraken.com/0
Authentication
An API key in the API-Key header
An API key in the API-Sign header
An API key in the API-Nonce header
An API key in the API-OTP header
Operations
81 operations on 78 pathsPOST 55GET 23PUT 2DELETE 1
10 marked deprecated
Main resources
Account Data 20funding-beta 15Market Data 12Funding 10Trading 9Earn 6Algo Trading 5Subaccounts 2Transparency 2
Response formats
application/json application/octet-stream
Description format
OpenAPI 3.0.0, API version 1.1.0

How to test the Kraken in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Kraken collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get Server Time” (GET /public/Time), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Kraken?

Cryptocurrencies Exchange It is listed under Finance & banking and has 81 endpoints.

Who publishes the Kraken?

It is listed from Kraken's public API description (an OpenAPI document), not published by Kraken on Swastik Codes. Anyone who controls kraken.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Kraken?

Requests go to https://api.kraken.com/0. Endpoint paths are added to this base URL.

How do I authenticate with the Kraken?

It accepts 4 methods: an API key in the API-Key header; an API key in the API-Sign header; an API key in the API-Nonce header; an API key in the API-OTP header.

How many endpoints does the Kraken have?

81 operations on 78 paths (55 POST, 23 GET, 2 PUT, 1 DELETE). The largest groups are Account Data, funding-beta, Market Data, Funding.

Is forking the Kraken free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.