Bitstamp
Trade crypto, read balances and transactions, manage deposits, withdrawals, Earn, derivatives positions and Travel Rule data, and query market data.
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 95 actions:
| Action | Purpose | Parameters |
|---|---|---|
| post_api_v2_order_status | Returns order status. This call will be executed on the account Sub or Main, to which the used API key is bound to. Order can be fetched by using either id or client_order_id parameter. For closed orders, this call only returns information for the last 30 days. 'Order not found' error will be returned for orders outside this time range. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Missing id POST param | Id para | data: { . id (string) . client_order_id (string) . omit_transactions (string) } (object) required |
| post_api_v2_transfer_to_main | Transfers the desired balance from a Sub Account to your Main Account. Can be called by either the Main Account or a Sub Account, but requires a permission in both cases. The subAccount parameter must be provided if the Main Account is initiating the call. If a Sub Account is making the call, then it is the target Sub Account for the transfer and no further clarification is required. In that case, passing this parameter will have no additional effect. details summary style='cursor: pointer'stro | No parameters |
| post_api_v2_transfer_from_main | Transfers the desired balance from your Main Account to a Sub Account, specified by the subAccount parameter. This call can only be performed by your Main Account. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | 'parameter': Enter a number. Use '.' as a decimal point. | 'parameter' can only be number. | | You have only 'available' 'currency' available. Check your account balance for details. | Account has less 'ava | No parameters |
| post_api_v2_instant_convert_address_new | Creates a new instant convert address which will automatically sell your crypto for specified fiat currency. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Missing liquidation_currency parameter. | Parameter liquidation_currency is required for this call. | | Invalid currency / Currency ... not supported. | Invalid liquidation_currency. | | Cannot create new address, please try later. | At the moment we can't crea | No parameters |
| post_api_v2_instant_convert_address_info | Shows transactions for the instant convert address. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Address not found. | Provided address is wrong. | /details | No parameters |
| post_api_v2_websockets_token | Generates token required for subscribing to private WebSocket channels. | No parameters |
| post_api_v2_withdrawal_requests | Return user's withdrawal requests. This call will be executed on the account Sub or Main, to which the used API key is bound to. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Invalid timedelta | Timedelta needs to have only numeric characters. | | Timedelta too large | Timedelta too large. | | Invalid offset | Offset needs to be numeric characters between 0 and 200000. | | Invalid limit | Limit needs to be numeri | No parameters |
| post_api_v2_withdrawal_open | Opens a bank withdrawal request SEPA or international. Withdrawal requests opened via API are automatically confirmed no confirmation e-mail will be sent, but are processed just like withdrawals opened through the platform's interface. This call can only be performed by your Main Account. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Opening bank withdrawals with sub account API keys is not supported. | This API | No parameters |
| post_api_v2_withdrawal_cancel | Cancels a bank or crypto withdrawal request. This call can only be performed by your Main Account. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Cancelling bank withdrawals with sub account API keys is not supported. | This API endpoint can only be utilized by your main account. | | Missing parameters: ... | Parameters stated in the list ... are required for this call. | | No active bank withdrawal with id=X foun | No parameters |
| post_api_v2_withdrawal_status | Checks the status of a fiat withdrawal request. This call can only be performed by your Main Account. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Performing bank withdrawal status checks with sub account API keys is not supported. | This API endpoint can only be utilized by your main account. | | Missing parameters: .... | Parameters stated in the list ... are required for this call. | | No bank withdrawal with | No parameters |
| post_api_v2_by_currency_address | This call will be executed on the account Sub or Main, to which the used API key is bound to. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | User not verified | Your account needs to be verified before you can use this endpoint. | | Your deposits are currently disabled | No new deposits can be made at this time. If a URL is provided you can follow it to resolve any issues which might be causing this. | /details | currency (string) required data: { . network (string) } (object) required |
| post_api_v2_btc_unconfirmed | This API call is cached for 60 seconds. This call will be executed on the account Sub or Main, to which the used API key is bound to. | No parameters |
| post_api_v2_by_currency_withdrawal | Request a crypto withdrawal. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Missing amount and/or address POST parameters | One or both parameters missing. | | User not verified | Your account needs to be verified before you can use this endpoint. | | 'crypto_currency' withdrawals are currently unavailable for your account | Contact support for additional information. | | Not allowed to withdraw to specified 'cryp | currency (string) required |
| post_api_v2_ripple_address | This API call is cached for 60 seconds. This call will be executed on the account Sub or Main, to which the used API key is bound to. This endpoint supports withdrawals of USD, BTC, EUR and ETH IOU on the XRP Ledger. IOU supported globally except in the US and Singapore. ETH-IOU is also unsupported in UK. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | User not verified | Your account needs to be verified before y | No parameters |
| post_api_v2_ripple_withdrawal | This call will be executed on the account Sub or Main, to which the used API key is bound to. This endpoint supports withdrawals of USD, BTC, EUR or ETH IOU on the XRP Ledger. IOU supported globally except in the US and Singapore. ETH-IOU is also unsupported in UK details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Missing amount and/or address POST parameters | One or both parameters missing. | | User not verified | | No parameters |
| get_api_v2_currencies | Returns list of all currencies with basic data. | No parameters |
| get_api_v2_ticker | Return ticker data for all markets. Passing any GET parameters, will result in your request being rejected. | No parameters |
| get_api_v2_ticker_by_market_symbol | Return ticker data for the requested currency pair. Passing any GET parameters, will result in your request being rejected. | market_symbol (string) required |
| get_api_v2_ticker_hour_by_market_symbol | Return hourly ticker data for the requested currency pair. Passing any GET parameters, will result in your request being rejected. | market_symbol (string) required |
| get_api_v2_order_book_by_market_symbol | Returns order book data. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | POST method not allowed for this request. | HTTP method other than GET used. | | Invalid GET parameter. | Missing group parameter. | | Internal error. | Order book unavailable. | /details | market_symbol (string) required group (integer) |
| get_api_v2_transactions_by_market_symbol | Return transaction data from a given time frame. | market_symbol (string) required time (string) |
| get_api_v2_markets | View that returns list of all available markets. | entity (string) |
| get_api_v2_ohlc_by_market_symbol | Returns OHLC Open High Low Close data. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Missing data for required field. | Step and limit parameters are missing. | | Not a valid choice. | Value entered in parameter is invalid. | | Must be between 1 and 1000. | Limit value must be between 1 and 1000. | /details | market_symbol (string) required step (integer) required limit (integer) required start (integer) end (integer) exclude_current_candle (boolean) |
| get_api_v2_eur_usd | Return EUR/USD conversion rate. | No parameters |
| get_api_v2_funding_rate_by_market_symbol | Returns current funding rate data. | market_symbol (string) required |
| get_api_v2_margin_tiers | Returns a list of Margin Tiers for each Market | No parameters |
| get_api_v2_funding_rate_history_by_market_symbol | Returns historic funding rate data. | market_symbol (string) required limit (integer) since_timestamp (integer) until_timestamp (integer) |
| get_api_v2_derivatives_market_hours | Returns the index publishing schedule for all markets with index publishing schedules for the next 30 days. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned the index publishing schedules for all applicable | No parameters |
| get_api_v2_derivatives_market_hours_by_market_symbol | Returns the index publishing schedule for the requested market for the next 30 days. Schedules for markets that don't follow an index publishing schedule are not returned. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | market_symbol (string) required |
| post_api_v2_account_balances | Return account balances. | No parameters |
| post_api_v2_account_balances_by_currency | Return account balances for currency. | currency (string) required |
| post_api_v2_account_order_data | Retrieve historical order events for a specific market to enable gap recovery. | No parameters |
| post_api_v2_order_data | Retrieve historical public order events for a specific market to enable gap recovery. | No parameters |
| post_api_v2_fees_trading | Return all trading fees. | No parameters |
| post_api_v2_fees_trading_by_market_symbol | Return trading fees for market. | market_symbol (string) required |
| post_api_v2_fees_withdrawal | Return withdrawal fees. | No parameters |
| post_api_v2_fees_withdrawal_by_currency | Return withdrawal fee for currency. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Invalid network selection | The selected network is not supported for 'currency'. Please select a compatible network for it. | /details | currency (string) required data: { . network (string) } (object) required |
| post_api_v2_open_orders | Return user's open orders. This API call is cached for 10 seconds. This call will be executed on the account Sub or Main, to which the used API key is bound to. | No parameters |
| post_api_v2_open_orders_by_market_symbol | Return user's open orders for market. This API call is cached for 10 seconds. This call will be executed on the account Sub or Main, to which the used API key is bound to. | market_symbol (string) required |
| post_api_v2_buy_by_market_symbol | Open a buy limit order. This call will be executed on the account Sub or Main, to which the used API key is bound to. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Missing amount and/or price POST parameters | Missing one or both parameters. | | 'parameter': Enter a number. Use '.' as a decimal point. | 'parameter' can only be number. | | Minimum order size is 10 USD / 10 EUR / 10 GBP / 10 USDT / 10 USDC / 10 PAX | market_symbol (string) required |
| post_api_v2_buy_instant_by_market_symbol | Open a buy instant order. By placing an instant order you acknowledge that the execution of your order depends on the market conditions and that these conditions may be subject to sudden changes that cannot be foreseen. This call will be executed on the account Sub or Main, to which the used API key is bound to. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Missing amount and/or price POST parameters | Missing on | market_symbol (string) required |
| post_api_v2_buy_market_by_market_symbol | Open a buy market order. By placing a market order you acknowledge that the execution of your order depends on the market conditions and that these conditions may be subject to sudden changes that cannot be foreseen. This call will be executed on the account Sub or Main, to which the used API key is bound to. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Missing amount and/or price POST parameters | Missing one o | market_symbol (string) required |
| post_api_v2_sell_by_market_symbol | Open a sell limit order. This call will be executed on the account Sub or Main, to which the used API key is bound to. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Missing amount and/or price POST parameters | Missing one or both parameters. | | 'parameter': Enter a number. Use '.' as a decimal point. | 'parameter' can only be number. | | Minimum order size is 10 USD / 10 EUR / 10 GBP / 10 USDT / 10 USDC / 10 PA | market_symbol (string) required |
| post_api_v2_sell_instant_by_market_symbol | Open an instant sell order. By placing an instant order you acknowledge that the execution of your order depends on the market conditions and that these conditions may be subject to sudden changes that cannot be foreseen. This call will be executed on the account Sub or Main, to which the used API key is bound to. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Missing amount and/or price POST parameters | Missing | market_symbol (string) required |
| post_api_v2_sell_market_by_market_symbol | Open a sell market order. By placing a market order you acknowledge that the execution of your order depends on the market conditions and that these conditions may be subject to sudden changes that cannot be foreseen. This call will be executed on the account Sub or Main, to which the used API key is bound to. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Missing amount and/or price POST parameters | Missing one | market_symbol (string) required |
| post_api_v2_cancel_order | Cancel an order. This call will be executed on the account Sub or Main, to which the used API key is bound to. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Missing id POST param. | Id parameter missing. | | Invalid id POST param. | Id parameter must be a positive integer. | | Invalid client_cancel_id POST param. | client_cancel_id parameter can contain at most 180 characters. | | Invalid client_order_id POST par | No parameters |
| post_api_v2_cancel_all_orders | Cancel all open orders. This call will be executed on the account Sub or Main, to which the used API key is bound to. | No parameters |
| post_api_v2_cancel_all_orders_by_market_symbol | Cancel all open orders for a market. This call will be executed on the account Sub or Main, to which the used API key is bound to. | market_symbol (string) required |
| post_api_v2_replace_order | Replace an existing order with a new one by atomically canceling the existing order and placing a new order with updated price and/or amount. This call will be executed on the account Sub or Main, to which the used API key is bound to. Order Identification: You must provide either id order ID or orig_client_order_id to identify the order to be replaced. Required Parameters: - amount: New order amount decimal, min: 0.00000001, max: 92233720368 - price: New order price decimal, min: 0.00000001, | No parameters |
| get_api_v2_my_markets | Returns all markets that can be traded on selected account. | No parameters |
| post_api_v2_user_transactions | Return user transactions from a given time frame. This call will be executed on the account Sub or Main, to which the used API key is bound to. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Invalid offset | Offset parameter should be number from 0 to 200000. | | Limit too large | Max value of limit parameter is 1000. | | Invalid limit | Limit parameter should be number from 1 to 1000. | | Invalid sort parameter | | No parameters |
| post_api_v2_user_transactions_by_market_symbol | Return user transactions for a market from a given time frame. This call will be executed on the account Sub or Main, to which the used API key is bound to. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Invalid offset | Offset parameter should be number from 0 to 200000. | | Limit too large | Max value of limit parameter is 1000. | | Invalid limit | Limit parameter should be number from 1 to 1000. | | Invalid sor | market_symbol (string) required |
| post_api_v2_crypto_transactions | Return user's crypto transactions. This call will be executed on the account, to which the used API key is bound to. This call is for your main account only. details summary style='cursor: pointer'strongPossible errors/strong/summary | Reason | Action | | ----------- | ----------- | | Limit too large | Max value of limit parameter is 1000. | | Invalid limit | Limit parameter should be number from 1 to 1000. | | Offset too large | Offset parameter cannot be larger than 200000. | | Invalid offse | No parameters |
| get_api_v2_crypto_transactions_deposits | Returns cryptocurrency deposits for the authenticated user with review status information. The below table defines the HTTP Status codes that this API may return | Response code | Reason | |---------------|-----------------------------------------------------------| | 200 | Successfully retrieved deposits | | 400 | Invalid parameters timestamp, limit, or offset | | 403 | Insuffic | offset (string) limit (string) since_timestamp (string) until_timestamp (string) status (string) |
| post_api_v2_crypto_transactions_deposits_by_deposit_id | Submit originator/beneficiary details for a pending cryptocurrency deposit requiring travel rule compliance information before it can be credited. The below table defines the HTTP Status codes that this API may return | Response Code | Reason | |---------------|-----------------------------------------------------------| | 204 | Successfully updated | | 400 | VASP not found, contact not | deposit_id (string) required data: { . originator_thirdparty (boolean) . originator_id (string) . originator_info . beneficiary_info . vasp_uuid (string) } (object) required |
| post_api_v2_crypto_transactions_deposits_by_deposit_id_reject | A pending deposit is required for rejection; if the deposit is not in a pending state, rejection is not possible. Rejecting a pending deposit means the funds will NOT automatically be returned to the originator address. To have the deposited funds sent back to the originator address, please contact our support team. | Response Code | Reason | |---------------|------------------------------------------------------------------------| | deposit_id (string) required data required |
| post_api_v2_earn_subscribe | Subscribe given amount to lending / staking. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|-------------------------------------------------------------------------------------| | 200 | | Successfully subscribed to earn. | | 400 | API5001 | data: { . currency (string) . earn_type (string) . earn_term (string) . amount (number) } (object) required |
| post_api_v2_earn_unsubscribe | Unsubscribe given amount from lending / staking. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|-------------------------------------------------------------| | 200 | | Successfully unsubscribed from earn. | | 400 | API5001 | Earn request amount too low. | | | data: { . currency (string) . earn_type (string) . earn_term (string) . amount (number) } (object) required |
| post_api_v2_earn_subscriptions_setting | Manage subscription settings opt in, opt out. Currently only supported for staking. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|-------------------------------------------------------------| | 200 | | Successfully update subscription setting. | | 400 | API5004 | Operation is unsupported. | data: { . setting (string) . currency (string) . earn_type (string) } (object) required |
| get_api_v2_earn_transactions | Get earn transaction history. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|-------------------------------------------------------------| | 200 | | Returned earn transaction history. | | 400 | API5011 | Something went wrong, try again later. | | limit (integer) offset (integer) currency (string) quote_currency (string) |
| get_api_v2_earn_subscriptions | Get earn subscriptions for user. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|-------------------------------------------------------------| | 200 | | Returned earn subscriptions | | 400 | API5011 | Something went wrong, try again later. | | No parameters |
| post_api_v2_revoke_all_api_keys | Revoke all API keys across all user's accounts. | data: { } (object) required |
| get_api_v2_open_positions | Returns open positions list The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned open positions. | | 400 | API5506 | Trade account does not su | No parameters |
| get_api_v2_open_positions_by_market_symbol | Returns open positions list by market The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned open positions for given market. | | 400 | API5504 | Selected market | market_symbol (string) required |
| get_api_v2_position_status_by_position_id | Returns the position's status and metadata. This call will be executed on the trade account, to which the used API key is bound to. | position_id (string) required |
| get_api_v2_position_history | Returns positions history list The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned positions history. | | 400 | API5506 | Trade account does not | offset (string) limit (string) since_id (string) sort (string) |
| get_api_v2_position_history_by_market_symbol | Returns positions history list by market The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned positions history for given market. | | 400 | API5504 | Selected mar | market_symbol (string) required offset (string) limit (string) since_id (string) sort (string) |
| post_api_v2_close_positions | Closes positions corresponding to the inputs and returns 2 lists, one containing closed positions and another containing positions which failed to close. The below table defines the HTTP Status codes that this API may return | Status Code | Response Code | Reason | |---------------|---------------|------------------------------------------------------------------------------ | data: { . market (string) . margin_mode (string) . order_type (string) } (object) required |
| post_api_v2_close_position | Closes position based on position id and returns details of the closed position. The below table defines the HTTP Status codes that this API may return | Status Code | Response Code | Reason | |---------------|---------------|---------------------------------------------------------------------------------| | 200 | | Returned closed position data. | data: { . position_id (string) } (object) required |
| get_api_v2_position_settlement_transactions | Returns position settlement transaction list The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned position settlement transactions. | | 400 | API5506 | Trade ac | offset (string) limit (string) since_id (string) sort (string) since_timestamp (string) until_timestamp (string) |
| get_api_v2_position_settlement_transactions_by_transaction_id | Returns position settlement transaction list by market transaction The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned position settlement transactions. | | 400 | | transaction_id (string) required offset (string) limit (string) since_id (string) sort (string) since_timestamp (string) until_timestamp (string) |
| get_api_v2_trade_history | Returns derivatives trade history The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned derivatives trade history for. | | 400 | API5501 | One of 'market' or | limit (string) sort (string) order_id (string) since_timestamp (integer) until_timestamp (integer) after_id (string) |
| get_api_v2_trade_history_by_market_symbol | Returns derivatives trade history for requested market The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned derivatives trade history for given market. | | 400 | API5501 | market_symbol (string) required limit (string) sort (string) order_id (string) since_timestamp (integer) until_timestamp (integer) after_id (string) |
| post_api_v2_get_max_order_amount | Returns max buy/sell order amount for given parameters. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned max amount, amount currency, value and value currency for given params.| | 400 | API5502 | data: { . market (string) . margin_mode (string) . leverage (number) . order_type (string) . side (string) . price (number) . stop_price (number) . activation_price (number) . trailing_delta (integer) . additional_collateral (object) } (object) required |
| get_api_v2_margin_info | Returns margin information The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned margin information. | | 400 | API5506 | Trade account does not sup | No parameters |
| post_api_v2_estimated_order_impact | Returns estimated order impact The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned estimated margin impact of order parameters. | | 400 | API550 | data: { . market (string) . order_type (string) . amount (number) . order_side (string) . margin_mode (string) . leverage (number) . price (number) . reduce_only (boolean) . additional_collateral (object) } (object) required |
| post_api_v2_collateral_change_impact | Returns estimated collateral change impact for open positions based on input. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned estimated collateral change impact | | 400 | data: { . margin_mode (string) . market (string) . target_collateral (object) . collateral_deltas (object) } (object) required |
| get_api_v2_collateral_currencies | Returns collateral currencies with haircut | No parameters |
| post_api_v2_adjust_position_collateral | Returns updated collateral setting. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 204 | | Position collateral is adjusted successfully. | | 400 | API5504 | Selected market i | data: { . position_id (string) . new_amount (number) } (object) required |
| get_api_v2_leverage_settings | Returns leverage settings list The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 200 | | Returned leverage settings list. | | 503 | | Service currently unav | margin_mode (string) market (string) |
| post_api_v2_leverage_settings | Returns updated leverage setting. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------------------------------------------------------------------------| | 201 | | Returned leverage settings list. | | 503 | | Service currently u | data: { . margin_mode (string) . market (string) . leverage (number) } (object) required |
| get_api_v2_travel_rule_contacts_by_contact_uuid | Returns a specific contact that has been previously created. This can then be used to provide the originator or beneficiary details of a Travel Rule message, when transferring crypto from/to the platform. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|----------------------------------------------------------------------------| | 20 | contact_uuid (string) required |
| get_api_v2_travel_rule_contacts | Returns all contacts that have been previously created. These can then be used to provide the originator or beneficiary details of a Travel Rule message, when transferring crypto from/to the platform. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|----------------------------------------------------------------------------| | 200 | per_page (integer) page (integer) |
| post_api_v2_travel_rule_contacts | Enables a contact to be created and relevant information to be provided and stored. This can then be used to provide the originator or beneficiary details of a Travel Rule message, when transferring crypto from/to the platform. | Response Code | Status Code | Reason | |---------------|-------------|----------------------------------------------------------------------------| | 201 | | Successfully created | data: { . retail_info . corporate_info . id (string) . description (string) } (object) required |
| post_api_v2_travel_rule_addresses | Enables an address to be registered with contact data and a vasp name, meeting Travel Rule requirements, before using the address to transfer crypto to/from the platform. | Response Code | Status Code | Reason | |---------------|-------------|----------------------------------------------------------------------------| | 201 | | Successfully submitted counterparty info. | | | data: { . address (string) . network (string) . memo_id (string) . destination_tag (string) . transfer_id (integer) . contact_thirdparty (boolean) . contact_uuid (string) . vasp_uuid (string) } (object) required |
| get_api_v2_travel_rule_vasps | A list of Virtual Asset Service Providers needed to comply with the Travel Rule. These may be needed when transferring cryptocurrency from/to the platform. This is required in cases where the originating or destination address of the crypto transfer is hosted by a VASP. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|---------------- | per_page (integer) page (integer) |
| get_api_v2_travel_rule_satoshi_test | This function retrieves all active Satoshi tests previously created by the authenticated user for cryptocurrency address verification. These small cryptocurrency deposits are used to verify ownership of external wallet addresses, a requirement under Travel Rule regulations. Each test provides deposit instructions, including: - The specific amount to deposit - The source user address being verified - The Bitstamp deposit address to send to - The current verification status - The expiration time | network (string) address (string) status (string) |
| post_api_v2_travel_rule_satoshi_test | Starts a new Satoshi test to verify a cryptocurrency address for a given external wallet. This process is necessary to comply with the Travel Rule for incoming cryptocurrency transfers, as it verifies the user's control over the designated external wallet address. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|------- | data: { . address (string) . network (string) . currency (string) } (object) required |
| get_api_v2_travel_rule_satoshi_test_by_satoshi_test_uid | Retrieves a specific Satoshi test owned by the authenticated user using its unique identifier. HTTP Status Codes | Response Code | Status Code | Reason | |---------------|-------------|----------------------------------------------------------------------------| | 200 | | Successfully retrieved the Satoshi test. | | 403 | | Forbidden. The authenticat | satoshi_test_uid (string) required |
| get_api_v2_travel_rule_utxo_xpub_registrations | Returns all xpub registrations for the authenticated account. The extended_public_key and derived address lists are never returned. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|----------------------------------------------------------------------------| | 200 | | Successfully retrieved the list of xpub regis | network (string) status (string) offset (string) limit (string) |
| post_api_v2_travel_rule_utxo_xpub_registrations | Registers a master extended public key xpub / ypub / zpub for a UTXO chain. Creates the registration in pending_proof status. Proof-of-control must be completed via the Satoshi test before the registration becomes active. Security note: The extended_public_key value is write-only. It is accepted once on creation and is never returned in any API response. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | data: { . network (string) . extended_public_key (string) . label (string) } (object) required |
| post_api_v2_travel_rule_utxo_xpub_registrations_by_registration_id_revoke | Revokes an active registration. After revocation, addresses derived from this xpub are no longer treated as ownership-verified — future deposits or withdrawals involving those addresses require fresh verification. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|------------------------------------------------------------------------- | registration_id (string) required data required |
| get_api_v2_travel_rule_utxo_xpub_registrations_by_registration_id | Returns a single xpub registration owned by the authenticated user. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|----------------------------------------------------------------------------| | 200 | | Successfully retrieved the xpub registration. | | 403 | | | registration_id (string) required |
| get_api_v2_travel_rule_address_verification | Returns the ownership status for a network, address pair using xPub derivation. Designed as a pre-flight verification for Travel Rule and internal compliance workflows. The below table defines the HTTP Status codes that this API may return | Response Code | Status Code | Reason | |---------------|-------------|----------------------------------------------------------------------------| | 200 | | Successf | network (string) required address (string) required |
| 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) |