# Coinbase Developer Documentation: API Reference ## API Reference - [API Reference / CDP API (234 pages)](https://docs.cdp.coinbase.com/_llms/api-reference/cdp-api.md): Documentation for API Reference / CDP API. - [API Reference / Coinbase Advanced Trade API (213 pages)](https://docs.cdp.coinbase.com/_llms/api-reference/coinbase-advanced-trade-api.md): Documentation for API Reference / Coinbase Advanced Trade API. - [API Reference / Coinbase Exchange API (109 pages)](https://docs.cdp.coinbase.com/_llms/api-reference/coinbase-exchange-api.md): Documentation for API Reference / Coinbase Exchange API. - [API Reference / Coinbase Prime API (136 pages)](https://docs.cdp.coinbase.com/_llms/api-reference/coinbase-prime-api.md): Documentation for API Reference / Coinbase Prime API. ### Coinbase Business API #### REST API - [Welcome to Coinbase Business API](https://docs.cdp.coinbase.com/api-reference/business-api/rest-api/introduction.md) ##### Checkouts - [Checkouts API Reference](https://docs.cdp.coinbase.com/api-reference/business-api/rest-api/checkouts/introduction.md) - [Create Checkout](https://docs.cdp.coinbase.com/api-reference/business-api/rest-api/checkouts/create-checkout.md): Creates a new checkout. Returns a payment URL to redirect your customer to. Each checkout is single-use. - [List Checkouts](https://docs.cdp.coinbase.com/api-reference/business-api/rest-api/checkouts/list-checkouts.md): Retrieves a paginated list of checkouts. - [Get Checkout](https://docs.cdp.coinbase.com/api-reference/business-api/rest-api/checkouts/get-checkout.md): Retrieves details of a specific checkout by ID. - [Deactivate Checkout](https://docs.cdp.coinbase.com/api-reference/business-api/rest-api/checkouts/deactivate-checkout.md): Deactivates a checkout, preventing it from accepting further payments. Only `ACTIVE` checkouts can be deactivated. - [Refund Checkout](https://docs.cdp.coinbase.com/api-reference/business-api/rest-api/checkouts/refund-checkout.md): Initiates a refund for a completed checkout. Only `COMPLETED` or `PARTIALLY_REFUNDED` checkouts can be refunded. ##### Invoicing - [Invoicing API Reference](https://docs.cdp.coinbase.com/api-reference/business-api/rest-api/invoicing/introduction.md) - [List Invoices](https://docs.cdp.coinbase.com/api-reference/business-api/rest-api/invoicing/list-invoices.md): Retrieves a paginated list of invoices for the authenticated user's entity. - [Get Invoice](https://docs.cdp.coinbase.com/api-reference/business-api/rest-api/invoicing/get-invoice.md): Retrieves details of a specific invoice by UUID. ##### Advanced Trade APIs - [API Reference](https://docs.cdp.coinbase.com/coinbase-business/advanced-trade-apis/api-reference.md) ##### Transfer APIs - [Send Crypto](https://docs.cdp.coinbase.com/coinbase-business/transfer-apis/send-crypto.md) - [Onchain Addresses](https://docs.cdp.coinbase.com/coinbase-business/transfer-apis/onchain-addresses.md) - [Fiat Deposits](https://docs.cdp.coinbase.com/coinbase-business/transfer-apis/deposit-fiat.md) - [Fiat Withdrawals](https://docs.cdp.coinbase.com/coinbase-business/transfer-apis/withdraw-fiat.md) - [Travel Rule Fields for Crypto Sends Guide](https://docs.cdp.coinbase.com/coinbase-business/transfer-apis/travel-rule.md) - [Supported Virtual Asset Service Provider (VASP) Tables](https://docs.cdp.coinbase.com/coinbase-business/transfer-apis/vasps.md) ##### Track APIs - [Accounts](https://docs.cdp.coinbase.com/coinbase-business/track-apis/accounts.md) - [Transactions](https://docs.cdp.coinbase.com/coinbase-business/track-apis/transactions.md) - [Data API - Currencies](https://docs.cdp.coinbase.com/coinbase-business/track-apis/currencies.md) - [Data API- Exchange Rates](https://docs.cdp.coinbase.com/coinbase-business/track-apis/exchange-rates.md) - [Data API- Prices](https://docs.cdp.coinbase.com/coinbase-business/track-apis/prices.md) - [Data API- Time](https://docs.cdp.coinbase.com/coinbase-business/track-apis/time.md) ### Coinbase International Exchange API #### REST API - [Welcome to Coinbase INTX API](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/introduction.md) - [INTX REST API Authentication](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/authentication.md) ##### Address Book - [Get address book](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/address-book/get-address-book.md): Returns all eligible recipients for withdrawal. ##### Assets - [Get asset details](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/assets/get-asset-details.md): Retrieves information for a specific asset. - [Get supported networks per asset](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/assets/get-supported-networks.md): Returns a list of supported networks and network information for a specific asset. - [List assets](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/assets/list-assets.md): Returns a list of all supported assets. ##### Fee Rates - [List fee rate tiers](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/fee-rates/list-fee-rate-tiers.md): Return all the fee rate tiers. ##### Index - [Get index candles](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/index/get-index-candles.md): Retrieves the historical daily index prices in time descending order. The daily values are represented as aggregated entries for the day in typical OHLC format. - [Get index composition](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/index/get-index-composition.md): Retrieves the latest index composition (metadata) with an ordered set of constituents. - [Get index composition history](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/index/get-index-composition-history.md): Retrieves a history of index composition records in a descending time order. The results are an array of index composition data recorded at different "timestamps". - [Get index price](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/index/get-index-price.md): Retrieves the latest index price ##### Instruments - [Get aggregated candles data per instrument](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/instruments/get-aggegated-candles.md): Retrieves a list of aggregated candles data for a given instrument, granularity and time range - [Get daily trading volumes](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/instruments/get-daily-trading-volume.md): Retrieves the trading volumes for each instrument separated by day. - [Get historical funding rates](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/instruments/get-historical-funding-rate.md): Retrieves the historical funding rates for a specific instrument. - [Get instrument details](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/instruments/get-instrument-details.md): Retrieves market information for a specific instrument. - [Get quote per instrument](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/instruments/get-quote-per-instrument.md): Retrieves the current quote for a specific instrument. - [List instruments](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/instruments/list-instruments.md): Returns all of the instruments available for trading. ##### Orders - [Cancel order](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/orders/cancel-order.md): Cancels a single open order. - [Cancel orders](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/orders/cancel-orders.md): Cancels all orders matching the requested criteria. - [Create order](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/orders/create-order.md): Creates a new order. - [Get order details](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/orders/get-order-details.md): Retrieves a single order. The order retrieved can be either active or inactive. - [List open orders](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/orders/list-open-orders.md): Returns 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. - [Modify open order](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/orders/modify-open-order.md): Modifies an open order. ##### Portfolios - [Acquire/repay loan](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/acquire-and-repay-loan.md): Acquire or repay loan for a given portfolio and asset. - [Create portfolio](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/create-portfolio.md): Create 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. - [Enable/Disable portfolio auto margin mode](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/enable-and-disable-portfolio.md): Enable or disable the auto margin feature, which lets the portfolio automatically post margin amounts required to exceed the high leverage position restrictions. - [Enable/Disable portfolio cross collateral](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/enable-and-disable-cross.md): Enable or disable the cross collateral feature for the portfolio, which allows the portfolio to use non-USDC assets as collateral for margin trading. - [Get balance for portfolio/asset](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/get-balance-for-assests.md): Retrieves the balance for a given portfolio and asset. - [Get fund transfer limit between portfolios](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/get-fund-transfer-limit.md): Get fund transfer limit between portfolios of the same beneficial owner - [Get loan info for portfolio/asset](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/get-loan-info-for-portfolio.md): Retrieves the loan info for a given portfolio and asset. - [Get portfolio details](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/get-portfolio-details.md): Retrieves the summary, positions, and balances of a portfolio. - [Get portfolio margin call status](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/get-portfolio-margin-call.md): Returns the margin call status for a given portfolio. - [Get portfolio summary](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/get-portfolio-summary.md): Retrieves the high level overview of a portfolio. - [Get position for portfolio/instrument](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/get-position-portfolio.md): Retrieves the position for a given portfolio and symbol. - [Get the open position limits for the portfolio instrument](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/get-the-open-position-limits.md): Retrieves the position limits for a given portfolio and symbol. - [Get the total open position limit for the portfolio](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/get-the-total-open-position-limits.md): Retrieves the total open position limit across instruments for a given portfolio. - [Get user portfolio](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/get-user-portfolio.md): Returns the user's specified portfolio. - [List active loans for the portfolio](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/list-active-loans-for-the-portfolio.md): Retrieves all loan info for a given portfolio. - [List all user portfolios](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/list-all-user-portfolios.md): Returns all of the user's portfolios. - [List fills by portfolios](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/list-fills-portfolio.md): Returns fills for specified portfolios or fills for all portfolios if none are provided. - [List portfolio balances](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/list-portfolio-balances.md): Returns all of the balances for a given portfolio. - [List portfolio fee rates](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/list-portfolio-fee-rates.md): Retrieves the Perpetual Future and Spot fee rate tiers for the user. - [List portfolio fills](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/list-portfolio-fills.md): Returns all of the fills for a given portfolio. - [List portfolio positions](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/list-portfolio-positions.md): Returns all of the positions for a given portfolio. - [List the open position limits for all instruments](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/list-open-position-limit.md): Retrieves position limits for all positions a given portfolio currently has or has opened in the past. - [Patch portfolio](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/patch-portfolio.md): Update parameters for existing portfolio - [Preview loan update](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/preview-loan-update.md): Preview acquire or repay loan for a given portfolio and asset. - [Set portfolio margin override](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/set-profile-margin.md): Specify the margin override value for a portfolio to either increase notional requirements or opt-in to higher leverage. - [Transfer funds between portfolios](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/transfer-funds.md): Transfer assets from one portfolio to another. - [Transfer positions between portfolios](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/transfer-positions.md): Transfer 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, organi… - [Update portfolio](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/update-portfolio.md): Update existing user portfolio. - [View max loan availability](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/portfolios/view-max-loan.md): View the maximum amount of loan that could be acquired now ##### Position Offsets - [List position offsets](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/position-offsets/list-position-offsets.md): Returns all active position offsets ##### Rankings - [Get your rankings](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/rankings/get-your-rankings.md): Retrieve your volume rankings for maker, taker, and total volume. ##### Transfers - [Create counterparty Id](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/transfers/create-counterparty-id.md) - [Create crypto address](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/transfers/create-crypto-address.md) - [Get counterparty withdrawal limit](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/transfers/get-counterparty-withdrawal-limit.md): Get counterparty withdrawal limit within coinbase transfer network - [Get transfer](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/transfers/get-transfer.md) - [List matching transfers](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/transfers/list-matching-transfers.md) - [Validate counterparty Id](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/transfers/validate-counterparty-id.md) - [Withdraw to counterparty Id](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/transfers/withdraw-to-counterparty-id.md) - [Withdraw to crypto address](https://docs.cdp.coinbase.com/api-reference/international-exchange-api/rest-api/transfers/withdraw-to-crypto-address.md) #### FIX API - [INTX FIX API Overview](https://docs.cdp.coinbase.com/international-exchange/fix-api/fix-api-overview.md) - [INTX FIX Dictionary Downloads](https://docs.cdp.coinbase.com/international-exchange/fix-api/dictionary-downloads.md) - [INTX FIX Common Components](https://docs.cdp.coinbase.com/international-exchange/fix-api/common-components.md) - [INTX FIX Admin Messages](https://docs.cdp.coinbase.com/international-exchange/fix-api/admin-messages.md) - [INTX FIX Order Entry Messages](https://docs.cdp.coinbase.com/international-exchange/fix-api/order-entry-messages.md) - [INTX Take Profit Stop Loss Orders](https://docs.cdp.coinbase.com/international-exchange/fix-api/tpsl-orders.md) - [INTX FIX Market Data Messages](https://docs.cdp.coinbase.com/international-exchange/fix-api/market-data.md) - [INTX FIX Drop Copy Messages](https://docs.cdp.coinbase.com/international-exchange/fix-api/drop-copy.md) #### WEBSOCKET FEED - [INTX WebSocket Overview](https://docs.cdp.coinbase.com/international-exchange/websocket-feed/websocket-overview.md) - [INTX WebSocket Authentication](https://docs.cdp.coinbase.com/international-exchange/websocket-feed/authentication.md) - [INTX WebSocket Channels](https://docs.cdp.coinbase.com/international-exchange/websocket-feed/channels.md) - [INTX WebSocket Errors](https://docs.cdp.coinbase.com/international-exchange/websocket-feed/errors.md) ### Coinbase Derivatives API #### REST API Overview - [Welcome to the Coinbase Derivatives REST API](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/introduction.md) - [Coinbase Derivatives REST API Authentication](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/authentication.md) #### REST Endpoints ##### Block Trades - [Get Block Trades](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trades/get-block-trades.md): Retrieves all block trades where user owns the reporting firm/entity. - [Get Filtered Block Trades](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trades/get-filtered-block-trades.md): Retrieves permissioned block trades matching the specified filter criteria. All filter parameters are optional and can be combined. - [Get Bookable Block Trade Accounts](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trades/get-bookable-block-trade-accounts.md): Retrieves the list of block trade accounts that the authenticated user can book trades for. - [Get Bookable Block Trade Entities](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trades/get-bookable-block-trade-entities.md): Retrieves the list of block trade entities that the authenticated user can book trades for. - [Get Bookable Block Traders](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trades/get-bookable-block-traders.md): Retrieves the list of block traders that the authenticated user can book trades for. - [Book a Block Trade](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trades/book-a-block-trade.md): Books 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… ##### Block Trade Accounts - [Get All Block Trade Account Permissions](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trade-accounts/get-all-block-trade-account-permissions.md): Retrieves a list of all block trade account permissions you have access to. - [Get Block Trade Account Permission](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trade-accounts/get-block-trade-account-permission.md): Retrieves information for a block trade account permission with the specified UUID. - [Get All Block Trade Accounts](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trade-accounts/get-all-block-trade-accounts.md): Retrieves a list of all block trade accounts you have access to. - [Get Block Trade Account](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trade-accounts/get-block-trade-account.md): Retrieves information for a block trade account with the specified UUID. - [Get All Block Trade Position Limits](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trade-accounts/get-all-block-trade-position-limits.md): Retrieves a list of all block trade position limits you have access to. - [Get Block Trade Position Limit](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trade-accounts/get-block-trade-position-limit.md): Retrieves information for a block trade position limit with the specified UUID. ##### Block Trade Entities - [Get All Block Trade Entities](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trade-entities/get-all-block-trade-entities.md): Retrieves a list of all block trade entities you have access to. - [Get Block Trade Entity](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trade-entities/get-block-trade-entity.md): Retrieves information for a block trade entity with the specified UUID. - [Get Block Trade Entities by Firm](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-trade-entities/get-block-trade-entities-by-firm.md): Retrieves the block trade entity associated with the specified firm. ##### Block Traders - [Get All Block Traders](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-traders/get-all-block-traders.md): Retrieves a list of all block traders you have access to. - [Get Block Trader](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/block-traders/get-block-trader.md): Retrieves information for a block trader with the specified UUID. ##### Firm Position Limits - [List All Position Limits](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-position-limits/list-all-position-limits.md): Retrieves position limits for all firms that the user has access to. - [Get Firm Position Limits](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-position-limits/get-firm-position-limits.md): Retrieves position limits from a specific firm. - [Update Firm Position Limits](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-position-limits/update-firm-position-limits.md): Updates position limits for a specific firm - [List All Position Limits](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-position-limits/list-all-position-limits-1.md): Retrieves position limits for all firms that the user has access to. - [Get Firm Position Limits](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-position-limits/get-firm-position-limits-1.md): Retrieves position limits from a specific firm. - [Update Firm Position Limits](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-position-limits/update-firm-position-limits-1.md): Updates position limits for a specific firm ##### Firm Product Group Limits - [Create Zero Firm Product Group Limit](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-product-group-limits/create-zero-firm-product-group-limit.md): Creates a zero position limit to a specific firm/product group that disables trading for that combination. - [Remove Firm Product Group Limit](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-product-group-limits/remove-firm-product-group-limit.md): Removes any product group level limit for a specific firm/product group combination - [Get Firm Product Group Limits](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-product-group-limits/get-firm-product-group-limits.md): Retrieves product group limits for a specific firm, including individual product limits within each group - [Create Zero Firm Product Group Limit](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-product-group-limits/create-zero-firm-product-group-limit-1.md): Creates a zero position limit to a specific firm/product group that disables trading for that combination. - [Remove Firm Product Group Limit](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-product-group-limits/remove-firm-product-group-limit-1.md): Removes any product group level limit for a specific firm/product group combination - [Get Firm Product Group Limits](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-product-group-limits/get-firm-product-group-limits-1.md): Retrieves product group limits for a specific firm, including individual product limits within each group ##### Firm Product Limits - [Create Zero Firm Product Limit](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-product-limits/create-zero-firm-product-limit.md): Creates a limit that will block the firm from trading the corresponding product. - [Remove Firm Product Limit](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-product-limits/remove-firm-product-limit.md): Removes any product level limit for a specific firm and product - [Get Firm Product Limits](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-product-limits/get-firm-product-limits.md): Gets product limits for a specific firm and optional product combination. - [Set Firm Product Limit](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-product-limits/set-firm-product-limit.md): Set position limits on a product. - [Batch Set Firm Product Limit](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-product-limits/batch-set-firm-product-limit.md): Set position limits for multiple products. - [Remove Firm Product Limit](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-product-limits/remove-firm-product-limit-1.md): Removes any product level limit for a specific firm and product - [Get Firm Product Limits](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firm-product-limits/get-firm-product-limits-1.md): Gets product limits for a specific firm and optional product combination. ##### Firms - [Get All Firms](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firms/get-all-firms.md): Retrieves a list of all firms you have access to. - [Get Firm](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/firms/get-firm.md): Retrieves information for a firm with the specified UUID. ##### Funding Rate - [Get historical funding rates](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/funding-rate/get-historical-funding-rates.md): Retrieves the historical funding rate data for a specific instrument. ##### Instruments - [Get Instrument Details](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/instruments/get-instrument-details.md): Retrieves 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. - [Get Valid Series](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/instruments/get-valid-series.md): Retrieves 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… ##### Risk - [Kill Switch](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/risk/kill-switch.md): Activates 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. - [Unlock Trading](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/risk/unlock-trading.md): Deactivates kill switch to cancel orders and unlocks trading for specified users, firms, or FCMs. Must only include one uuid (fcm, firm, or trading user). ##### Positions - [Get All Firm Positions](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/positions/get-all-firm-positions.md): Retrieves firm-level positions for all firms you have access to - [Get Firm Position](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/positions/get-firm-position.md): Retrieves positions for the specified firm - [Get All Firm Positions](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/positions/get-all-firm-positions-1.md): Retrieves firm-level positions for all firms you have access to - [Get Firm Position](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/positions/get-firm-position-1.md): Retrieves positions for the specified firm ##### Users - [Get All Users](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/users/get-all-users.md): Retrieves a list of all users you have access to, or all users in the specified firm. - [Get User](https://docs.cdp.coinbase.com/api-reference/derivatives-api/rest-api/users/get-user.md): Retrieves information for a user with the specified UUID. #### FIX - [Derivatives FIX Overview](https://docs.cdp.coinbase.com/derivatives/fix/overview.md) - [Derivatives FIX Header/Trailer Messages](https://docs.cdp.coinbase.com/derivatives/fix/header-trailer.md) - [Derivatives FIX Session Messages](https://docs.cdp.coinbase.com/derivatives/fix/session.md) - [Derivatives FIX Market Data Messages](https://docs.cdp.coinbase.com/derivatives/fix/market-data.md) - [Derivatives FIX Order Entry Messages](https://docs.cdp.coinbase.com/derivatives/fix/order-entry.md) - [Derivatives FIX Drop Copy Messages](https://docs.cdp.coinbase.com/derivatives/fix/drop-copy.md) - [Derivatives FIX Security Definitions](https://docs.cdp.coinbase.com/derivatives/fix/security-definitions.md) - [Derivatives FIX Code Sets](https://docs.cdp.coinbase.com/derivatives/fix/code-sets.md) #### SBE - [Derivatives SBE Overview](https://docs.cdp.coinbase.com/derivatives/sbe/overview.md) - [Derivatives SBE Header Message](https://docs.cdp.coinbase.com/derivatives/sbe/header.md) - [Derivatives SBE Session Messages](https://docs.cdp.coinbase.com/derivatives/sbe/session.md) - [Derivatives SBE Order Entry Messages](https://docs.cdp.coinbase.com/derivatives/sbe/order-entry.md) #### UDP - [Derivatives UDP Overview](https://docs.cdp.coinbase.com/derivatives/udp/overview.md) - [Message structure](https://docs.cdp.coinbase.com/derivatives/udp/message-structure.md) - [Derivatives UDP Realtime Incremental Updates](https://docs.cdp.coinbase.com/derivatives/udp/incrementals.md) - [Derivatives UDP Periodic Snapshots](https://docs.cdp.coinbase.com/derivatives/udp/snapshots.md) - [Derivatives UDP Retransmits](https://docs.cdp.coinbase.com/derivatives/udp/retransmits.md) ### CDP API V1 #### CDP API V1 - [Welcome to CDP APIs](https://docs.cdp.coinbase.com/api-reference/introduction.md): The Coinbase Developer Platform (CDP) APIs allow you to safely and securely connect to CDP suite of backend services to easily build onchain apps. - [API Authentication](https://docs.cdp.coinbase.com/api-reference/authentication.md) - [Networks](https://docs.cdp.coinbase.com/api-reference/networks.md) #### REST API ##### Staking - [Build a new staking operation](https://docs.cdp.coinbase.com/api-reference/rest-api/staking/build-a-new-staking-operation.md): Builds a new staking operation containing a dynamic list of staking transactions based on the specified network, asset, address, and [custom options](/staking/staking-api/reference/api-usage#staking-options). - [Fetch historical staking balances](https://docs.cdp.coinbase.com/api-reference/rest-api/staking/fetch-historical-staking-balances.md): Fetch historical staking balances for given address. This API is available for mainnet only. - [Fetch staking rewards](https://docs.cdp.coinbase.com/api-reference/rest-api/staking/fetch-staking-rewards.md): Fetch staking rewards for a list of addresses. This API is available for mainnet only. - [Get latest staking operation](https://docs.cdp.coinbase.com/api-reference/rest-api/staking/get-latest-staking-operation.md): Fetches the latest staking operation for the specified network and address given the staking operation ID. - [Get staking context](https://docs.cdp.coinbase.com/api-reference/rest-api/staking/get-staking-context.md): Fetches the staking context for an address given the network, asset, address and [custom options](/staking/staking-api/reference/api-usage#staking-options). - [Get validator by ID](https://docs.cdp.coinbase.com/api-reference/rest-api/staking/get-validator-by-id.md): Get a validator by its ID for a given network and asset. - [List validators](https://docs.cdp.coinbase.com/api-reference/rest-api/staking/list-validators.md): List validators belonging to the user for a given network and asset. ##### Onramp/Offramp - [Create buy quote](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/create-buy-quote.md): The Buy Quote API provides clients with a quote based on the asset the user would like to purchase, the network they want to receive it on, the fiat amount of the payment, the payment currency, the payment method, and country of the user. - [Create sell quote](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/create-sell-quote.md): The Sell Quote API provides clients with a quote based on the asset the user would like to sell, the network they plan to send it on, the crypto amount of the sale, the sale currency, the fiat deposit method, and country of the user. - [Create session token](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/create-session-token.md): Creates a single use token that can be used to initialize an Onramp or Offramp session. This API should be called once for every new user session. The returned token will expire after 5 minutes. - [Get all offramp transactions](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-all-offramp-transactions.md): Returns all offramp transactions created by your app in the provided time period. - [Get all onramp transactions](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-all-onramp-transactions.md): Returns all onramp transactions created by your app in the provided time period. - [Get buy config](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-buy-config.md): The Buy Config API returns the list of countries supported by Coinbase Pay Onramp, and the payment methods available in each country. Clients should call this API periodically and cache the response. - [Get buy options](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-buy-options.md): The Buy Options API provides clients with a way to discover the available options for buying Crypto with Coinbase Onramp. It returns the supported fiat currencies and available crypto assets that can be passed into the Buy Quote API. Clients should call this API periodically for each country they su… - [Get offramp transactions by ID](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-offramp-transactions-by-id.md): When you initialize the Offramp Widget you can pass a `partnerUserRef` parameter to associate the transaction created during that session with the ID. You can then use that ID in this API to retrieve that transaction and any others that share the ID. The value of the `partnerUserRef` param can be an… - [Get onramp transactions by ID](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-onramp-transactions-by-id.md): When you initialize the Onramp Widget you can pass a `partnerUserRef` parameter to associate the transaction created during that session with the ID. You can then use that ID in this API to retrieve that transaction and any others that share the ID. The value of the `partnerUserRef` param can be any… - [Get sell config](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-sell-config.md): The Sell Config API returns the list of countries supported by Coinbase Pay Offramp, and the fiat deposit methods available in each country. Clients should call this API periodically and cache the response. - [Get sell options](https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/get-sell-options.md): The Sell Options API provides clients with a way to discover the available options for selling Crypto with Coinbase Offramp. It returns the supported fiat deposit currencies and available crypto assets that can be passed into the Sell Quote API. Clients should call this API periodically for each cou… #### JSON-RPC API - [Core JSON-RPC Methods](https://docs.cdp.coinbase.com/api-reference/json-rpc-api/core.md): The following EVM-compatible JSON-RPC methods provide convenient access to onchain data on Base. - [Paymaster JSON-RPC Methods](https://docs.cdp.coinbase.com/api-reference/json-rpc-api/paymaster.md) - [Address History JSON-RPC Methods](https://docs.cdp.coinbase.com/api-reference/json-rpc-api/address-history.md): The following JSON-RPC APIs provide convenient access to historical data for your onchain addresses. ## OpenAPI Specs - [adv-starbase-openapi](/api-reference/coinbase-deribit-app-api/adv-starbase-openapi.json) - [cde-spec](/api-reference/derivatives-api/rest-api/cde-spec.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)