Skip to main content

Coinbase Exchange / Prime / INTX / Derivatives (HMAC)

Coinbase Exchange, Prime, International Exchange (INTX), and Derivatives Exchange (CDE).

Coinbase Exchange / Prime / INTX / Derivatives (HMAC) Logo

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 304 actions:

ActionPurposeParameters
exchange/get_accountsGet a list of trading accounts from the profile of the API key.No parameters
exchange/get_accounts_by_account_idInformation for a single account. Use this endpoint when you know the account_id. API key must belong to the same profile as the account.account_id (string) required
exchange/get_accounts_by_account_id_holdsList the holds of an account that belong to the same profile as the API key. Holds are placed on an account for any active orders or pending withdraw requests. As an order is filled, the hold amount is updated. If an order is canceled, any remaining hold is removed. For withdrawals, the hold is removed after it is completed.account_id (string) required
before (string)
after (string)
limit (integer)
exchange/get_accounts_by_account_id_ledgerLists ledger activity for an account. This includes anything that would affect the accounts balance - transfers, trades, fees, etc.account_id (string) required
start_date (string)
end_date (string)
before (string)
after (string)
limit (integer)
profile_id (string)
exchange/get_accounts_by_account_id_transfersLists past withdrawals and deposits for an account.account_id (string) required
before (string)
after (string)
limit (integer)
type (string)
exchange/get_address_bookGet all addresses stored in the address book.No parameters
exchange/post_address_bookAdd new addresses to address bookdata: {
. addresses (array)
} (object) required
exchange/delete_address_book_by_idDelete address from address bookid (string) required
exchange/get_coinbase_accountsGets all the user's available Coinbase wallets These are the wallets/accounts that are used for buying and selling on www.coinbase.comNo parameters
exchange/post_coinbase_accounts_by_account_id_addressesGenerates a one-time crypto address for depositing crypto.account_id (string) required
data: {
. account_id (string)
. profile_id (string)
. network (string)
} (object) required
exchange/get_conversionsGets all currency conversions i.e. USD - USDC for a given profileprofile_id (string)
before (string)
after (string)
limit (integer)
exchange/post_conversionsConverts funds from from currency to to currency. Funds are converted on the from account in the profile_id profile.data: {
. profile_id (string)
. from (string)
. to (string)
. amount (string)
. nonce (string)
} (object) required
exchange/get_conversions_feesGets a list of current conversion fee rates and trailing 30 day volume by currency pairNo parameters
exchange/get_conversions_by_conversion_idGets a currency conversion by id i.e. USD - USDC.conversion_id (string) required
profile_id (string)
exchange/get_currenciesGets a list of all known currencies. Note: Not all currencies may be currently in use for trading.No parameters
exchange/get_currencies_by_currency_idGets a single currency by id.currency_id (string) required
exchange/post_deposits_coinbase_accountDeposits funds from a www.coinbase.com wallet to the specified profile_id.data: {
. coinbase_account_id (string)
. amount (string)
. currency (string)
} (object) required
exchange/post_deposits_payment_methodDeposits funds from a linked external payment method to the specified profile_id.data: {
. amount (string)
. payment_method_id (string)
. currency (string)
} (object) required
exchange/get_feesGet fees rates and 30 days trailing volume.No parameters
exchange/get_fillsGet a list of fills. A fill is a partial or complete match on a specific order.order_id (string)
product_id (string)
limit (integer)
before (string)
after (string)
market_type (string)
start_date (string)
end_date (string)
exchange/get_loansAccepts zero or more loan IDs as input. If no loan IDs are specified, it returns all loans for the user. Otherwise it returns only the loan IDs specified.ids (string)
exchange/get_loans_assetsGet a list of lendable assets, a map of assets we accept as collateral for loans, and the haircut weight.No parameters
exchange/get_loans_interestList summaries of interest owed by assetNo parameters
exchange/get_loans_interest_history_by_loan_idList interest rate history for a loanloan_id (string) required
exchange/get_loans_interest_by_loan_idList interest charges for a loanloan_id (string) required
exchange/get_loans_lending_overviewThis API summarizes lending for a given client. It calculates the overall loan balance, collateral level, and amounts available to borrow. It also returns any withdrawal restrictions in force on the client.No parameters
exchange/get_loans_loan_previewThis API is similar to lending-overview but is used to preview the results of opening a new loan. The values returned in the preview response take the existing loans, collateral and the potential change being previewed into account. Note the preview request accepts native currency amounts as input.currency (string)
native_amount (string)
exchange/post_loans_openThis API triggers a loan open request. Funding is not necessarily instantaneous and there is no SLA. You are notified when funds have settled in your Exchange account. Loan open requests, once initiated, cannot be canceled.data: {
. loan_id (string)
. currency (string)
. native_amount (string)
. interest_rate (string)
. term_start_date (string)
. term_end_date (string)
. profile_id (string)
} (object) required
exchange/get_loans_optionsGet available currencies and interest rates for new loans. All amounts returned by this API are notional values i.e., USD.No parameters
exchange/post_loans_repay_interestSubmit an interest repayment for a loan.data: {
. idem (string)
. from_profile_id (string)
. currency (string)
. native_amount (string)
} (object) required
exchange/post_loans_repay_principalSubmit a principal repayment for a loan.data: {
. loan_id (string)
. idem (string)
. from_profile_id (string)
. currency (string)
. native_amount (string)
} (object) required
exchange/get_loans_repayment_previewPreview the results of a loan principal repayment.loan_id (string)
currency (string)
native_amount (string)
exchange/get_margin_auto_loanGet the setting to automatically initiate loans to meet margin calls with Coinbase affiliates in accordance with the Lending Agreement and Side LetterNo parameters
exchange/post_margin_auto_loanAutomatically initiate loans to meet margin calls with Coinbase affiliates in accordance with the Lending Agreement and Side Letterdata: {
. auto_loan (boolean)
} (object) required
exchange/get_margin_usdcGet the USDC to USD auto conversion setting to meet margin calls with eligible Coinbase AffiliateNo parameters
exchange/post_margin_usdcSet the USDC to USD auto conversion to meet margin calls with eligible Coinbase Affiliatedata: {
. enabled (boolean)
} (object) required
exchange/get_ordersList your current open orders. Only open or un-settled orders are returned by default. As soon as an order is no longer open and settled, it will no longer appear in the default request. Open orders may change state between the request and the response depending on market conditions.profile_id (string)
product_id (string)
sortedBy (string)
sorting (string)
start_date (string)
end_date (string)
before (string)
after (string)
limit (integer) required
status (array) required
market_type (string)
exchange/delete_ordersWith best effort, cancel all open orders. This may require you to make the request multiple times until all of the open orders are deleted.profile_id (string)
product_id (string)
exchange/post_ordersCreate an order. You can place two types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your account funds will be put on hold for the duration of the order. How much and which funds are put on hold depends on the order type and parameters specified.data: {
. profile_id (string)
. type (string)
. side (string)
. product_id (string)
. stp (string)
. stop (string)
. stop_price (string)
. price (string)
. size (string)
. funds (string)
. time_in_force (string)
. cancel_after (string)
. post_only (boolean)
. client_oid (string)
. max_floor (string)
. stop_limit_price (string)
} (object) required
exchange/get_orders_by_order_idGet a single order by id.order_id (string) required
market_type (string)
exchange/delete_orders_by_order_idCancel a single open order by id.order_id (string) required
profile_id (string)
product_id (string)
exchange/get_payment_methodsGets a list of the user's linked payment methods.No parameters
exchange/get_productsGets a list of available currency pairs for trading.type (string)
exchange/get_products_volume_summaryGets 30day and 24hour volume for all products and market typesNo parameters
exchange/get_products_by_product_idGet information on a single product.product_id (string) required
exchange/get_products_by_product_id_bookGet a list of open orders for a product. The amount of detail shown can be customized with the level parameter.product_id (string) required
level (integer)
exchange/get_products_by_product_id_candlesHistoric rates for a product. Rates are returned in grouped buckets. Candle schema is of the form timestamp, price_low, price_high, price_open, price_closeproduct_id (string) required
granularity (string)
start (string)
end (string)
exchange/get_products_by_product_id_statsGets 30day and 24hour stats for a product.product_id (string) required
exchange/get_products_by_product_id_tickerGets snapshot information about the last trade tick, best bid/ask and 24h volume.product_id (string) required
exchange/get_products_by_product_id_tradesGets a list the latest trades for a product.product_id (string) required
limit (integer)
before (string)
after (string)
exchange/get_profilesGets a list of all of the current user's profiles.active (boolean)
exchange/post_profilesCreate a new profile. Will fail if no name is provided or if user already has max number of profiles.data: {
. name (string)
} (object) required
exchange/post_profiles_transferTransfer an amount of currency from one profile to another.data: {
. from (string)
. to (string)
. currency (string)
. amount (string)
} (object) required
exchange/get_profiles_by_profile_idInformation for a single profile. Use this endpoint when you know the profile_id.profile_id (string) required
active (boolean)
exchange/put_profiles_by_profile_idRename a profile. Names 'default' and 'margin' are reserved.profile_id (string) required
data: {
. profile_id (string)
. name (string)
} (object) required
exchange/put_profiles_by_profile_id_deactivateDeletes the profile specified by profile_id and transfers all funds to the profile specified by to. Fails if there are any open orders on the profile to be deleted.profile_id (string) required
data: {
. profile_id (string)
. to (string)
} (object) required
exchange/get_reportsGets a list of all user generated reports.profile_id (string)
after (string)
limit (integer)
type (string)
ignore_expired (boolean)
exchange/post_reportsGenerates a report. You can create reports with historical data for all report types. Balance reports balance-reports can be snapshots of historical or current data.data: {
. type (string)
. year (string)
. format (string)
. email (string)
. profile_id (string)
. balance (object)
. fills (object)
. account (object)
. otc_fills (object)
. tax_invoice (object)
. rfq_fills (object)
} (object) required
exchange/get_reports_by_report_idGet a specific report by report_id.report_id (string) required
exchange/get_transfersGets a list of in-progress and completed transfers of funds in/out of any of the user's accounts.profile_id (string)
before (string)
after (string)
limit (integer)
type (string)
currency_type (string)
transfer_reason (string)
currency (string)
exchange/get_transfers_by_transfer_idGet information on a single transfer.transfer_id (string) required
exchange/post_transfers_by_transfer_id_travel_rulesSubmit travel information for a transfertransfer_id (string) required
data: {
. transfer_id (string)
. originator_name (string)
. originator_country (string)
. vasp_id (string)
. vasp_country (string)
. lei_number (string)
. business_address (object)
. wallet_type (string)
. is_self_certified (boolean)
} (object) required
exchange/get_travel_rulesReturn a list of all stored travel rule informationbefore (string)
after (string)
limit (integer)
address (string)
exchange/post_travel_rulesCreate travel rule entry for sending addressdata: {
. address (string)
. originator_name (string)
. originator_country (string)
. vasp_id (string)
. vasp_country (string)
. lei_number (string)
. originator_address (object)
. wallet_type (string)
. is_self_certified (boolean)
} (object) required
exchange/delete_travel_rules_by_idDelete existing travel rule entryid (string) required
exchange/get_users_by_user_id_exchange_limitsGets exchange limits information for a single user.user_id (string) required
exchange/post_users_by_user_id_settlement_preferencesUpdates the settlement preference to hold funds in either USDC or USD.user_id (string) required
data: {
. settlement_preference (string)
. user_id (string)
} (object) required
exchange/get_users_by_user_id_trading_volumesGets aggregated and individual trading volumes for users.user_id (string) required
exchange/post_withdrawals_coinbase_accountWithdraws funds from the specified profile_id to a www.coinbase.com wallet.data: {
. coinbase_account_id (string)
. amount (string)
. currency (string)
} (object) required
exchange/post_withdrawals_cryptoWithdraws funds from the specified profile_id to an external crypto addressdata: {
. profile_id (string)
. amount (string)
. currency (string)
. crypto_address (string)
. destination_tag (string)
. no_destination_tag (boolean)
. nonce (integer)
. network (string)
. add_network_fee_to_total (boolean)
. is_intermediary (boolean)
. travel_rule_data (object)
} (object) required
exchange/get_withdrawals_fee_estimateGets the fee estimate for the crypto withdrawal to crypto addresscurrency (string)
crypto_address (string)
network (string)
exchange/post_withdrawals_payment_methodWithdraws funds from the specified profile_id to a linked external payment methoddata: {
. amount (string)
. payment_method_id (string)
. currency (string)
} (object) required
exchange/get_wrapped_assetsReturns a list of all supported wrapped assets details objectsNo parameters
exchange/get_wrapped_assets_redeemGet details for all redeems in the profile associated with the API key.before (string)
after (string)
limit (integer)
from_currency (string)
to_currency (string)
status (string)
exchange/post_wrapped_assets_redeemRedeems from_currency to to_currency. Funds are redeemed in the profile associated with the API key.data: {
. from_currency (string)
. to_currency (string)
. amount (string)
. idem (string)
} (object) required
exchange/get_wrapped_assets_redeem_by_redeem_idGet details for a specific redeem in the profile associated with the API key.redeem_id (string) required
exchange/get_wrapped_assets_stake_wrapGet details for all stake-wraps in the profile associated with the API key.before (string)
after (string)
limit (integer)
from (string)
to (string)
status (string)
exchange/post_wrapped_assets_stake_wrapStakes and wraps from_currency to to_currency. Funds are stake-wrapped in the profile associated with the API key.data: {
. from_currency (string)
. to_currency (string)
. amount (string)
} (object) required
exchange/get_wrapped_assets_stake_wrap_by_stake_wrap_idGet details for a specific stake-wrap in the profile associated with the API key.stake_wrap_id (string) required
exchange/get_wrapped_assets_by_wrapped_asset_idReturns the circulating and total supply of a wrapped asset, and its conversion ratewrapped_asset_id (string) required
exchange/get_wrapped_assets_by_wrapped_asset_id_conversion_rateReturns the conversion rate of a wrapped assetwrapped_asset_id (string) required
exchange/customCall 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)
prime/get_v1_activities_by_activity_idRetrieve an activity by its activity ID - this endpoint can retrieve both portfolio and entity activities when passed the appropriate API keyactivity_id (string) required
prime/post_v1_allocationsCreate allocation for a given portfolio.data: {
. allocation_id (string)
. source_portfolio_id (string)
. product_id (string)
. order_ids (array)
. allocation_legs (array)
. size_type (string)
. remainder_destination_portfolio (string)
} (object) required
prime/post_v1_allocations_netCreate net allocation for a given portfolio.data: {
. source_portfolio_id (string)
. product_id (string)
. order_ids (array)
. allocation_legs (array)
. size_type (string)
. remainder_destination_portfolio (string)
. netting_id (string)
} (object) required
prime/post_v1_api_keys_rotateGenerates a new API key with the same configuration as the invoking key.data: {
. duration_seconds (integer)
} (object) required
prime/get_v1_conversion_feesGet your organization's stablecoin conversion fee tiers and month-to-date net conversion volume per currency. The organization is resolved from the authenticated API key, which must be organization-scoped.No parameters
prime/get_v1_entities_by_entity_id_accrualsLists interest accruals for an entity between the specified date range givenentity_id (string) required
portfolio_id (string)
start_date (string)
end_date (string)
prime/get_v1_entities_by_entity_id_activitiesList all activities associated with a given entity.entity_id (string) required
activity_level (string)
symbols (array)
categories (array)
statuses (array)
start_time (string)
end_time (string)
cursor (string)
limit (integer)
sort_direction (string)
get_network_unified_activities (boolean)
prime/get_v1_entities_by_entity_id_aggregate_positionsList paginated aggregate positions for a specific entity.entity_id (string) required
cursor (string)
limit (integer)
prime/get_v1_entities_by_entity_id_assetsList all assets available for a given entity.entity_id (string) required
prime/get_v1_entities_by_entity_id_balancesList all balances for a specific entity.entity_id (string) required
symbols (string)
cursor (string)
limit (integer)
aggregation_type (string)
prime/get_v1_entities_by_entity_id_cross_marginGets live data for Cross Margin XM for a specific XM customerentity_id (string) required
prime/get_v1_entities_by_entity_id_cross_margin_liquidationGets detailed liquidation data for an XM customer. Returns the active or most recent liquidation by default.entity_id (string) required
liquidation_id (string)
prime/get_v1_entities_by_entity_id_cross_margin_liquidationsLists historical liquidation records for an XM customerentity_id (string) required
cursor (string)
limit (integer)
sort_direction (string)
status (string)
start_time (string)
end_time (string)
prime/get_v1_entities_by_entity_id_cross_margin_risk_parametersGets the current Cross Margin XM risk parameters for an entity.entity_id (string) required
prime/post_v1_entities_by_entity_id_funding_settingsSets FCM funding configuration for the entity and submits the desired configuration to Prime API for approval.entity_id (string) required
data: {
. designated_funding_portfolio_id (string)
. automatic_conversion_enabled (boolean)
. automatic_loan_enabled (boolean)
. automatic_excess_return_enabled (boolean)
. excess_funds_target_amount (string)
} (object) required
prime/post_v1_entities_by_entity_id_futures_auto_sweepSet auto sweep for a given entity.entity_id (string) required
data: {
. auto_sweep (boolean)
} (object) required
prime/get_v1_entities_by_entity_id_futures_balance_summaryRetrieve fcm balance for a given entity.entity_id (string) required
prime/get_v1_entities_by_entity_id_futures_equityRetrieve the equity data for a given entity.entity_id (string) required
prime/get_v1_entities_by_entity_id_futures_margin_call_detailsRetrieve the margin call details for a given entity.entity_id (string) required
prime/get_v1_entities_by_entity_id_futures_positionsRetrieve all active fcm positions for a given entity.entity_id (string) required
product_id (string)
prime/get_v1_entities_by_entity_id_futures_risk_limitsRetrieve the risk limits for a given entity.entity_id (string) required
prime/get_v1_entities_by_entity_id_futures_settingsGet settings related to FCM.entity_id (string) required
prime/post_v1_entities_by_entity_id_futures_settingsUpdate settings related to FCM.entity_id (string) required
data: {
. target_derivatives_excess (string)
} (object) required
prime/get_v1_entities_by_entity_id_futures_sweepsRetrieve fcm sweeps in open status, including pending and processing sweeps.entity_id (string) required
prime/post_v1_entities_by_entity_id_futures_sweepsSchedule a sweep for a given entity from FCM wallet to USD Spot wallet. Only one pending sweep is allowed at a time per entity.entity_id (string) required
data: {
. amount (string)
. currency (string)
} (object) required
prime/delete_v1_entities_by_entity_id_futures_sweepsCancel the pending sweep for a given entity. A user will only be able to have one pending sweep at a time. If the sweep is not found, a 404 will be returned.entity_id (string) required
prime/get_v1_entities_by_entity_id_invoicesRetrieve a list of invoices belonging to an entity.entity_id (string) required
states (array)
billing_year (integer)
billing_month (integer)
cursor (integer)
limit (integer)
prime/get_v1_entities_by_entity_id_locates_availabilityGet currencies available to be located with their corresponding amount and rate.entity_id (string) required
conversion_date (string)
locate_date (string)
prime/get_v1_entities_by_entity_id_marginGets real-time evaluation of the margin model based on current positions and spot rates.entity_id (string) required
prime/get_v1_entities_by_entity_id_margin_summariesLists the margin call history for a given entity ID.entity_id (string) required
start_date (string)
end_date (string)
prime/get_v1_entities_by_entity_id_market_dataRetrieves market data including volatility and average daily volume for an entity.entity_id (string) required
cursor (string)
limit (integer)
sort_direction (string)
prime/get_v1_entities_by_entity_id_payment_methodsRetrieve all payment methods for a given entity.entity_id (string) required
prime/get_v1_entities_by_entity_id_payment_methods_by_payment_method_idGet payment method details by id for a given entity.entity_id (string) required
payment_method_id (string) required
prime/get_v1_entities_by_entity_id_positionsList paginated positions for a specific entity.entity_id (string) required
cursor (string)
limit (integer)
prime/get_v1_entities_by_entity_id_tf_obligationsList trade finance obligations for a given entity.entity_id (string) required
prime/get_v1_entities_by_entity_id_tf_tiered_feesGet trade finance tiered pricing fees for a given entity at a specific time, default to current time.entity_id (string) required
effective_at (string)
prime/get_v1_entities_by_entity_id_usersList all users associated with a given entity.entity_id (string) required
cursor (string)
limit (integer)
sort_direction (string)
prime/get_v1_financing_eligible_assetsGet all assets eligible for Trade Finance with their adjustment factors.No parameters
prime/get_v1_portfoliosList all portfolios for which the current API key has read access.No parameters
prime/get_v1_portfolios_by_portfolio_idRetrieve a given portfolio by its portfolio ID.portfolio_id (string) required
prime/post_v1_portfolios_by_portfolio_id_accept_quoteAccepts the quote received by the quote request and creates an order with the provided quote ID. Always required: portfolio_id, product_id, side, quote_id, client_quote_id.portfolio_id (string) required
data: {
. product_id (string)
. side (string)
. client_order_id (string)
. quote_id (string)
. settl_currency (string)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_accrualsLists interest accruals between the specified date range for a specific portfolio IDportfolio_id (string) required
start_date (string)
end_date (string)
prime/get_v1_portfolios_by_portfolio_id_activitiesList all activities associated with a given portfolio.portfolio_id (string) required
symbols (array)
categories (array)
statuses (array)
start_time (string)
end_time (string)
cursor (string)
limit (integer)
sort_direction (string)
get_network_unified_activities (boolean)
prime/get_v1_portfolios_by_portfolio_id_activities_by_activity_idRetrieve an activity by its activity IDportfolio_id (string) required
activity_id (string) required
prime/get_v1_portfolios_by_portfolio_id_address_bookGets a list of address book addresses.portfolio_id (string) required
currency_symbol (string)
search (string)
cursor (string)
limit (integer)
sort_direction (string)
prime/post_v1_portfolios_by_portfolio_id_address_bookCreates an entry for a portfolio's trusted addresses.portfolio_id (string) required
data: {
. address (string)
. currency_symbol (string)
. name (string)
. account_identifier (string)
. chain_ids (array)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_advanced_transfersList advanced transfers for a given portfolio. This API is currently not available to all clients. Please reach out to Prime Operations with any questions.portfolio_id (string) required
state (string)
type (string)
cursor (string)
limit (integer)
sort_direction (string)
start_time (string)
end_time (string)
reference_id (string)
prime/post_v1_portfolios_by_portfolio_id_advanced_transfersCreate advanced transfer for a given portfolio. This API is currently not available to all clients. Please reach out to Prime Operations with any questions.portfolio_id (string) required
data: {
. advanced_transfer (object)
} (object) required
prime/post_v1_portfolios_by_portfolio_id_advanced_transfers_by_advanced_transfer_id_cancelCancel advanced transfer for a given portfolio. This API is currently not available to all clients. Please reach out to Prime Operations with any questions.portfolio_id (string) required
advanced_transfer_id (string) required
data (object) required
prime/get_v1_portfolios_by_portfolio_id_advanced_transfers_by_advanced_transfer_id_transactionsList transactions associated with an Advanced Transfer. This API is currently not available to all clients. Please reach out to Prime Operations with any questions.portfolio_id (string) required
advanced_transfer_id (string) required
prime/get_v1_portfolios_by_portfolio_id_allocationsList historical allocations for a given portfolio.portfolio_id (string) required
product_ids (array)
order_side (string)
start_date (string) required
end_date (string)
cursor (string)
limit (integer)
sort_direction (string)
prime/get_v1_portfolios_by_portfolio_id_allocations_net_by_netting_idRetrieve an allocation by netting ID.portfolio_id (string) required
netting_id (string) required
prime/get_v1_portfolios_by_portfolio_id_allocations_by_allocation_idRetrieve an allocation by allocation ID.portfolio_id (string) required
allocation_id (string) required
prime/get_v1_portfolios_by_portfolio_id_balancesList all balances for a specific portfolio.portfolio_id (string) required
symbols (string)
balance_type (string)
prime/get_v1_portfolios_by_portfolio_id_buying_powerReturns the size of a buy trade that can be performed based on existing holdings and available credit. The result will differ for different assets due to asset specific credit configurations and caps. Note that this result is changing based on asset price fluctuations, so may be rejected when submitted.portfolio_id (string) required
base_currency (string) required
quote_currency (string) required
prime/get_v1_portfolios_by_portfolio_id_candlesGet rates for a single product by product ID, grouped in buckets.portfolio_id (string) required
product_id (string) required
start_time (string) required
end_time (string) required
granularity (string) required
prime/get_v1_portfolios_by_portfolio_id_commissionRetrieve commission associated with a given portfolio.portfolio_id (string) required
product_id (string)
prime/get_v1_portfolios_by_portfolio_id_counterpartyRetrieve the counterparty ID for a given portfolio.portfolio_id (string) required
prime/get_v1_portfolios_by_portfolio_id_creditRetrieve a portfolio's post-trade credit information.portfolio_id (string) required
prime/get_v1_portfolios_by_portfolio_id_derivatives_currency_summaryRetrieve per-currency international derivatives balances for a given portfolio. US Futures balances roll up to a single clearing account per entity rather than per portfolio, and are available from the entity futures balance summary and risk limits endpoints instead.portfolio_id (string) required
prime/get_v1_portfolios_by_portfolio_id_derivatives_positionsRetrieve all active derivative positions for a given portfolio.portfolio_id (string) required
product_id (string)
prime/get_v1_portfolios_by_portfolio_id_fillsRetrieve fills on a given portfolio. This endpoint requires a start_date, and returns a payload with a default limit of 100 if not specified by the user. The maximum allowed limit is 3000.portfolio_id (string) required
cursor (string)
limit (integer)
start_date (string) required
end_date (string)
sort_direction (string)
prime/get_v1_portfolios_by_portfolio_id_locatesList locates for the portfolioportfolio_id (string) required
locate_ids (array)
conversion_date (string)
locate_date (string)
prime/post_v1_portfolios_by_portfolio_id_locatesCreate a new locateportfolio_id (string) required
data: {
. symbol (string)
. amount (string)
. conversion_date (string)
. locate_date (string)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_margin_conversionsLists conversions and short collateral requirement between specified date range. This endpoint is deprecated and will be removed in the future. Use /v1/entities/entity_id/margin_summaries instead.portfolio_id (string) required
start_date (string)
end_date (string)
prime/put_v1_portfolios_by_portfolio_id_onchain_address_groupUpdates an entry to the portfolio's onchain address groups.portfolio_id (string) required
data: {
. address_group (object)
} (object) required
prime/post_v1_portfolios_by_portfolio_id_onchain_address_groupCreates an entry to the portfolio's onchain address groups.portfolio_id (string) required
data: {
. address_group (object)
} (object) required
prime/delete_v1_portfolios_by_portfolio_id_onchain_address_group_by_address_group_idDeletes an entry in the portfolio's onchain address groups.portfolio_id (string) required
address_group_id (string) required
prime/get_v1_portfolios_by_portfolio_id_onchain_address_groupsLists all onchain address groups for a given portfolio IDportfolio_id (string) required
prime/get_v1_portfolios_by_portfolio_id_open_ordersList all open orders. br /br /Caution: The maximum number of orders returned is 5000. If a client has more than 5000 open orders, an error is returned prompting the user to use Websocket API, or FIX API to stream open orders.portfolio_id (string) required
product_ids (array)
order_type (string)
cursor (string)
limit (integer)
sort_direction (string)
start_date (string)
order_side (string)
end_date (string)
prime/post_v1_portfolios_by_portfolio_id_orderCreate an order.portfolio_id (string) required
data: {
. product_id (string)
. side (string)
. client_order_id (string)
. type (string)
. base_quantity (string)
. quote_value (string)
. limit_price (string)
. start_time (string)
. expiry_time (string)
. time_in_force (string)
. stp_id (string)
. display_quote_size (string)
. display_base_size (string)
. is_raise_exact (boolean)
. historical_pov (string)
. stop_price (string)
. settl_currency (string)
. post_only (boolean)
. peg_offset_type (string)
. offset (string)
. wig_level (string)
. is_buy_exact (boolean)
} (object) required
prime/post_v1_portfolios_by_portfolio_id_order_previewRetrieve an order preview.portfolio_id (string) required
data: {
. product_id (string)
. side (string)
. type (string)
. base_quantity (string)
. quote_value (string)
. limit_price (string)
. start_time (string)
. expiry_time (string)
. time_in_force (string)
. is_raise_exact (boolean)
. historical_pov (string)
. stop_price (string)
. settl_currency (string)
. postOnly (boolean)
. display_quote_size (string)
. display_base_size (string)
. peg_offset_type (string)
. offset (string)
. wig_level (string)
. is_buy_exact (boolean)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_ordersList historical orders for a given portfolio. This endpoint returns a payload with a default limit of 100 if not specified by the user. The maximum allowed limit is 3000. br /br /Caution: Currently, you cannot query open orders with this endpoint: use List Open Orders if you have less than 1000 open orders, otherwise use Websocket API, or FIX API to stream open orders.portfolio_id (string) required
order_statuses (array)
product_ids (array)
order_type (string)
cursor (string)
limit (integer)
sort_direction (string)
order_side (string)
start_date (string)
end_date (string)
prime/get_v1_portfolios_by_portfolio_id_orders_by_order_idRetrieve an order by order ID.portfolio_id (string) required
order_id (string) required
prime/post_v1_portfolios_by_portfolio_id_orders_by_order_id_cancelCancel an order. Filled orders cannot be canceled.portfolio_id (string) required
order_id (string) required
prime/put_v1_portfolios_by_portfolio_id_orders_by_order_id_editEdit an open order.portfolio_id (string) required
order_id (string) required
data: {
. product_id (string)
. orig_client_order_id (string)
. client_order_id (string)
. base_quantity (string)
. quote_value (string)
. limit_price (string)
. expiry_time (string)
. display_quote_size (string)
. display_base_size (string)
. stop_price (string)
. offset (string)
. wig_level (string)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_orders_by_order_id_edit_historyList edit history for a specific orderportfolio_id (string) required
order_id (string) required
prime/get_v1_portfolios_by_portfolio_id_orders_by_order_id_fillsRetrieve fills on a given order. This endpoint returns a payload with a default limit of 100 if not specified by the user. The maximum allowed limit is 3000.portfolio_id (string) required
order_id (string) required
cursor (string)
limit (integer)
sort_direction (string)
prime/get_v1_portfolios_by_portfolio_id_productsList products for a given portfolio.portfolio_id (string) required
cursor (string)
limit (integer)
sort_direction (string)
product_type (string)
contract_expiry_type (string)
expiring_contract_status (string)
prime/post_v1_portfolios_by_portfolio_id_rfqA Quote Request is the start of the RFQ process. Coinbase Prime sends a Quote Request to Liquidity Providers LPs on behalf of a customer looking to participate in an RFQ trade. Always required: portfolio_id, product_id, side, client_quote_id, and limit_price. One of either base_quantity or quote_value is always required.portfolio_id (string) required
data: {
. product_id (string)
. side (string)
. client_quote_id (string)
. base_quantity (string)
. quote_value (string)
. limit_price (string)
. settl_currency (string)
. quote_duration_ms (string)
} (object) required
prime/post_v1_portfolios_by_portfolio_id_staking_initiateCreates an execution request to stake funds across a portfolio. This will stake funds in one or more wallets in the portfolio, with a total bondable balance up to the requested stake amount. This feature is gated. Please contact your account manager or primeops@coinbase.com to enable.portfolio_id (string) required
data: {
. idempotency_key (string)
. currency_symbol (string)
. amount (string)
. metadata (object)
} (object) required
prime/post_v1_portfolios_by_portfolio_id_staking_transaction_validators_queryList ETH 0x02 validators associated with wallet-level stake transactions for a given portfolio. It will not return data for unstake transactions, portfolio stake transactions, transactions which staked different currencies, or which staked to Ethereum 0x01 validators.portfolio_id (string) required
data: {
. transaction_ids (array)
. cursor (string)
. limit (integer)
. sort_direction (string)
} (object) required
prime/post_v1_portfolios_by_portfolio_id_staking_unstakeCreates an execution request to unstake funds across a portfolio. This will unstake funds in one or more wallets in the portfolio, with a total bonded balance up to the requested unstake amount. This feature is gated. Please contact your account manager or primeops@coinbase.com to enable.portfolio_id (string) required
data: {
. idempotency_key (string)
. currency_symbol (string)
. amount (string)
. metadata (object)
. validator_provider (string)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_transactionsList transactions for a given portfolio.portfolio_id (string) required
symbols (string)
types (array)
start_time (string)
end_time (string)
cursor (string)
limit (integer)
sort_direction (string)
get_network_unified_transactions (boolean)
travel_rule_status (array)
prime/get_v1_portfolios_by_portfolio_id_transactions_by_transaction_idRetrieve a specific transaction by its transaction ID.portfolio_id (string) required
transaction_id (string) required
prime/get_v1_portfolios_by_portfolio_id_transactions_by_transaction_id_travel_ruleBeta Get fulfilled travel rule data for a transaction.portfolio_id (string) required
transaction_id (string) required
prime/post_v1_portfolios_by_portfolio_id_transactions_by_transaction_id_travel_rule_depositSubmit travel rule data for an existing deposit transaction.portfolio_id (string) required
transaction_id (string) required
data: {
. originator (object)
. beneficiary
. is_self (boolean)
. opt_out_of_ownership_verification (boolean)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_usersList all users associated with a given portfolio.portfolio_id (string) required
cursor (string)
limit (integer)
sort_direction (string)
prime/get_v1_portfolios_by_portfolio_id_walletsList all wallets associated with a given portfolio.portfolio_id (string) required
type (string) required
cursor (string)
limit (integer)
sort_direction (string)
symbols (array)
get_network_unified_wallets (boolean)
prime/post_v1_portfolios_by_portfolio_id_walletsCreate a wallet. Note: The first ONCHAIN wallet for each network family must be created through the Prime UI.portfolio_id (string) required
data: {
. name (string)
. symbol (string)
. wallet_type (string)
. idempotency_key (string)
. network_family (string)
. network (object)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_wallets_by_wallet_idRetrieve a specific wallet by Wallet ID.portfolio_id (string) required
wallet_id (string) required
prime/get_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_addressesReturns all deposit addresses associated with a walletportfolio_id (string) required
wallet_id (string) required
network_id (string)
cursor (string)
limit (integer)
prime/post_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_addressesCreates a new deposit address for a wallet. Only applicable to wallets that support multiple deposit addresses on a given networkportfolio_id (string) required
wallet_id (string) required
data: {
. network_id (string)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_balanceQuery balance for a specific wallet.portfolio_id (string) required
wallet_id (string) required
prime/post_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_conversionPerform a conversion between 2 assets.portfolio_id (string) required
wallet_id (string) required
data: {
. amount (string)
. destination (string)
. idempotency_key (string)
. source_symbol (string)
. destination_symbol (string)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_deposit_instructionsRetrieve a specific wallet's deposit instructions.portfolio_id (string) required
wallet_id (string) required
deposit_type (string) required
network.id (string)
network.type (string)
prime/post_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_onchain_transactionCreate an onchain transaction.portfolio_id (string) required
wallet_id (string) required
data: {
. raw_unsigned_txn (string)
. rpc (object)
. evm_params (object)
} (object) required
prime/post_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_staking_claim_rewardsRequest to claim staking rewards. This feature is only for ETH Pectra 0x02 validators.portfolio_id (string) required
wallet_id (string) required
data: {
. idempotency_key (string)
. inputs (object)
} (object) required
prime/post_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_staking_initiateCreates an execution request to stake or delegate funds to a validatorportfolio_id (string) required
wallet_id (string) required
data: {
. idempotency_key (string)
. inputs (object)
. metadata (object)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_staking_statusGet staking status for a wallet. Returns estimated completion times for active staking requests.portfolio_id (string) required
wallet_id (string) required
prime/post_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_staking_unstakeCreates an execution request to unstake delegated or staked funds in a walletportfolio_id (string) required
wallet_id (string) required
data: {
. idempotency_key (string)
. inputs (object)
. metadata (object)
} (object) required
prime/post_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_staking_unstake_previewPreviews an unstaking request with the given amount and returns the estimated amount that would be unstaked. This feature currently only supports ETH.portfolio_id (string) required
wallet_id (string) required
data: {
. amount (string)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_staking_unstake_statusGet unstaking estimates for a wallet. Returns estimated completion times for active unstaking requests.portfolio_id (string) required
wallet_id (string) required
prime/get_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_transactionsRetrieve transactions for a given wallet.portfolio_id (string) required
wallet_id (string) required
types (array)
start_time (string)
end_time (string)
cursor (string)
limit (integer)
sort_direction (string)
prime/post_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_transfersCreate a wallet transfer.portfolio_id (string) required
wallet_id (string) required
data: {
. amount (string)
. destination (string)
. idempotency_key (string)
. currency_symbol (string)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_web3_balancesQuery balances for a specific onchain wallet.portfolio_id (string) required
wallet_id (string) required
visibility_statuses (array)
cursor (string)
limit (integer)
prime/post_v1_portfolios_by_portfolio_id_wallets_by_wallet_id_withdrawalsCreate a withdrawal.portfolio_id (string) required
wallet_id (string) required
data: {
. amount (string)
. destination_type (string)
. idempotency_key (string)
. currency_symbol (string)
. payment_method (object)
. blockchain_address (object)
. counterparty (object)
. travel_rule_data (object)
} (object) required
prime/get_v1_portfolios_by_portfolio_id_withdrawal_powerReturns the nominal quantity of a given asset that can be withdrawn based on holdings and current portfolio equity.portfolio_id (string) required
symbol (string) required
prime/get_v2_entities_by_entity_id_cross_margin_primeReturns real time risk data from the cross margin model.entity_id (string) required
prime/get_v1_entities_by_entity_id_rewards_rateReturns the current rewards rate and available rate tiers for the entity.entity_id (string) required
prime/get_v1_portfolios_by_portfolio_id_rewards_rateReturns the current rewards rate and available rate tiers for the portfolio.portfolio_id (string) required
prime/customCall 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)
intx/get_api_v1_assetsReturns a list of all supported assets.No parameters
intx/get_api_v1_assets_by_assetRetrieves information for a specific asset.asset (string) required
intx/get_api_v1_assets_by_asset_networksReturns a list of supported networks and network information for a specific asset.asset (string) required
intx/get_api_v1_index_by_index_compositionRetrieves the latest index composition metadata with an ordered set of constituents.index (string) required
intx/get_api_v1_index_by_index_composition_historyRetrieves a history of index composition records in a descending time order. The results are an array of index composition data recorded at different “timestamps”.index (string) required
time_from (string)
result_limit (integer)
result_offset (integer)
intx/get_api_v1_index_by_index_priceRetrieves the latest index priceindex (string) required
intx/get_api_v1_index_by_index_candlesRetrieves the historical daily index prices in time descending order. The daily values are represented as aggregated entries for the day in typical OHLC format.index (string) required
granularity (string) required
start (string) required
end (string)
intx/get_api_v1_instrumentsReturns all of the instruments available for trading.No parameters
intx/get_api_v1_instruments_by_instrumentRetrieves market information for a specific instrument.instrument (string) required
intx/get_api_v1_instruments_by_instrument_quoteRetrieves the current quote for a specific instrument.instrument (string) required
intx/get_api_v1_instruments_volumes_dailyRetrieves the trading volumes for each instrument separated by day.instruments (string) required
result_limit (integer)
result_offset (integer)
time_from (string)
show_other (boolean)
intx/get_api_v1_instruments_by_instrument_candlesRetrieves a list of aggregated candles data for a given instrument, granularity and time rangeinstrument (string) required
granularity (string) required
start (string) required
end (string)
intx/get_api_v1_instruments_by_instrument_fundingRetrieves the historical funding rates for a specific instrument.instrument (string) required
result_limit (integer)
result_offset (integer)
intx/get_api_v1_position_offsetsReturns all active position offsetsNo parameters
intx/post_api_v1_ordersCreates a new order.data: {
. client_order_id (string)
. side (string)
. size (string)
. tif (string)
. instrument (string)
. type (string)
. price (string)
. stop_price (string)
. stop_limit_price (string)
. expire_time (string)
. portfolio (string)
. stp_mode (string)
. post_only (boolean)
. close_only (boolean)
. algo_strategy (string)
} (object) required
intx/get_api_v1_ordersReturns a list of active orders resting on the order book matching the requested criteria. Does not return any rejected, cancelled, or fully filled orders as they are not active.portfolio (string)
instrument (string)
instrument_type (string)
client_order_id (string)
event_type (string)
order_type (string)
side (string)
ref_datetime (string)
result_limit (integer)
result_offset (integer)
intx/delete_api_v1_ordersCancels all orders matching the requested criteria.portfolio (string) required
instrument (string)
side (string)
instrument_type (string)
intx/put_api_v1_orders_by_idModifies an open order.id (string) required
data: {
. client_order_id (string)
. portfolio (string)
. price (string)
. stop_price (string)
. size (string)
} (object) required
intx/get_api_v1_orders_by_idRetrieves a single order. The order retrieved can be either active or inactive.id (string) required
portfolio (string) required
intx/delete_api_v1_orders_by_idCancels a single open order.id (string) required
portfolio (string) required
intx/post_api_v1_orders_previewPreviews a new order.data: {
. side (string)
. size (string)
. tif (string)
. instrument (string)
. type (string)
. price (string)
. stop_price (string)
. stop_limit_price (string)
. expire_time (string)
. portfolio (string)
. stp_mode (string)
. post_only (boolean)
. close_only (boolean)
} (object) required
intx/get_api_v1_portfoliosReturns all of the user's portfolios.No parameters
intx/post_api_v1_portfoliosCreate a new portfolio. Request will fail if no name is provided or if user already has max number of portfolios. Max number of portfolios is 20.data: {
. name (string)
} (object) required
intx/patch_api_v1_portfoliosUpdate parameters for existing portfoliodata: {
. auto_margin_enabled (boolean)
. cross_collateral_enabled (boolean)
. position_offsets_enabled (boolean)
. pre_launch_trading_enabled (boolean)
. portfolio_name (string)
} (object) required
intx/get_api_v1_portfolios_by_portfolioReturns the user's specified portfolio.portfolio (string) required
intx/put_api_v1_portfolios_by_portfolioUpdate existing user portfolio.portfolio (string) required
data: {
. name (string)
} (object) required
intx/get_api_v1_portfolios_by_portfolio_detailRetrieves the summary, positions, and balances of a portfolio.portfolio (string) required
intx/get_api_v1_portfolios_by_portfolio_summaryRetrieves the high level overview of a portfolio.portfolio (string) required
intx/get_api_v1_portfolios_by_portfolio_balancesReturns all of the balances for a given portfolio.portfolio (string) required
intx/get_api_v1_portfolios_by_portfolio_balances_by_assetRetrieves the balance for a given portfolio and asset.portfolio (string) required
asset (string) required
intx/get_api_v1_portfolios_by_portfolio_loansRetrieves all loan info for a given portfolio.portfolio (string) required
intx/get_api_v1_portfolios_by_portfolio_loans_by_assetRetrieves the loan info for a given portfolio and asset.portfolio (string) required
asset (string) required
intx/post_api_v1_portfolios_by_portfolio_loans_by_assetAcquire or repay loan for a given portfolio and asset.portfolio (string) required
asset (string) required
data: {
. action (string)
. amount (string)
} (object) required
intx/post_api_v1_portfolios_by_portfolio_loans_by_asset_previewPreview acquire or repay loan for a given portfolio and asset.portfolio (string) required
asset (string) required
data: {
. action (string)
. amount (string)
} (object) required
intx/get_api_v1_portfolios_by_portfolio_loans_by_asset_availabilityView the maximum amount of loan that could be acquired nowportfolio (string) required
asset (string) required
intx/get_api_v1_portfolios_by_portfolio_positionsReturns all of the positions for a given portfolio.portfolio (string) required
intx/get_api_v1_portfolios_by_portfolio_positions_by_instrumentRetrieves the position for a given portfolio and symbol.portfolio (string) required
instrument (string) required
intx/get_api_v1_portfolios_by_portfolio_position_limitsRetrieves the total open position limit across instruments for a given portfolio.portfolio (string) required
intx/get_api_v1_portfolios_by_portfolio_position_limits_positionsRetrieves position limits for all positions a given portfolio currently has or has opened in the past.portfolio (string) required
intx/get_api_v1_portfolios_by_portfolio_position_limits_positions_by_instrumentRetrieves the position limits for a given portfolio and symbol.portfolio (string) required
instrument (string) required
intx/get_api_v1_portfolios_fillsReturns fills for specified portfolios or fills for all portfolios if none are provided.portfolios (string)
order_id (string)
client_order_id (string)
ref_datetime (string)
result_limit (integer)
result_offset (integer)
time_from (string)
intx/get_api_v1_portfolios_by_portfolio_fillsReturns all of the fills for a given portfolio.portfolio (string) required
order_id (string)
client_order_id (string)
ref_datetime (string)
result_limit (integer)
result_offset (integer)
time_from (string)
intx/post_api_v1_portfolios_by_portfolio_cross_collateral_enabledEnable or disable the cross collateral feature for the portfolio, which allows the portfolio to use non-USDC assets as collateral for margin trading.portfolio (string) required
data: {
. enabled (boolean)
} (object) required
intx/post_api_v1_portfolios_by_portfolio_auto_margin_enabledEnable or disable the auto margin feature, which lets the portfolio automatically post margin amounts required to exceed the high leverage position restrictions.portfolio (string) required
data: {
. enabled (boolean)
} (object) required
intx/post_api_v1_portfolios_marginSpecify the margin override value for a portfolio to either increase notional requirements or opt-in to higher leverage.data: {
. portfolio_id (string)
. margin_override (string)
} (object) required
intx/post_api_v1_portfolios_transferTransfer assets from one portfolio to another.data: {
. from (string)
. to (string)
. asset (string)
. amount (string)
} (object) required
intx/post_api_v1_portfolios_transfer_positionTransfer an existing position from one portfolio to another. The position transfer must fulfill the same portfolio-level margin requirements as submitting a new order on the opposite side for the sender's portfolio and a new order on the same side for the recipient's portfolio. Additionally, organization-level requirements must be satisfied when evaluating the outcome of the position transfer.data: {
. from (string)
. to (string)
. instrument (string)
. quantity (string)
. side (string)
} (object) required
intx/get_api_v1_portfolios_fee_ratesRetrieves the Perpetual Future and Spot fee rate tiers for the user.No parameters
intx/get_api_v1_rankings_statisticsRetrieve your volume rankings for maker, taker, and total volume.instrument_type (string) required
period (string)
instruments (string)
intx/get_api_v1_transfersList matching transfersportfolio DEPRECATED (string)
portfolios (string)
time_from (string)
time_to (string)
result_limit (integer)
result_offset (integer)
status (string)
type (string)
intx/get_api_v1_transfers_by_transfer_uuidGet transfertransfer_uuid (string) required
intx/post_api_v1_transfers_withdrawWithdraw to crypto addressdata: {
. portfolio (string)
. asset (string)
. amount (string)
. add_network_fee_to_total (boolean)
. network_arn_id (string)
. address (string)
. nonce (integer)
} (object) required
intx/post_api_v1_transfers_addressCreate crypto addressdata: {
. portfolio (string)
. asset (string)
. network_arn_id (string)
} (object) required
intx/post_api_v1_transfers_create_counterparty_idCreate counterparty Iddata: {
. portfolio (string)
} (object) required
intx/post_api_v1_transfers_validate_counterparty_idValidate counterparty Iddata: {
. counterparty_id (string)
} (object) required
intx/post_api_v1_transfers_withdraw_counterpartyWithdraw to counterparty Iddata: {
. portfolio (string)
. counterparty_id (string)
. asset (string)
. amount (string)
. nonce (integer)
} (object) required
intx/post_api_v1_transfers_fee_estimateGet fee estimatedata: {
. asset (string)
. network_arn (string)
} (object) required
intx/post_api_v1_transfers_address_validateValidate network addressdata: {
. address (string)
. asset (string)
. network_arn_id (string)
} (object) required
intx/get_api_v1_fee_rate_tiersReturn all the fee rate tiers.No parameters
intx/customCall 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)
derivatives/get_rest_block_tradeRetrieves all block trades where user owns the reporting firm/entity.No parameters
derivatives/post_rest_block_tradeRetrieves permissioned block trades matching the specified filter criteria. All filter parameters are optional and can be combined.data: {
. symbols (array)
. request_time_filters (array)
. trade_ids (array)
. executing_traders (array)
. reporting_traders (array)
. accounts (array)
. client_order_ids (array)
. broker_codes (array)
. entities (array)
} (object) required
derivatives/get_rest_block_trade_account_permissionsRetrieves a list of all block trade account permissions you have access to.No parameters
derivatives/get_rest_block_trade_account_permissions_by_uuidRetrieves information for a block trade account permission with the specified UUID.uuid (string) required
derivatives/get_rest_block_trade_accountsRetrieves a list of all block trade accounts you have access to.No parameters
derivatives/get_rest_block_trade_accounts_by_uuidRetrieves information for a block trade account with the specified UUID.uuid (string) required
derivatives/get_rest_block_trade_entitiesRetrieves a list of all block trade entities you have access to.No parameters
derivatives/get_rest_block_trade_entities_by_uuidRetrieves information for a block trade entity with the specified UUID.uuid (string) required
derivatives/get_rest_block_trade_position_limitsRetrieves a list of all block trade position limits you have access to.No parameters
derivatives/get_rest_block_trade_position_limits_by_uuidRetrieves information for a block trade position limit with the specified UUID.uuid (string) required
derivatives/get_rest_block_trade_booking_bookable_accountsRetrieves the list of block trade accounts that the authenticated user can book trades for.No parameters
derivatives/get_rest_block_trade_booking_bookable_entitiesRetrieves the list of block trade entities that the authenticated user can book trades for.No parameters
derivatives/get_rest_block_trade_booking_bookable_tradersRetrieves the list of block traders that the authenticated user can book trades for.No parameters
derivatives/post_rest_block_trade_newBooks a new block trade between two parties. For TAS requests, set tas_sub_type=TAS, omit price, and provide tick_differential. If tas_sub_type is omitted, the request is treated as a non-TAS block trade: price is required and tick_differential must not be provided. tick_differential is expressed as the number of ticks from settlement.data: {
. buyer_entity (string)
. seller_entity (string)
. report_entity (string)
. buyer_trader (string)
. seller_trader (string)
. report_trader (string)
. buyer_account (string)
. seller_account (string)
. symbol (string)
. quantity (integer)
. price (number)
. request_timestamp (string)
. handling_inst
. buyer_cl_ord_id (string)
. seller_cl_ord_id (string)
. tas_sub_type
. tick_differential (integer)
} (object) required
derivatives/get_rest_block_tradersRetrieves a list of all block traders you have access to.No parameters
derivatives/get_rest_block_traders_by_uuidRetrieves information for a block trader with the specified UUID.uuid (string) required
derivatives/get_rest_firm_block_trade_entities_by_firm_uuidRetrieves the block trade entity associated with the specified firm.firm_uuid (string) required
derivatives/get_rest_firm_position_limitsRetrieves position limits for all firms that the user has access to.No parameters
derivatives/get_rest_firm_position_limits_by_firm_uuidRetrieves position limits from a specific firm.firm_uuid (string) required
derivatives/post_rest_firm_position_limits_by_firm_uuidUpdates position limits for a specific firmfirm_uuid (string) required
data: {
. long_limit (integer)
. short_limit (integer)
. weekend_margin_multiplier (number)
} (object) required
derivatives/post_rest_firm_product_group_limitCreates a zero position limit to a specific firm/product group that disables trading for that combination.data: {
. firm_uuid (string)
. product_group
} (object) required
derivatives/post_rest_firm_product_group_limit_removeRemoves any product group level limit for a specific firm/product group combinationdata: {
. firm_uuid (string)
. product_group
} (object) required
derivatives/get_rest_firm_product_group_limit_by_firm_uuidRetrieves product group limits for a specific firm, including individual product limits within each groupfirm_uuid (string) required
derivatives/post_rest_firm_product_limitCreates a limit that will block the firm from trading the corresponding product.data: {
. firm_uuid (string)
. product_code (string)
} (object) required
derivatives/post_rest_firm_product_limit_removeRemoves any product level limit for a specific firm and productdata: {
. firm_uuid (string)
. product_code (string)
} (object) required
derivatives/get_rest_firm_product_limit_by_firm_uuidGets product limits for a specific firm and optional product combination.firm_uuid (string) required
product_code (string)
derivatives/get_rest_firmsRetrieves a list of all firms you have access to.No parameters
derivatives/get_rest_firms_by_uuidRetrieves information for a firm with the specified UUID.uuid (string) required
derivatives/get_rest_funding_rateRetrieves the historical funding rate data for a specific instrument.symbol (string) required
trading_session_date (string)
derivatives/post_rest_instrumentsRetrieves detailed information about instruments based on the provided filter criteria. Allows optional filtering by product codes, symbols, instrument IDs, trading states, activation date, and expiration date.data: {
. product_codes (array)
. symbols (array)
. instrument_ids (array)
. trading_states (array)
. activation_date (string)
. expiration_date (string)
} (object) required
derivatives/post_rest_kill_switchActivates a kill switch to cancel orders and lock trading for specified users, firms, or FCMs. Must only include one uuid fcm, firm, or trading user. When activated, all open orders will be cancelled and new orders will be rejected.data: {
. fcm_uuid (string)
. firm_uuid (string)
. trading_user_uuid (string)
. only_cancel_no_trading_lock (boolean)
} (object) required
derivatives/get_rest_positionsRetrieves firm-level positions for all firms you have access toexpired_filter (string)
derivatives/get_rest_positions_by_firm_uuidRetrieves positions for the specified firmfirm_uuid (string) required
expired_filter (string)
derivatives/post_rest_unlock_tradingDeactivates kill switch to cancel orders and unlocks trading for specified users, firms, or FCMs. Must only include one uuid fcm, firm, or trading user.data: {
. fcm_uuid (string)
. firm_uuid (string)
. trading_user_uuid (string)
} (object) required
derivatives/get_rest_usersRetrieves a list of all users you have access to, or all users in the specified firm.firm_uuid (string)
derivatives/get_rest_users_by_uuidRetrieves information for a user with the specified UUID.uuid (string) required
derivatives/get_rest_v2_firm_position_limitsRetrieves position limits for all firms that the user has access to.No parameters
derivatives/get_rest_v2_firm_position_limits_by_firm_uuidRetrieves position limits from a specific firm.firm_uuid (string) required
derivatives/post_rest_v2_firm_position_limits_by_firm_uuidUpdates position limits for a specific firmfirm_uuid (string) required
data: {
. long_daily_limit (integer)
. short_daily_limit (integer)
. long_weekend_limit (integer)
. short_weekend_limit (integer)
. long_real_limit (integer)
. short_real_limit (integer)
. weekend_margin_multiplier (number)
} (object) required
derivatives/post_rest_v2_firm_product_group_limitCreates a zero position limit to a specific firm/product group that disables trading for that combination.data: {
. firm_uuid (string)
. product_group
} (object) required
derivatives/post_rest_v2_firm_product_group_limit_removeRemoves any product group level limit for a specific firm/product group combinationdata: {
. firm_uuid (string)
. product_group
} (object) required
derivatives/get_rest_v2_firm_product_group_limit_by_firm_uuidRetrieves product group limits for a specific firm, including individual product limits within each groupfirm_uuid (string) required
derivatives/post_rest_v2_firm_product_limitSet position limits on a product.data: {
. firm_uuid (string)
. product_code (string)
. trading_disabled (boolean)
. trading24x7_disabled (boolean)
. options_fill_protection_threshold (integer)
. long_daily_position_limit (integer)
. short_daily_position_limit (integer)
. long_real_position_limit (integer)
. short_real_position_limit (integer)
} (object) required
derivatives/post_rest_v2_firm_product_limit_batchSet position limits for multiple products.data: {
. firm_uuid (string)
. firm_product_limits_requests (array)
} (object) required
derivatives/post_rest_v2_firm_product_limit_removeRemoves any product level limit for a specific firm and productdata: {
. firm_uuid (string)
. product_code (string)
} (object) required
derivatives/get_rest_v2_firm_product_limit_by_firm_uuidGets product limits for a specific firm and optional product combination.firm_uuid (string) required
product_code (string)
derivatives/get_rest_v2_positionsRetrieves firm-level positions for all firms you have access toNo parameters
derivatives/get_rest_v2_positions_by_firm_uuidRetrieves positions for the specified firmfirm_uuid (string) required
derivatives/post_rest_valid_seriesRetrieves valid series information for instruments based on the provided filter criteria. Returns series data including product code, expiry, contract size, trading dates, and settlement information. Allows optional filtering by product codes, symbols, instrument IDs, trading states, activation date, and expiration date.data: {
. product_codes (array)
. symbols (array)
. instrument_ids (array)
. trading_states (array)
. activation_date (string)
. expiration_date (string)
} (object) required
derivatives/customCall 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)