Kraken Spot
Spot trading, market data, balances, ledgers, deposits, withdrawals, Earn, subaccounts and affiliate reports.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 80 actions:
| Action | Purpose | Parameters |
|---|---|---|
| get_0_public_time | Get the server's time. | No parameters |
| get_0_public_system_status | Get the current system status or trading mode, along with any scheduled maintenance or ongoing emergency advisories. The upcoming_maintenance and emergency fields are additive — clients that do not read them are unaffected. Both are arrays; empty or absent when no advisory is active. upcoming_maintenance carries scheduled events that are within 72 hours. An event is removed once its maintenance window starts. emergency carries unresolved status page incidents. An incident is removed when it | No parameters |
| get_0_public_maintenance_schedule | Get 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 upcoming_maintenance array on Get System Status/api/spot/rest/operation/operation-get-system-status, which covers only the next 72 hours. Each entry carries the same fields as an upcoming_maintenance entry, including the derived phase and the order_submission / recommended_action guidance for that phase. Emergency incidents are not scheduled an | No parameters |
| get_0_public_assets | Get information about the assets that are available for deposit, withdrawal, trading and earn. | asset (string) aclass (string) assetVersion (integer) |
| get_0_public_asset_pairs | Get tradable asset pairs | assetVersion (integer) pair (string) aclass_base (string) info (string) country_code (string) execution_venue (string) |
| get_0_public_ticker | Get ticker information for all or requested markets. To clarify usage, note that Today's prices start at midnight UTC Leaving the pair parameter blank will return tickers for all tradeable assets on Kraken | pair (string) assetVersion (integer) asset_class (string) |
| get_0_public_ohlc | Retrieve 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 value of since. Returns up to 720 of the most recent entries older data cannot be retrieved, regardless of the value of since. | pair (string) required assetVersion (integer) interval (integer) since (integer) asset_class (string) |
| get_0_public_depth | Returns level 2 L2 order book, which describes the individual price levels in the book with aggregated order quantities at each level. | pair (string) required assetVersion (integer) count (integer) asset_class (string) |
| post_0_private_level3 | Retrieve Level3 order book data, which provides individual order information at each price level. This includes order IDs and timestamps for each order in the book. The Level3 endpoint requires authentication. API Key Permissions Required: Orders and trades - Query open orders and trades | data: { . pair (string) . depth (integer) } (object) required |
| get_0_public_grouped_book | The 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 for user interface display. Bids and asks between grouped price levels are accumulated to the nearest passive level asks rounded up, bids down. | pair (string) required depth (integer) grouping (integer) |
| get_0_public_trades | Returns the last 1000 trades by default | pair (string) required assetVersion (integer) since (string) count (integer) asset_class (string) |
| get_0_public_spread | Returns the last ~200 top-of-book spreads for a given pair | pair (string) required assetVersion (integer) since (integer) asset_class (string) |
| post_0_private_balance | Retrieve 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 default wallet. Use List Wallet Accounts/api-reference/account-data/list-wallet-accounts to obtain wallet account IDs. Note on Staking/Earn assets: We have begun to migrate assets from our legacy Staking system over to a new Earn system. As such, the following assets may appear in your balances and ledger. Please see our Support articlehttp | account_id (string) data: { . rebase_multiplier (string) } (object) |
| post_0_private_balance_ex | Retrieve all extended account balances, including credits and held amounts. Balance available for trading is calculated as: available balance = balance + credit - credit_used - hold_trade Note that held amounts only include spot non margin orders. Note on Staking/Earn assets: We have begun to migrate assets from our legacy Staking system over to a new Earn system. As such, the following assets may appear in your balances and ledger. Please see our Support articlehttps://support.kraken.com/hc/e | account_id (string) data: { . rebase_multiplier (string) } (object) |
| post_0_private_credit_lines | Retrieve all credit line details for VIPs with this functionality. API Key Permissions Required: Funds permissions - Query | account_id (string) data: { . rebase_multiplier (string) } (object) |
| post_0_private_trade_balance | Retrieve a summary of collateral balances, margin position valuations, equity and margin level. API Key Permissions Required: Orders and trades - Query open orders and trades | account_id (string) data: { . asset (string) . rebase_multiplier (string) } (object) |
| post_0_private_open_orders | Retrieve information about currently open orders. API Key Permissions Required: Orders and trades - Query open orders and trades | account_id (string) data: { . trades (boolean) . userref (integer) . cl_ord_id (string) . consolidate_taker (boolean) . with_cursor (boolean) . limit (integer) . cursor (string) . rebase_multiplier (string) } (object) |
| post_0_private_closed_orders | Retrieve 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 order's tx ID is given for start or end time, the order's opening time opentm is used API Key Permissions Required: Orders and trades - Query closed orders and trades | account_id (string) data: { . trades (boolean) . userref (integer) . cl_ord_id (string) . start (integer) . end (integer) . ofs (integer) . with_cursor (boolean) . cursor (string) . closetime (string) . consolidate_taker (boolean) . without_count (boolean) . rebase_multiplier (string) } (object) |
| post_0_private_query_orders | Retrieve information about specific orders. API Key Permissions Required: Orders and trades - Query open orders and trades or Orders and trades - Query closed orders and trades, depending on status of order | account_id (string) data: { . trades (boolean) . userref (integer) . txid (string) . cl_ord_id (string) . consolidate_taker (boolean) . rebase_multiplier (string) } (object) required |
| post_0_private_order_amends | Retrieves an audit trail of amend transactions on the specified order. The list is ordered by ascending amend timestamp. API Key Permissions Required: Orders and trades - Query open orders and trades or Orders and trades - Query closed orders and trades, depending on status of order. | account_id (string) data: { . order_id (string) . rebase_multiplier (string) } (object) required |
| post_0_private_trades_history | Retrieve information about trades/fills. By default, the most recent trades are returned. Unless otherwise stated, costs, fees, prices, and volumes are specified with the precision for the asset pair pair_decimals and lot_decimals, not the individual assets' precision decimals. API Key Permissions Required: Orders and trades - Query closed orders and trades | account_id (string) data: { . type (string) . trades (boolean) . start (integer) . end (integer) . ofs (integer) . without_count (boolean) . consolidate_taker (boolean) . ledgers (boolean) . rebase_multiplier (string) . aclass (string) . pair (string) . limit (integer) . with_cursor (boolean) . cursor (string) } (object) |
| post_0_private_query_trades | Retrieve information about specific trades/fills. API Key Permissions Required: Orders and trades - Query closed orders and trades | account_id (string) data: { . txid (string) . trades (boolean) . ledgers (boolean) . rebase_multiplier (string) } (object) required |
| post_0_private_open_positions | Get information about open margin positions. API Key Permissions Required: Orders and trades - Query open orders and trades | account_id (string) data |
| post_0_private_ledgers | Retrieve 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. Pass account_id to retrieve ledger entries for a specific wallet. Omit it to use the authenticated user's default wallet. Use List Wallet Accounts/api-reference/account-data/list-wallet-accounts to obtain wallet account IDs. Note on Staking/Earn assets: We have begun to migrate assets from our legacy Staking system over to a new Earn sy | account_id (string) data: { . asset . aclass (string) . type (string) . start (integer) . end (integer) . ofs (integer) . with_cursor (boolean) . cursor (string) . without_count (boolean) . rebase_multiplier (string) } (object) |
| post_0_private_query_ledgers | Retrieve information about specific ledger entries. Note on Staking/Earn assets: We have begun to migrate assets from our legacy Staking system over to a new Earn system. As such, the following assets may appear in your balances and ledger. Please see our Support articlehttps://support.kraken.com/hc/en-us/articles/360039879471-What-is-Asset-S-and-Asset-M- for more details. Note that these assets are 'read-only', to interact with your balances in them please use the base asset e.g. USDT to tra | account_id (string) data: { . id (string) . trades (boolean) . rebase_multiplier (string) } (object) required |
| post_0_private_trade_volume | Returns 30 day USD trading volume and resulting fee schedule for any asset pairs provided. Fees will not be included if pair is not specified as Kraken fees differ by asset pair. Note: If an asset pair is on a maker/taker fee schedule, the taker side is given in fees and maker side in fees_maker. For pairs not on maker/taker, they will only be given in fees. pair accepts either a comma-delimited list of pair names or a list of asset, aclass objects the latter is required for non-forex classes | data: { . pair . fee-info . fee_schedule (boolean) . rebase_multiplier (string) } (object) |
| post_0_private_add_export | Request export of trades or ledgers. API Key Permissions Required: Data - Export data | data required |
| post_0_private_export_status | Get status of requested data exports. API Key Permissions Required: Data - Export data | data required |
| post_0_private_retrieve_export | Retrieve a processed data export API Key Permissions Required: Data - Export data | data required |
| post_0_private_remove_export | Delete exported trades/ledgers report API Key Permissions Required: Data - Export data | data required |
| post_0_private_get_api_key_info | Retrieve information about the API key that is used to make the request, including its name, permissions, restrictions, and usage timestamps. API Key Permissions Required: None | data: { . otp (string) } (object) |
| post_0_private_list_wallet_accounts | Retrieve the wallet accounts associated with the authenticated user. Each wallet account includes a public account_id that identifies that wallet. Other endpoints that accept account_id for example Balance, Ledgers, and Funding Beta requests use this value to select a specific wallet. API Key Permissions Required: None | data: { } (object) |
| post_0_private_add_order | Place a new order. Note: See the AssetPairs/docs/rest-api/get-tradable-asset-pairs endpoint for details on the available trading pairs, their price and quantity precisions, order minimums, available leverage, etc. API Key Permissions Required: Orders and trades - Create and modify orders | data: { . userref (integer) . cl_ord_id (string) . ordertype (string) . type (string) . volume (string) . displayvol (string) . pair (string) . asset_class (string) . price (string) . price2 (string) . trigger (string) . leverage (string) . reduce_only (boolean) . stptype (string) . oflags (string) . timeinforce (string) . starttm (string) . expiretm (string) . closeordertype (string) . closeprice (string) . closeprice2 (string) . deadline (string) . validate (boolean) . broker (string) } (object) required |
| post_0_private_amend_order | The 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 identifiers assigned by Kraken and/or client will stay the same. Queue priority in the order book will be maintained where possible. If an amend request will reduce the order quantity below the existing filled quantity, the remaining quantity will be cancelled. For more detail, see amend transaction guide/docs/guides/spot-amends. API Key P | data: { . txid (string) . cl_ord_id (string) . order_qty (string) . display_qty (string) . limit_price (string) . trigger_price (string) . pair (string) . post_only (boolean) . deadline (string) } (object) |
| post_0_private_cancel_order | Cancel a particular open order or set of open orders by txid, userref or cl_ord_id API Key Permissions Required: Orders and trades - Create and modify orders or Orders and trades - Cancel and close orders | data: { . txid . cl_ord_id (string) } (object) |
| post_0_private_cancel_all | Cancel all open orders API Key Permissions Required: Orders and trades - Create and modify orders or Orders and trades - Cancel and close orders | data: { } (object) |
| post_0_private_cancel_all_orders_after | CancelAllOrdersAfter provides a 'Dead Man's Switch' mechanism to protect the client from network malfunction, extreme latency or unexpected matching engine downtime. The client can send a request with a timeout in seconds, that will start a countdown timer which will cancel all client orders when the timer expires. The client has to keep sending new requests to push back the trigger time, or deactivate the mechanism by specifying a timeout of 0. If the timer expires, all orders are cancelled and | data required |
| post_0_private_get_web_sockets_token | An authentication token must be requested via this REST API endpoint in order to connect to and authenticate with our Websockets API../guides/spot-ws-auth. The token should be used within 15 minutes of creation, but it does not expire once a successful Websockets connection and private subscription has been made and is maintained. API Key Permissions Required: WebSocket interface - On | data: { } (object) |
| post_0_private_add_order_batch | Sends 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 validation, the whole batch will be rejected. On submission to the engine, if an order fails pre-match checks i.e. funding, then the individual order will be rejected and remainder of the batch will be processed. All orders in batch are limited to a single pair. Note: See the AssetPairs/docs/rest-api/get-tradable-asset-pairs endpoint for | data: { . orders (array) . pair (string) . asset_class (string) . deadline (string) . validate (boolean) . broker (string) } (object) required |
| post_0_private_cancel_order_batch | Cancel multiple open orders by txid, userref or cl_ord_idmaximum 50 total unique IDs/references API Key Permissions Required: Orders and trades - Create and modify orders or Orders and trades - Cancel and close orders | data: { . orders (array) . cl_ord_ids (array) } (object) |
| post_0_private_edit_order | Sends 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 order will be created with the adjusted parameters a new txid will be returned in the response. Note: The new AmendOrder/exchange/guides/general/amends endpoint resolves the caveats listed below and has additional performance gains. Caveats for EditOrder: Triggered stop loss or take profit orders are not supported. Orders with conditional | data: { . userref (integer) . txid . volume (string) . displayvol (string) . pair (string) . asset_class (string) . price (string) . price2 (string) . oflags . deadline (string) . cancel_response (boolean) . validate (boolean) } (object) required |
| post_0_private_deposit_methods | This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding Beta API — see the Funding guide/exchange/guides/rest/funding and API reference/api-reference/funding-beta/list-funding-methods. Retrieve methods available for depositing a particular asset. API Key Permissions Required: Funds permissions - Query and Funds permissions - Deposit | data: { . asset (string) . aclass (string) . rebase_multiplier (string) } (object) required |
| post_0_private_deposit_addresses | This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding Beta API — see the Funding guide/exchange/guides/rest/funding and API reference/api-reference/funding-beta/list-funding-methods. Retrieve or generate a new deposit addresses for a particular asset and method. API Key Permissions Required: Funds permissions - Query | data: { . asset (string) . aclass (string) . method (string) . new (boolean) . amount } (object) required |
| post_0_private_deposit_status | This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding Beta API — see the Funding guide/exchange/guides/rest/funding and API reference/api-reference/funding-beta/list-funding-methods. Retrieve information about recent deposits. Results are sorted by recency, use the cursor parameter to iterate through list of deposits page size equal to value of limit from newest to oldest. API Key Permissions Required: Funds permissions - Query | data: { . asset (string) . aclass (string) . method (string) . start (string) . end (string) . cursor . limit (integer) . rebase_multiplier (string) } (object) |
| post_0_private_withdraw_methods | This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding Beta API — see the Funding guide/exchange/guides/rest/funding and API reference/api-reference/funding-beta/list-funding-methods. Retrieve a list of withdrawal methods available for the user. API Key Permissions Required: Funds permissions - Query and Funds permissions - Withdraw | data: { . asset (string) . aclass (string) . network (string) . rebase_multiplier (string) } (object) |
| post_0_private_withdraw_addresses | This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding Beta API — see the Funding guide/exchange/guides/rest/funding and API reference/api-reference/funding-beta/list-funding-methods. Retrieve a list of withdrawal addresses available for the user. API Key Permissions Required: Funds permissions - Query and Funds permissions - Withdraw | data: { . asset (string) . aclass (string) . method (string) . key (string) . verified (boolean) } (object) |
| post_0_private_withdraw_info | This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding Beta API — see the Funding guide/exchange/guides/rest/funding and API reference/api-reference/funding-beta/list-funding-methods. Retrieve fee information about potential withdrawals for a particular asset, key and amount. API Key Permissions Required: Funds permissions - Query and Funds permissions - Withdraw | data: { . asset (string) . key (string) . amount (string) } (object) required |
| post_0_private_withdraw | This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding Beta API — see the Funding guide/exchange/guides/rest/funding and API reference/api-reference/funding-beta/list-funding-methods. Make a withdrawal request. API Key Permissions Required: Funds permissions - Withdraw | data: { . asset (string) . aclass (string) . key (string) . address (string) . amount (string) . max_fee (string) . rebase_multiplier (string) } (object) required |
| post_0_private_withdraw_status | This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding Beta API — see the Funding guide/exchange/guides/rest/funding and API reference/api-reference/funding-beta/list-funding-methods. Retrieve information about recent withdrawals. Results are sorted by recency, use the cursor parameter to iterate through list of withdrawals page size equal to value of limit from newest to oldest. API Key Permissions Required: Funds permissions - W | data: { . asset (string) . aclass (string) . method (string) . start (string) . end (string) . cursor . limit (integer) . rebase_multiplier (string) } (object) |
| post_0_private_withdraw_cancel | This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding Beta API — see the Funding guide/exchange/guides/rest/funding and API reference/api-reference/funding-beta/list-funding-methods. Cancel a recently requested withdrawal, if it has not already been successfully processed. API Key Permissions Required: Funds permissions - Withdraw, unless withdrawal is a WalletTransfer, then no permissions are required. | data: { . asset (string) . refid (string) } (object) required |
| post_0_private_wallet_transfer | This endpoint will remain active but will no longer receive updates. It's highly recommended to migrate to the Funding Beta API — see the Funding guide/exchange/guides/rest/funding and API reference/api-reference/funding-beta/list-funding-methods. Transfer from a Kraken spot wallet to a Kraken Futures wallet. Note that a transfer in the other direction must be requested via the Kraken Futures API endpoint for withdrawals to Spot wallets../futures-api/trading/withdrawal. API Key Permissions Req | data required |
| get_funding_v1_fees_by_method_id | Calculate 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 later use with Create Funding Withdrawal/api-reference/funding-beta/create-funding-withdrawal. The token expires after 5 minutes and can be used on multiple withdrawals. API Key Permissions Required: Funds permissions - Query | method_id (string) required amount (string) required fee_included (boolean) withdrawal_fee_token (string) rebase_multiplier (string) account_id (string) |
| put_funding_v1_deposit_address | Claim a deposit address for a funding method. This generates an address for receiving funds. API Key Permissions Required: Funds permissions - Deposit | account_id (string) data: { . method_id (string) } (object) required |
| get_funding_v1_addresses | Retrieve saved withdrawal addresses for your account. Results are paginated; use the cursor parameter to iterate through the list of addresses page size equal to the value of limit. API Key Permissions Required: Funds permissions - Query | scope cursor (string) limit (integer) account_id (string) |
| post_funding_v1_addresses | Save a withdrawal address to the account for a funding method, network, or network group. See Adding a withdrawal address/exchange/guides/rest/funding section-1-adding-a-withdrawal-address for how those scopes work. API Key Permissions Required: Funds permissions - Add withdrawal addresses | account_id (string) data: { . scope . address_details . name (string) . description (string) } (object) required |
| get_funding_v1_withdrawals | Retrieve information about withdrawals. Results are sorted by recency; use the cursor parameter to iterate through the list of withdrawals page size equal to the value of limit from newest to oldest. API Key Permissions Required: Funds permissions - Query | asset: { . class (string) . name (string) } (object) scope status (string) cursor (string) limit (integer) start_time (string) end_time (string) rebase_multiplier (string) account_id (string) |
| post_funding_v1_withdrawals | Create a withdrawal to a saved address. Pass a withdrawal_fee_token from Calculate Funding Fees/api-reference/funding-beta/calculate-funding-fees to pin the quoted fee rate, or omit it to use the current fee. API Key Permissions Required: Funds permissions - Withdraw | account_id (string) data: { . scope . address_id (string) . amount (object) . fee . expected_address (string) } (object) required |
| put_funding_v1_addresses_by_id | Update the name and/or description of a saved withdrawal address. API Key Permissions Required: Funds permissions - Add withdrawal addresses | id (string) required account_id (string) data: { . name (string) . description (string) } (object) required |
| delete_funding_v1_addresses_by_id | Delete a saved withdrawal address. API Key Permissions Required: Funds permissions - Add withdrawal addresses | id (string) required account_id (string) |
| get_funding_v1_assets_by_direction | Retrieve assets available for the requested direction deposit or withdraw. API Key Permissions Required: Funds permissions - Query | direction (string) required asset_class (string) account_id (string) |
| get_funding_v2_deposit_addresses | Retrieve claimed deposit addresses. Results are paginated; use the cursor parameter to iterate through the list of addresses page size equal to the value of limit. API Key Permissions Required: Funds permissions - Query | scope cursor (string) limit (integer) asset: { . class (string) . name (string) } (object) account_id (string) |
| get_funding_v1_limits_deposit_by_asset_class_by_asset | Retrieve deposit limits for an asset, including remaining and maximum amounts where applicable. API Key Permissions Required: Funds permissions - Query | asset_class (string) required asset (string) required preferred_asset: { . class (string) . name (string) } (object) account_id (string) |
| get_funding_v1_deposits | Retrieve information about deposits. Results are sorted by recency; use the cursor parameter to iterate through the list of deposits page size equal to the value of limit from newest to oldest. API Key Permissions Required: Funds permissions - Query | asset: { . class (string) . name (string) } (object) scope status cursor (string) limit (integer) start_time (string) end_time (string) rebase_multiplier (string) account_id (string) |
| get_funding_v1_methods_by_direction | Retrieve funding methods for the requested direction deposit or withdraw. Results are paginated; use the cursor parameter to iterate through the list of methods page size equal to the value of limit. API Key Permissions Required: Funds permissions - Query | direction (string) required asset: { . class (string) . name (string) } (object) rebase_multiplier (string) limit (integer) cursor (string) account_id (string) |
| get_funding_v1_networks | Retrieve networks and network groups available for funding, including which networks share an address format. API Key Permissions Required: Funds permissions - Query | account_id (string) |
| get_funding_v1_limits_withdrawal_by_asset_class_by_asset | Retrieve withdrawal limits for an asset, including remaining and maximum amounts where applicable. API Key Permissions Required: Funds permissions - Query | asset_class (string) required asset (string) required preferred_asset: { . class (string) . name (string) } (object) account_id (string) |
| post_0_private_create_subaccount | Create a trading subaccount. Note: CreateSubaccount must be called using an API key from the master account. API Key Permissions Required: Funds permissions - Withdraw | data required |
| post_0_private_account_transfer | Transfer funds to and from master and subaccounts. Note: AccountTransfer must be called using an API key from the master account. API Key Permissions Required: Funds permissions - Withdraw | data required |
| post_0_private_earn_allocate | Allocate funds to the Strategy. Requires the Earn Funds API key permission. The amount must always be defined. This method is asynchronous. A couple of preflight checks are performed synchronously on behalf of the method before it is dispatched further. The client is required to poll the result using the /0/private/Earn/AllocateStatus endpoint. There can be only one deallocation request in progress for given user and strategy at any time. While the operation is in progress: 1. pending attrib | data: { . amount (string) . strategy_id (string) } (object) required |
| post_0_private_earn_deallocate | Deallocate funds from a strategy. Requires the Earn Funds API key permission. The amount must always be defined. This method is asynchronous. A couple of preflight checks are performed synchronously on behalf of the method before it is dispatched further. If the method returns HTTP 202 code, the client is required to poll the result using the /Earn/DeallocateStatus endpoint. There can be only one deallocation request in progress for given user and strategy. While the operation is in progress | data: { . amount (string) . strategy_id (string) } (object) required |
| post_0_private_earn_allocate_status | Get the status of the last allocation request. Requires either the Earn Funds or Query Funds API key permission. Deallocation operations are asynchronous and this endpoint allows client to retrieve the status of the last dispatched operation. There can be only one deallocation request in progress for given user and strategy. The pending attribute in the response indicates if the previously dispatched operation is still in progress true or has successfully completed false. If the dispatched r | data: { . strategy_id (string) } (object) required |
| post_0_private_earn_deallocate_status | Get the status of the last deallocation request. Requires either the Earn Funds or Query Funds API key permission. Deallocation operations are asynchronous and this endpoint allows client to retrieve the status of the last dispatched operation. There can be only one deallocation request in progress for given user and strategy. The pending attribute in the response indicates if the previously dispatched operation is still in progress true or has successfully completed false. If the dispatched | data: { . strategy_id (string) } (object) required |
| post_0_private_earn_strategies | List earn strategies along with their parameters. Requires a valid API key but not specific permission is required. Returns only strategies that are available to the user based on geographic region. When the user does not meet the tier restriction, can_allocate will be false and allocation_restriction_info indicates Tier as the restriction reason. Earn products generally require Intermediate tier. Get your account verified to access earn. A note about lock_type: - instant: can be deallocated | data: { . ascending (boolean) . asset (string) . cursor (string) . limit (integer) . lock_type (array) } (object) |
| post_0_private_earn_allocations | List all allocations for the user. Requires the Query Funds API key permission. By default all allocations are returned, even for strategies that have been used in the past and have zero balance now. That is so that the user can see how much was earned with given strategy in the past. hide_zero_allocations parameter can be used to remove zero balance entries from the output. Paging hasn't been implemented for this method as we don't expect the result for a particular user to be overwhelmingly | data: { . ascending (boolean) . converted_asset (string) . hide_zero_allocations (boolean) } (object) |
| get_0_public_pre_trade | Returns 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. | symbol (string) required |
| get_0_public_post_trade | Returns a list of trades on the spot exchange. If no filter parameters are specified, the last 1000 trades for all pairs are received. | symbol (string) from_ts (string) to_ts (string) count (integer) |
| get_affiliate_v1_cpa_progress | Return CPA qualification progress for one referred trader belonging to the authenticated affiliate. Pass the full iiban returned by Get Daily Activity. The response lists each CPA bounty separately with its reward, status, requirements, exact measurable values, and completion percentage. A measurable requirement can remain at 100 percent while an additional non-numeric step, such as a hold period, is still incomplete. Bounties that have qualified or paid remain visible. A bounty can also repor | iiban (string) required |
| get_affiliate_v1_payout_history | Return one page of the authenticated affiliate's payout history, newest first. Rows can include RevShare, Prop, CPA, and Futures Accelerator Bonus payments. Retainer, sub-affiliate carve-out, and remediation payments are not included. The summary covers the whole history, not only the current page. Its combined totals include those four payout sources. Paid totals include rows with public status paid; pending totals include rows with public status pending. Rows with another status can appear in | cursor (string) limit (integer) |
| get_affiliate_v1_daily_activity | Return one page of referred-user activity for the authenticated affiliate. The API returns activity for the account that owns the key, under its affiliate plan eligible for this API. Two ways to request activity use one per request: Day — activity_date YYYY-MM-DD. One page of enrolled referred users who had activity that UTC trade day and have not opted out, plus quiet users who enrolled that day and day-wide totals. Even a user who has never traded has an enrollment-day entry with enro | activity_date (string) iiban (string) start_date (string) end_date (string) all_users (boolean) cursor (string) limit (integer) |
| custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |