# Coinbase Developer Documentation: API Reference Coinbase Advanced Trade API ## Coinbase Advanced Trade API ### Get Started - [Coinbase Advanced Trade API](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/introduction.md) ### Spot & US Derivatives - REST #### Accounts - [Get Account](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/accounts/get-account.md): Get a list of information about an account, given an account UUID. - [List Accounts](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/accounts/list-accounts.md): Get a list of authenticated accounts for the current user. #### Convert - [Commit Convert Trade](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/commit-convert-trade.md): Commits a convert trade with a specified trade id, source account, and target account - [Create Convert Quote](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/create-convert-quote.md): Create a convert quote with a specified source account, target account, and amount. Convert is applicable for USDC-USD, PYUSD-USD, EURC-EUR conversion, and PYUSD-USDC conversion - [Get Convert Trade](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/convert/get-convert-trade.md): Gets a list of information about a convert trade with a specified trade id, source account, and target account #### Data API - [Get API Key Permissions](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/data-api/get-api-key-permissions.md): Get information about your CDP API key permissions #### Fees - [Get Transaction Summary](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/fees/get-transaction-summary.md): Get a summary of transactions with fee tiers, total volume, and fees. #### US Derivatives - [Cancel Pending US Derivatives Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/cancel-pending-futures-sweep.md): Cancel the pending sweep of funds from FCM wallet to USD Spot wallet - [Get Current Margin Window](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-current-margin-window.md): Get the futures current margin window - [Get US Derivatives Balance Summary](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-balance-summary.md): Get a summary of balances for CFM trading - [Get US Derivatives Position](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-futures-position.md): Get positions for a specific CFM product - [Get Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/get-intraday-margin-setting.md): Get the futures intraday margin setting - [List US Derivatives Positions](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-positions.md): Get a list of positions in CFM products - [List US Derivatives Sweeps](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/list-futures-sweeps.md): Get pending and processing sweeps of funds from FCM wallet to USD Spot wallet - [Schedule US Derivatives Sweep](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/schedule-futures-sweep.md): Schedules a sweep of funds from FCM wallet to USD Spot wallet - [Set Intraday Margin Setting](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/futures/set-intraday-margin-settings.md): Set the futures intraday margin setting #### Orders - [Cancel Orders](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/orders/cancel-order.md): Initiate cancel requests for one or more orders. - [Close Position](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/orders/close-position.md): Places an order to close any open positions for a specified `product_id`. - [Create Order](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/orders/create-order.md): Create an order with a specified `product_id`, `side`, and `order_configuration`. - [Edit Order](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/orders/edit-order.md): Edit an order with a specified new `size`, or new `price`. - [Edit Order Preview](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/orders/edit-order-preview.md): Preview an edit order request with a specified new `size`, or new `price`. - [Get Order](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/orders/get-order.md): Get a single order by order ID. - [List Fills](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/orders/list-fills.md): Get a list of fills filtered by optional query parameters (`product_ids`, `order_ids`, etc.). - [List Orders](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/orders/list-orders.md): Get a list of orders filtered by optional query parameters (`product_ids`, `order_status`, etc.). - [Preview Order](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/orders/preview-orders.md): Preview an order. #### Payment Methods - [Get Payment Method](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/payment-methods/get-payment-method.md): Get information about a payment method for the current user. - [List Payment Methods](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/payment-methods/list-payment-methods.md): Get a list of payment methods for the current user. #### INTX (deprecated) - [Allocate Portfolio](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/perpetuals/allocate-portfolio.md): Allocate portfolio funds to a sub-portfolio on Intx Portfolio - [Get Perpetuals Portfolio Summary](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/perpetuals/get-perpetuals-portfolio-summary.md): Get a summary of your Perpetuals portfolio - [Get Perpetuals Position](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/perpetuals/get-perpetuals-position.md): Get a specific open position on Intx - [Get Portfolios Balances](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/perpetuals/get-portfolio-balances.md): Get a list of asset balances on Intx for a given Portfolio - [List Perpetuals Positions](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/perpetuals/list-perpetuals-positions.md): Get a list of open positions in your Perpetuals portfolio - [Opt In or Out of Multi Asset Collateral](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/perpetuals/opt-in-or-out.md): Enable or Disable Multi Asset Collateral for a given Portfolio #### Portfolios - [Create Portfolio](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/portfolios/create-portfolio.md): Create a portfolio. - [Delete Portfolio](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/portfolios/delete-portfolio.md): Delete portfolio. - [Edit Portfolio](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/portfolios/edit-portfolio.md): Edit a portfolio. - [Get Portfolio Breakdown](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/portfolios/get-portfolio-breakdown.md): Get the breakdown of a portfolio. - [List Portfolios](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/portfolios/list-portfolios.md): Get all portfolios of a user. - [Move Portfolio Funds](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/portfolios/move-portfolios-funds.md): Move funds between portfolios. #### Products - [Get Best Bid/Ask](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/products/get-best-bid-ask.md): Get the best bid/ask for all products. A subset of all products can be returned instead by using the product_ids input. - [Get Market Trades](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/products/get-market-trades.md): Get snapshot information by product ID about the last trades (ticks) and best bid/ask. - [Get Product](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/products/get-product.md): Get information on a single product by product ID. - [Get Product Book](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/products/get-product-book.md): Get a list of bids/asks for a single product. The amount of detail shown can be customized with the limit parameter. - [Get Product Candles](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/products/get-product-candles.md): Get rates for a single product by product ID, grouped in buckets. - [List Products](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/products/list-products.md): Get a list of the available currency pairs for trading. #### Public - [Get Public Market Trades](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/public/get-public-market-trades.md): Get snapshot information by product ID about the last trades (ticks) and best bid/ask. - [Get Public Product](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/public/get-public-product.md): Get information on a single product by product ID. - [Get Public Product Book](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/public/get-public-product-book.md): Get a list of bids/asks for a single product. The amount of detail shown can be customized with the limit parameter. - [Get Public Product Candles](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/public/get-public-product-candles.md): Get rates for a single product by product ID, grouped in buckets. - [Get Server Time](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/public/get-server-time.md): Get the current time from the Coinbase Advanced API. - [List Public Products](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/rest-api/public/list-public-products.md): Get a list of the available currency pairs for trading. ### Spot & US Derivatives - WS Streams #### Market Data - [Heartbeats](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/websocket/heartbeats.md): Real-time server pings (every second) to keep all connections open. Each message carries a heartbeat_counter so clients can detect missed messages. No products or authentication required. - [Candles](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/websocket/candles.md): Real-time updates on product candles, grouped into five-minute buckets, with updates every second. - [Product status](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/websocket/product-status.md): Sends all products and currencies on a preset interval. Provide the product_ids you want status for. - [Ticker](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/websocket/ticker.md): Real-time price updates every time a match happens. Batches updates during cascading matches to reduce bandwidth. - [Ticker (batched)](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/websocket/ticker-batch.md): Latest price updates every 5000 milliseconds (5 seconds) when there is a change. Same schema as the ticker channel except the envelope channel is ticker_batch and best bid / best ask fields are not provided. - [Level 2 order book](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/websocket/level2.md): Guarantees delivery of all updates and is the easiest way to keep an order book snapshot in sync. Subscribe with channel level2; received messages carry channel l2_data. new_quantity is the updated size at a price level (not a delta); a value of "0" means the level can be removed. - [Market trades](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/websocket/market-trades.md): Real-time trades for the subscribed products. Updates are collected over the last 250 ms and sent together, so an update may contain one or many trades. #### Private - [User orders and positions](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/websocket/user.md): Authenticated. Sends updates on a user's open orders and current positions, including all subsequent updates. This is the only channel that accepts `-USDC` product IDs. - [Futures balance summary](https://docs.cdp.coinbase.com/api-reference/advanced-trade-api/websocket/futures-balance-summary.md): Authenticated. Sends updates on all of a user's US futures balances, including subsequent updates. No products required. ### Global Derivatives - REST / WS (Soon) #### Block RFQ - [private/accept_block_rfq](https://docs.cdp.coinbase.com/api-reference/block-rfq/private-accept_block_rfq.md): **Taker method** - [private/add_block_rfq_quote](https://docs.cdp.coinbase.com/api-reference/block-rfq/private-add_block_rfq_quote.md): **Maker method** - [private/cancel_all_block_rfq_quotes](https://docs.cdp.coinbase.com/api-reference/block-rfq/private-cancel_all_block_rfq_quotes.md): **Maker method** - [private/cancel_block_rfq](https://docs.cdp.coinbase.com/api-reference/block-rfq/private-cancel_block_rfq.md): **Taker method** - [private/cancel_block_rfq_quote](https://docs.cdp.coinbase.com/api-reference/block-rfq/private-cancel_block_rfq_quote.md): **Maker method** - [private/cancel_block_rfq_trigger](https://docs.cdp.coinbase.com/api-reference/block-rfq/private-cancel_block_rfq_trigger.md): **Taker method** - [private/create_block_rfq](https://docs.cdp.coinbase.com/api-reference/block-rfq/private-create_block_rfq.md): **Taker method** - [private/edit_block_rfq_quote](https://docs.cdp.coinbase.com/api-reference/block-rfq/private-edit_block_rfq_quote.md): **Maker method** - [private/get_block_rfq_makers](https://docs.cdp.coinbase.com/api-reference/block-rfq/private-get_block_rfq_makers.md): Returns a list of all available Block RFQ makers. This method takes no parameters. - [private/get_block_rfq_quotes](https://docs.cdp.coinbase.com/api-reference/block-rfq/private-get_block_rfq_quotes.md): **Maker method** - [private/get_block_rfq_user_info](https://docs.cdp.coinbase.com/api-reference/block-rfq/private-get_block_rfq_user_info.md): Returns identity and rating information for the requesting account and its subaccounts. Includes both group-level and individual user-level alias data, if available. - [private/get_block_rfqs](https://docs.cdp.coinbase.com/api-reference/block-rfq/private-get_block_rfqs.md): Returns a list of Block RFQs that were either created by the user or assigned to them as a maker, sorted in descending order. - [public/get_block_rfq_trades](https://docs.cdp.coinbase.com/api-reference/block-rfq/public-get_block_rfq_trades.md): Returns a list of recent Block RFQ trades. Can be optionally filtered by currency. #### Block Trade - [private/approve_block_trade](https://docs.cdp.coinbase.com/api-reference/block-trade/private-approve_block_trade.md): Approves a pending block trade. `nonce` and `timestamp` are used to identify the block trade while `role` should be opposite to the trading counterparty. - [private/execute_block_trade](https://docs.cdp.coinbase.com/api-reference/block-trade/private-execute_block_trade.md): Executes a block trade. This is the second step in the block trade workflow - the second party calls this method with the signature received from the first party to execute the trade. - [private/get_block_trade](https://docs.cdp.coinbase.com/api-reference/block-trade/private-get_block_trade.md): Returns information about a specific block trade identified by `block_trade_id`. - [private/get_block_trade_requests](https://docs.cdp.coinbase.com/api-reference/block-trade/private-get_block_trade_requests.md): Provides a list of block trade requests including pending approvals, declined trades, and expired trades. `timestamp` and `nonce` received in response can be used with [private/approve_block_trade](https://docs.deribit.com/api-reference/block-trade/private-approve_block_trade) or [private/reject_blo… - [private/get_block_trades](https://docs.cdp.coinbase.com/api-reference/block-trade/private-get_block_trades.md): Returns a list of the user's block trades. If currency is not provided, returns block trades for all currencies. `block_rfq_id` can be provided to receive block trades related to that particular Block RFQ. - [private/get_broker_trade_requests](https://docs.cdp.coinbase.com/api-reference/block-trade/private-get_broker_trade_requests.md): **Broker Method** Provides a list of broker block trade requests including pending approvals, declined trades, and expired trades. `timestamp` and `nonce` received in response can be used to approve or reject the pending broker block trade. This method takes no parameters. - [private/get_broker_trades](https://docs.cdp.coinbase.com/api-reference/block-trade/private-get_broker_trades.md): **Broker Method** Returns list of broker block trades. If currency is not provided, returns broker block trades for all currencies. - [private/invalidate_block_trade_signature](https://docs.cdp.coinbase.com/api-reference/block-trade/private-invalidate_block_trade_signature.md): Invalidates a block trade signature, effectively cancelling the block trade. This can be called at any time before [private/execute_block_trade](https://docs.deribit.com/api-reference/block-trade/private-execute_block_trade) is called. - [private/reject_block_trade](https://docs.cdp.coinbase.com/api-reference/block-trade/private-reject_block_trade.md): Rejects a pending block trade. `nonce` and `timestamp` are used to identify the block trade while `role` should be opposite to the trading counterparty. - [private/simulate_block_trade](https://docs.cdp.coinbase.com/api-reference/block-trade/private-simulate_block_trade.md): Checks if a block trade can be executed without actually executing it. Use this method to verify that a block trade will succeed before proceeding with the actual execution. - [private/verify_block_trade](https://docs.cdp.coinbase.com/api-reference/block-trade/private-verify_block_trade.md): Verifies and creates a block trade signature. This is the first step in the block trade workflow - the first party calls this method to generate a signature that must be shared with the second party. #### Trading - [private/buy](https://docs.cdp.coinbase.com/api-reference/trading/private-buy.md): Places a buy order for an instrument. Supports various order types including limit, market, stop, and advanced order types (stop-limit, take-profit, take-profit-limit, trailing-stop, etc.). - [private/cancel](https://docs.cdp.coinbase.com/api-reference/trading/private-cancel.md): Cancels a specific order identified by its order ID. The order must be open (not yet filled or cancelled) to be cancelled successfully. - [private/cancel_all](https://docs.cdp.coinbase.com/api-reference/trading/private-cancel_all.md): Cancels all open orders and trigger orders for the authenticated account across all currencies and instrument kinds. This is a bulk cancellation operation useful for quickly clearing all active orders. - [private/cancel_all_by_currency](https://docs.cdp.coinbase.com/api-reference/trading/private-cancel_all_by_currency.md): Cancels all open orders for a specific currency. This is useful for quickly clearing all orders across multiple instruments in a currency. - [private/cancel_all_by_currency_pair](https://docs.cdp.coinbase.com/api-reference/trading/private-cancel_all_by_currency_pair.md): Cancels all open orders for a specific currency pair. This is useful for quickly clearing all orders across instruments in a currency pair. - [private/cancel_all_by_instrument](https://docs.cdp.coinbase.com/api-reference/trading/private-cancel_all_by_instrument.md): Cancels all open orders for a specific instrument. This is useful for quickly clearing all orders for a single instrument. - [private/cancel_all_by_kind_or_type](https://docs.cdp.coinbase.com/api-reference/trading/private-cancel_all_by_kind_or_type.md): Cancels all open orders in one or more currencies, optionally filtered by instrument kind and/or order type. This provides flexible bulk cancellation across multiple currencies. - [private/cancel_by_label](https://docs.cdp.coinbase.com/api-reference/trading/private-cancel_by_label.md): Cancels all orders (including trigger orders) that have a specific label. This is useful for managing groups of related orders that share the same label. - [private/close_position](https://docs.cdp.coinbase.com/api-reference/trading/private-close_position.md): Places a reduce-only order to close an existing position. Reduce-only orders can only reduce or close a position; they cannot open a new position or increase an existing one. - [private/edit](https://docs.cdp.coinbase.com/api-reference/trading/private-edit.md): Modifies an existing order by changing its price, amount, and/or other properties such as time-in-force, post-only, reduce-only, trigger conditions, or advanced order type. - [private/edit_by_label](https://docs.cdp.coinbase.com/api-reference/trading/private-edit_by_label.md): Modifies an order identified by its label. This method works only when there is exactly one open order with the specified label. - [private/get_margins](https://docs.cdp.coinbase.com/api-reference/trading/private-get_margins.md): Calculates margin requirements for a hypothetical order on a given instrument. Returns initial margin and maintenance margin for the specified instrument, quantity, and price. - [private/get_open_orders](https://docs.cdp.coinbase.com/api-reference/trading/private-get_open_orders.md): Retrieves a list of all open orders for the authenticated account across all currencies. Open orders are orders that have been placed but not yet filled or cancelled. - [private/get_open_orders_by_currency](https://docs.cdp.coinbase.com/api-reference/trading/private-get_open_orders_by_currency.md): Retrieves a list of all open orders for a specific currency. Open orders are orders that have been placed but not yet filled or cancelled. - [private/get_open_orders_by_instrument](https://docs.cdp.coinbase.com/api-reference/trading/private-get_open_orders_by_instrument.md): Retrieves a list of all open orders for a specific instrument. Open orders are orders that have been placed but not yet filled or cancelled. - [private/get_open_orders_by_label](https://docs.cdp.coinbase.com/api-reference/trading/private-get_open_orders_by_label.md): Retrieves a list of all open orders that have a specific label within a given currency. This is useful for tracking and managing groups of related orders that share the same label. - [private/get_order_history_by_currency](https://docs.cdp.coinbase.com/api-reference/trading/private-get_order_history_by_currency.md): Retrieves the order history for a specific currency. The history includes orders that have been partially or fully filled, as well as cancelled orders (if `include_unfilled_orders` is set to true). - [private/get_order_history_by_instrument](https://docs.cdp.coinbase.com/api-reference/trading/private-get_order_history_by_instrument.md): Retrieves the order history for a specific instrument. The history includes orders that have been partially or fully filled, as well as cancelled orders (if `include_unfilled_orders` is set to true). - [private/get_order_margin_by_ids](https://docs.cdp.coinbase.com/api-reference/trading/private-get_order_margin_by_ids.md): Retrieves the initial margin requirements for one or more orders identified by their order IDs. Initial margin is the amount of funds required to open a position with these orders. - [private/get_order_state](https://docs.cdp.coinbase.com/api-reference/trading/private-get_order_state.md): Retrieves the current state of an order identified by its order ID. The response includes order details such as status (open, filled, cancelled), filled amount, remaining amount, price, and other order properties. - [private/get_order_state_by_label](https://docs.cdp.coinbase.com/api-reference/trading/private-get_order_state_by_label.md): Retrieves the state of recent orders that have a specific label. This is useful for tracking orders that share the same label, which is helpful for managing related orders. - [private/get_settlement_history_by_currency](https://docs.cdp.coinbase.com/api-reference/trading/private-get_settlement_history_by_currency.md): Retrieves settlement, delivery, and bankruptcy events that have affected your account for a specific currency. Settlements occur when futures or options contracts expire and are settled at the delivery price. - [private/get_settlement_history_by_instrument](https://docs.cdp.coinbase.com/api-reference/trading/private-get_settlement_history_by_instrument.md): Retrieves settlement, delivery, and bankruptcy events for a specific instrument that have affected your account. Settlements occur when futures or options contracts expire and are settled at the delivery price. - [private/get_trigger_order_history](https://docs.cdp.coinbase.com/api-reference/trading/private-get_trigger_order_history.md): Retrieves a detailed log of all trigger orders (stop orders, take-profit orders, etc.) for the authenticated account. The log includes trigger order creation, activation, execution, and cancellation events. - [private/get_user_trades_by_currency](https://docs.cdp.coinbase.com/api-reference/trading/private-get_user_trades_by_currency.md): Retrieves the latest user trades that have occurred for instruments in a specific currency. Returns trade details including price, amount, direction, timestamp, trade ID, and order ID for all instruments in the currency. - [private/get_user_trades_by_currency_and_time](https://docs.cdp.coinbase.com/api-reference/trading/private-get_user_trades_by_currency_and_time.md): Retrieves the latest user trades that have occurred for instruments in a specific currency within a specified time range. Returns trade details including price, amount, direction, timestamp, trade ID, and order ID for all instruments in the currency. - [private/get_user_trades_by_instrument](https://docs.cdp.coinbase.com/api-reference/trading/private-get_user_trades_by_instrument.md): Retrieves the latest user trades that have occurred for a specific instrument. Returns trade details including price, amount, direction, timestamp, trade ID, and order ID. - [private/get_user_trades_by_instrument_and_time](https://docs.cdp.coinbase.com/api-reference/trading/private-get_user_trades_by_instrument_and_time.md): Retrieves the latest user trades that have occurred for a specific instrument within a specified time range. Returns trade details including price, amount, direction, timestamp, trade ID, and order ID. - [private/get_user_trades_by_order](https://docs.cdp.coinbase.com/api-reference/trading/private-get_user_trades_by_order.md): Retrieves all trades that were executed from a specific order. When an order is filled, it may result in multiple trades (partial fills). This method returns all trades associated with a given order ID. - [private/sell](https://docs.cdp.coinbase.com/api-reference/trading/private-sell.md): Places a sell order for an instrument. Supports various order types including limit, market, stop, and advanced order types (stop-limit, take-profit, take-profit-limit, trailing-stop, etc.). #### Account Management - [private/change_margin_model](https://docs.cdp.coinbase.com/api-reference/account-management/private-change_margin_model.md): Changes the margin model for the authenticated account or a specified subaccount. Margin models determine how margin requirements are calculated (e.g., Standard Margin vs. Portfolio Margin). - [private/get_access_log](https://docs.cdp.coinbase.com/api-reference/account-management/private-get_access_log.md): Retrieves a log of API access attempts and authentication events for the authenticated account. The log includes information such as IP addresses, timestamps, API methods called, and authentication status. - [private/get_account_summaries](https://docs.cdp.coinbase.com/api-reference/account-management/private-get_account_summaries.md): Retrieves a per-currency list of account summaries for the authenticated user. Each summary includes balance, equity, available funds, and margin information for each currency. - [private/get_account_summary](https://docs.cdp.coinbase.com/api-reference/account-management/private-get_account_summary.md): Retrieves the account summary for a specific currency. The summary includes balance, equity, available funds, initial margin, maintenance margin, and other margin-related information. - [private/get_position](https://docs.cdp.coinbase.com/api-reference/account-management/private-get_position.md): Retrieves the open position for a specific instrument. Returns detailed position information including size, average entry price, mark price, unrealized P&L, initial margin, maintenance margin, and other position-related metrics. - [private/get_positions](https://docs.cdp.coinbase.com/api-reference/account-management/private-get_positions.md): Retrieves all open positions for the authenticated account. Returns position details including size, average entry price, mark price, unrealized P&L, initial margin, maintenance margin, and other position-related information. - [private/get_transaction_log](https://docs.cdp.coinbase.com/api-reference/account-management/private-get_transaction_log.md): Retrieves a detailed transaction log for the authenticated account. The log includes all account activities such as trades, deposits, withdrawals, transfers, fees, and other balance-affecting operations. - [private/pme/simulate](https://docs.cdp.coinbase.com/api-reference/account-management/private-simulate.md): Calculates the Extended Risk Matrix (ERM) and detailed margin information for Portfolio Margin accounts. The ERM provides a comprehensive view of portfolio risk across different scenarios and market conditions. - [private/simulate_portfolio](https://docs.cdp.coinbase.com/api-reference/account-management/private-simulate_portfolio.md): Calculates portfolio margin requirements and risk metrics for simulated positions or the current portfolio. This method helps you understand margin requirements before opening new positions or assess the impact of potential trades. - [public/get_announcements](https://docs.cdp.coinbase.com/api-reference/account-management/public-get_announcements.md): Retrieves platform announcements and important notices. Announcements include system updates, maintenance schedules, new features, policy changes, and other important information. #### Combo Books - [private/create_combo](https://docs.cdp.coinbase.com/api-reference/combo-books/private-create_combo.md): Verifies and creates a combo book or returns an existing combo matching the given trades. Combos allow trading on multiple instruments (futures and options) simultaneously as a single strategy. - [private/get_leg_prices](https://docs.cdp.coinbase.com/api-reference/combo-books/private-get_leg_prices.md): Returns individual leg prices for a given combo structure based on an aggregated price of the strategy and the mark prices of the individual legs. - [public/get_combo_details](https://docs.cdp.coinbase.com/api-reference/combo-books/public-get_combo_details.md): Retrieves detailed information about a specific combo, including its leg structure, state, and other properties. - [public/get_combo_ids](https://docs.cdp.coinbase.com/api-reference/combo-books/public-get_combo_ids.md): Retrieves available combo IDs. This method can be used to get the list of all combos, or only the list of combos in the given state. - [public/get_combos](https://docs.cdp.coinbase.com/api-reference/combo-books/public-get_combos.md): Retrieves information about active combos for the specified currency. Returns detailed information including leg structures and combo properties. #### Session Management - [private/disable_cancel_on_disconnect](https://docs.cdp.coinbase.com/api-reference/session-management/private-disable_cancel_on_disconnect.md): Disable Cancel On Disconnect for the connection. - [private/enable_cancel_on_disconnect](https://docs.cdp.coinbase.com/api-reference/session-management/private-enable_cancel_on_disconnect.md): Enable Cancel On Disconnect for the connection. After enabling, all orders created via this connection will be automatically cancelled when the connection is closed. - [private/get_cancel_on_disconnect](https://docs.cdp.coinbase.com/api-reference/session-management/private-get_cancel_on_disconnect.md): Read current Cancel On Disconnect configuration for the account. - [public/disable_heartbeat](https://docs.cdp.coinbase.com/api-reference/session-management/public-disable_heartbeat.md): Stop sending heartbeat messages. This method takes no parameters. - [public/set_heartbeat](https://docs.cdp.coinbase.com/api-reference/session-management/public-set_heartbeat.md): Signals the WebSocket connection to send and request heartbeats. Heartbeats can be used to detect stale connections. #### Authentication - [private/logout](https://docs.cdp.coinbase.com/api-reference/authentication/private-logout.md): Gracefully terminate the current WebSocket connection and optionally invalidate all tokens associated with the session. - [public/auth](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/rest-api/authentication/post-publicauth.md): Authenticate using a Coinbase-issued credential. #### Subscription Management - [private/subscribe](https://docs.cdp.coinbase.com/api-reference/subscription-management/private-subscribe.md): Subscribe to one or more channels. The name of the channel determines what information will be provided, and in what form. - [private/unsubscribe](https://docs.cdp.coinbase.com/api-reference/subscription-management/private-unsubscribe.md): Unsubscribe from one or more channels. The response contains only the channels that were successfully unsubscribed in this request. - [private/unsubscribe_all](https://docs.cdp.coinbase.com/api-reference/subscription-management/private-unsubscribe_all.md): Unsubscribe from all the channels subscribed so far. This method takes no parameters. - [public/subscribe](https://docs.cdp.coinbase.com/api-reference/subscription-management/public-subscribe.md): Subscribe to one or more channels. This is the same method as `/private/subscribe`, but it can only be used for 'public' channels. - [public/unsubscribe](https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe.md): Unsubscribe from one or more channels. The response contains only the channels that were successfully unsubscribed in this request. - [public/unsubscribe_all](https://docs.cdp.coinbase.com/api-reference/subscription-management/public-unsubscribe_all.md): Unsubscribe from all the channels subscribed so far. This method takes no parameters. #### Market Data - [public/get_book_summary_by_currency](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_book_summary_by_currency.md): Retrieves summary information such as open interest, 24-hour volume, best bid/ask prices, last trade price, and other market statistics for all instruments in a given currency. - [public/get_book_summary_by_instrument](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_book_summary_by_instrument.md): Retrieves summary information such as open interest, 24-hour volume, best bid/ask prices, last trade price, mark price, and other market statistics for a specific instrument. - [public/get_contract_size](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_contract_size.md): Retrieves the contract size (also known as contract multiplier) for a given instrument. The contract size determines how many units of the underlying asset one contract represents. - [public/get_currencies](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_currencies.md): Retrieves all cryptocurrencies supported by the Deribit API. Returns a list of available currencies with their codes and basic information. - [public/get_delivery_prices](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_delivery_prices.md): Retrieves historical delivery prices for a given index. Delivery prices are the settlement prices used when futures or options contracts expire and are settled. - [public/get_expirations](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_expirations.md): Retrieves all available expiration timestamps for instruments. This method can be used to discover which expiration dates are available for trading, which is useful for finding instruments with specific expiration dates. - [public/get_funding_chart_data](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_funding_chart_data.md): Retrieves funding rate chart data points for a PERPETUAL instrument within a given time period. The data is formatted for use in charting applications and includes funding rate values at regular intervals. - [public/get_funding_rate_history](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_funding_rate_history.md): Retrieves hourly historical funding rate (interest rate) data for a PERPETUAL instrument over a specified time period. Funding rates are periodic payments exchanged between long and short positions in perpetual contracts. - [public/get_funding_rate_value](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_funding_rate_value.md): Retrieves the funding rate (interest rate) value for a perpetual instrument over a specified time period. Funding rates are periodic payments exchanged between long and short positions in perpetual contracts. - [public/get_historical_volatility](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_historical_volatility.md): Provides historical volatility data for a given cryptocurrency. Historical volatility measures the degree of price variation over a past period and is useful for risk assessment and option pricing. - [public/get_index_chart_data](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_index_chart_data.md): Returns historical price index chart data for the specified index name and time range. The data is formatted for use in charting applications and shows price index values over time. - [public/get_index_price](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_index_price.md): Retrieves the current index price value for a given index name. Index prices are used as reference prices for mark price calculations and settlement. - [public/get_index_price_names](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_index_price_names.md): Retrieves the identifiers (names) of all supported price indexes. Price indexes are reference prices used for mark price calculations, settlement, and other market operations. - [public/get_instrument](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_instrument.md): Retrieves detailed information about a specific instrument, including instrument specifications, contract details, tick size, settlement currency, expiration date (for futures and options), strike price (for options), and other instrument parameters. - [public/get_instruments](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_instruments.md): Retrieves available trading instruments. This method can be used to see which instruments are available for trading, or which instruments have recently expired. - [public/get_last_settlements_by_currency](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_last_settlements_by_currency.md): Retrieves historical settlement, delivery, and bankruptcy events from all instruments within a given currency. Settlements occur when futures or options contracts expire and are settled at the delivery price. - [public/get_last_settlements_by_instrument](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_last_settlements_by_instrument.md): Retrieves historical settlement, delivery, and bankruptcy events for a specific instrument. Settlements occur when futures or options contracts expire and are settled at the delivery price. - [public/get_last_trades_by_currency](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_last_trades_by_currency.md): Retrieves the latest trades that have occurred for instruments in a specific currency. Returns trade details including price, amount, direction, timestamp, and trade ID for all instruments in the currency. - [public/get_last_trades_by_currency_and_time](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_last_trades_by_currency_and_time.md): Retrieves the latest trades that have occurred for instruments in a specific currency within a specified time range. Returns trade details including price, amount, direction, timestamp, and trade ID. - [public/get_last_trades_by_instrument](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_last_trades_by_instrument.md): Retrieves the latest trades that have occurred for a specific instrument. Returns trade details including price, amount, direction, timestamp, and trade ID. - [public/get_last_trades_by_instrument_and_time](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_last_trades_by_instrument_and_time.md): Retrieves the latest trades that have occurred for a specific instrument within a specified time range. Returns trade details including price, amount, direction, timestamp, and trade ID. - [public/get_mark_price_history](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_mark_price_history.md): Retrieves 5-minute historical mark price data for an instrument. Mark prices are used for margin calculations and position valuations. - [public/get_order_book](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_order_book.md): Retrieves the order book (bids and asks) for a given instrument, along with other market values such as best bid/ask prices, last trade price, mark price, and index price. - [public/get_order_book_by_instrument_id](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_order_book_by_instrument_id.md): Retrieves the order book (bids and asks) for a given instrument ID, along with other market values such as best bid/ask prices, last trade price, mark price, and index price. - [public/get_supported_index_names](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_supported_index_names.md): Retrieves the identifiers (names) of all supported price indexes, optionally filtered by index type. Price indexes are reference prices used for mark price calculations, settlement, and other market operations. - [public/get_trade_volumes](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_trade_volumes.md): Retrieves aggregated 24-hour trade volumes for different instrument types and currencies. The volume statistics include all executed trades across the platform. - [public/get_tradingview_chart_data](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_tradingview_chart_data.md): Retrieves publicly available market data formatted for generating TradingView-compatible candle charts. The data includes open, high, low, close (OHLC) prices and volume for specified time intervals. - [public/get_volatility_index_data](https://docs.cdp.coinbase.com/api-reference/market-data/public-get_volatility_index_data.md): Retrieves volatility index (VIX) chart data formatted as candles. Volatility indexes measure market expectations of future volatility and are useful for risk assessment and trading strategies. - [public/ticker](https://docs.cdp.coinbase.com/api-reference/market-data/public-ticker.md): Retrieves the ticker (24-hour statistics) for a specific instrument. The ticker includes the last trade price, best bid/ask prices, 24-hour high/low, 24-hour volume, open interest, mark price, and other market statistics. #### Supporting - [public/get_time](https://docs.cdp.coinbase.com/api-reference/supporting/public-get_time.md): Retrieves the current time (in milliseconds). This API endpoint can be used to check the clock skew between your software and Deribit's systems. - [public/hello](https://docs.cdp.coinbase.com/api-reference/supporting/public-hello.md): Method used to introduce the client software connected to Deribit platform over websocket. Provided data may have an impact on the maintained connection and will be collected for internal statistical purposes. In response, Deribit will also introduce itself. - [public/status](https://docs.cdp.coinbase.com/api-reference/supporting/public-status.md): Method used to get information about locked currencies - [public/test](https://docs.cdp.coinbase.com/api-reference/supporting/public-test.md): Tests the connection to the API server, and returns its version. You can use this to make sure the API is reachable, and matches the expected version. ### Global Derivatives - WS Streams (Soon) #### Announcements - [announcements ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/announcements/announcements.md): General announcements concerning the Deribit platform. #### Block Rfq - [block_rfq.maker.(currency) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/block-rfq/block_rfqmakercurrency.md): Real-time notifications for Block RFQs (Request for Quotes) that are available for the subscribed maker to respond to. - [block_rfq.maker.quotes.(currency) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/block-rfq/block_rfqmakerquotescurrency.md): Get notifications about the state of your Block RFQ quotes. Subscribe to this channel to receive real-time updates when your quotes are added, edited, cancelled, or when quotes are accepted by takers. - [block_rfq.taker.(currency) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/block-rfq/block_rfqtakercurrency.md): Get notifications about the state of your Block RFQ. `trades` are only visible if the Block RFQ was filled. - [block_rfq.trades.(currency) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/block-rfq/block_rfqtradescurrency.md): Get notifications about recent Block RFQ trades. This is a public channel that provides market data about completed Block RFQ trades. #### Block Trade - [block_trade_confirmations ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/block-trade/block_trade_confirmations.md): Provides notifications regarding block trade approval. Subscribe to this channel to receive notifications about pending block trades that require your approval. - [block_trade_confirmations.(currency) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/block-trade/block_trade_confirmationscurrency.md): Provides notifications regarding block trade approval. Supports filtering by currency. Subscribe to this channel to receive notifications about pending block trades that require your approval, filtered by a specific currency. #### Orderbook - [book.(instrument_name).(group).(depth).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/orderbook/bookinstrument_namegroupdepthinterval.md): Aggregated order book updates for a specific instrument. - [book.(instrument_name).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/orderbook/bookinstrument_nameinterval.md): Real-time order book updates for a specific instrument. #### Market Data - [chart.trades.(instrument_name).(resolution) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/charttradesinstrument_nameresolution.md): Publicly available market data used to generate a TradingView trade candle chart. - [deribit_price_index.(index_name) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/deribit_price_indexindex_name.md): Deribit index price updates for the given `index_name` (current index value). - [deribit_price_ranking.(index_name) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/deribit_price_rankingindex_name.md): Price ranking updates for the component exchanges used to calculate the Deribit index. - [deribit_price_statistics.(index_name) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/deribit_price_statisticsindex_name.md): Basic statistics for the Deribit index. - [deribit_volatility_index.(index_name) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/deribit_volatility_indexindex_name.md): Volatility index updates for the given `index_name`. - [estimated_expiration_price.(index_name) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/estimated_expiration_priceindex_name.md): Estimated expiration (delivery) price updates for the given `index_name`. - [incremental_ticker.(instrument_name) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/incremental_tickerinstrument_name.md): Real-time ticker updates for an instrument, delivered as a snapshot followed by incremental updates. - [instrument.state.(kind).(currency) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/instrumentstatekindcurrency.md): Notifications about new or terminated instruments of a given kind in a given currency. - [markprice.options.(index_name) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/markpriceoptionsindex_name.md): Options mark price updates for the given `index_name`. - [perpetual.(instrument_name).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/perpetualinstrument_nameinterval.md): Provide current interest rate - but only for **perpetual** instruments. Other types won't generate any notification. - [quote.(instrument_name) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/quoteinstrument_name.md): Best bid/ask price and size for a specific instrument. - [ticker.(instrument_name).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/market-data/tickerinstrument_nameinterval.md): Real-time ticker data providing comprehensive market information for the specified instrument. #### Platform - [platform_state ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/platform/platform_state.md): Platform state notifications. - [platform_state.public_methods_state ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/platform/platform_statepublic_methods_state.md): Notifications indicating whether unauthenticated (public) requests are currently allowed. #### Trades - [trades.(instrument_name).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/trades/tradesinstrument_nameinterval.md): Trade notifications for a specific instrument. - [trades.(kind).(currency).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/trades/tradeskindcurrencyinterval.md): Trade notifications across all instruments for a given kind and currency. #### User - [user.access_log ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/useraccess_log.md): Security event notifications for the account. - [user.changes.(instrument_name).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/userchangesinstrument_nameinterval.md): User change stream (orders, trades, and related updates) for a specific instrument. - [user.changes.(kind).(currency).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/userchangeskindcurrencyinterval.md): User change stream (orders, trades, and related updates) across all instruments for a given kind and currency. - [user.combo_trades.(instrument_name).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/usercombo_tradesinstrument_nameinterval.md): User trade notifications for a specific combo instrument. - [user.combo_trades.(kind).(currency).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/usercombo_tradeskindcurrencyinterval.md): User trade notifications across all combo instruments for a given kind and currency. - [user.orders.(instrument_name).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/userordersinstrument_nameinterval.md): User order updates for a specific instrument (aggregated). - [user.orders.(instrument_name).raw ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/userordersinstrument_nameraw.md): User order updates for a specific instrument (raw stream). - [user.orders.(kind).(currency).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/userorderskindcurrencyinterval.md): User order updates across all instruments for a given kind and currency (aggregated). - [user.orders.(kind).(currency).raw ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/userorderskindcurrencyraw.md): User order updates across all instruments for a given kind and currency (raw stream). - [user.portfolio.(currency) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/userportfoliocurrency.md): Real-time notifications for user portfolio information. This subscription provides comprehensive account and portfolio data for the specified currency, including balances, margins, profit and loss, and Greeks. - [user.trades.(instrument_name).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/usertradesinstrument_nameinterval.md): User trade notifications for a specific instrument. - [user.trades.(kind).(currency).(interval) ](https://docs.cdp.coinbase.com/api-reference/coinbase-deribit-app-api/websocket/user/usertradeskindcurrencyinterval.md): User trade notifications across all instruments for a given kind and currency. ## OpenAPI Specs - [adv-starbase-openapi](/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json) ## AsyncAPI Specs - [advanced-trade-asyncapi](/api-reference/advanced-trade-api/advanced-trade-asyncapi.json) - [adv-starbase-asyncapi](/api-reference/coinbase-deribit-app-api/adv-starbase-asyncapi.json)