# Coinbase Developer Documentation: API Reference Coinbase Exchange API ## Coinbase Exchange API ### REST API - [Welcome to Coinbase Exchange API](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/introduction.md) - [Exchange REST API Requests](https://docs.cdp.coinbase.com/exchange/rest-api/requests.md) - [Exchange REST API Authentication](https://docs.cdp.coinbase.com/exchange/rest-api/authentication.md) - [REST Rate Limits Overview](https://docs.cdp.coinbase.com/exchange/rest-api/rate-limits.md) - [Exchange REST API Pagination](https://docs.cdp.coinbase.com/exchange/rest-api/pagination.md) - [Exchange REST API SDKs](https://docs.cdp.coinbase.com/exchange/rest-api/sdks.md) - [Exchange Types](https://docs.cdp.coinbase.com/exchange/rest-api/types.md) #### Accounts - [Get a single account by id](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/accounts/get-single-account-by-id.md): Information for a single account. Use this endpoint when you know the account_id. API key must belong to the same profile as the account. - [Get a single account's holds](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/accounts/get-single-account-hold.md): List the holds of an account that belong to the same profile as the API key. Holds are placed on an account for any active orders or pending withdraw requests. As an order is filled, the hold amount is updated. If an order is canceled, any remaining hold is removed. For withdrawals, the hold is remo… - [Get a single account's ledger](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/accounts/get-single-account-ledger.md): Lists ledger activity for an account. This includes anything that would affect the accounts balance - transfers, trades, fees, etc. - [Get a single account's transfers](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/accounts/get-single-account-transfer.md): Lists past withdrawals and deposits for an account. - [Get all accounts for a profile](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/accounts/get-all-account-profile.md): Get a list of trading accounts from the profile of the API key. #### Address Book - [Add addresses](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/address-book/add-addresses.md): Add new addresses to address book - [Delete address](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/address-book/delete-address.md): Delete address from address book - [Get address book](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/address-book/get-address-book.md): Get all addresses stored in the address book. - [Get counterparty address book](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/address-book/get-counterparty-address-book.md): Get all counterparty addresses stored in the address book - [Update address book](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/address-book/update-address-book.md): Update an address book entry #### Coinbase Accounts - [Generate crypto address](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/coinbase-accounts/generate-crypto-address.md): Generates a one-time crypto address for depositing crypto. - [Get all Coinbase wallets](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/coinbase-accounts/get-all-coinbase-wallets.md): Gets all the user's available Coinbase wallets (These are the wallets/accounts that are used for buying and selling on www.coinbase.com) #### Conversions - [Convert currency](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/conversions/convert-currency.md): Converts funds from `from` currency to `to` currency. Funds are converted on the `from` account in the `profile_id` profile. - [Get a conversion](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/conversions/get-a-conversion.md): Gets a currency conversion by id (i.e. USD -> USDC). - [Get all conversions](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/conversions/get-all-conversions.md): Gets all currency conversions (i.e. USD -> USDC) for a given profile - [Get conversion fee rates](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/conversions/get-conversion-fee-rates.md): Gets a list of current conversion fee rates and trailing 30 day volume by currency pair #### Currencies - [Get a currency](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/currencies/get-a-currency.md): Gets a single currency by id. - [Get all known currencies](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/currencies/get-all-known-currencies.md): Gets a list of all known currencies. Note: Not all currencies may be currently in use for trading. #### Fees - [Get fees](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/fees/get-fee.md): Get fees rates and 30 days trailing volume. #### Futures - [Get auto loan setting](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/futures/get-auto-loan-setting.md): Get the setting to automatically initiate loans to meet margin calls with Coinbase affiliates in accordance with the Lending Agreement and Side Letter - [Get USDC conversion](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/futures/get-usdc-conversion.md): Get the USDC to USD auto conversion setting to meet margin calls with eligible Coinbase Affiliate - [Set auto loan](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/futures/set-auto-loan.md): Automatically initiate loans to meet margin calls with Coinbase affiliates in accordance with the Lending Agreement and Side Letter - [Set USDC conversion](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/futures/set-usdc-conversion.md): Set the USDC to USD auto conversion to meet margin calls with eligible Coinbase Affiliate #### Loan - [Get lending overview](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/get-lending-overview.md): This API summarizes lending for a given client. It calculates the overall loan balance, collateral level, and amounts available to borrow. It also returns any withdrawal restrictions in force on the client. - [Get lending overview XM](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/get-lending-overview-xm.md): Get lending overview for a cross margin user with margin requirements and account equity information. - [Get new loan preview](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/get-new-loan-preview.md): This API is similar to lending-overview but is used to preview the results of opening a new loan. The values returned in the preview response take the existing loans, collateral and the potential change being previewed into account. Note the preview request accepts native currency amounts as input. - [Get loan preview XM](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/get-loan-preview-xm.md): Preview the results of a loan for a cross margin user. - [Get principal repayment preview](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/get-principal-repayment-preview.md): Preview the results of a loan principal repayment. - [Get repayment preview XM](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/get-repayment-preview-xm.md): Preview the results of a loan principal repayment for a cross margin user. - [List interest charges](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/list-interest-charges.md): List interest charges for a loan - [List interest rate history](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/list-interest-rate-history.md): List interest rate history for a loan - [List interest summaries](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/list-interest-summaries.md): List summaries of interest owed by asset - [List loan assets](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/list-loan-assets.md): Get a list of lendable assets, a map of assets we accept as collateral for loans, and the haircut weight. - [List loans](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/list-loans.md): Accepts zero or more loan IDs as input. If no loan IDs are specified, it returns all loans for the user. Otherwise it returns only the loan IDs specified. - [List new loan options](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/list-new-loan-options.md): Get available currencies and interest rates for new loans. All amounts returned by this API are notional values (i.e., USD). - [Open new loan](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/open-new-loan.md): This API triggers a loan open request. Funding is not necessarily instantaneous and there is no SLA. You are notified when funds have settled in your Exchange account. Loan open requests, once initiated, cannot be canceled. - [Repay loan interest](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/repay-loan-interest.md): Submit an interest repayment for a loan. - [Repay loan principal](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/loan/repay-loan-principal.md): Submit a principal repayment for a loan. #### Orders - [Cancel all orders](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/orders/cancel-all-orders.md): With best effort, cancel all open orders. This may require you to make the request multiple times until all of the open orders are deleted. - [Cancel an order](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/orders/cancel-an-order.md): Cancel a single open order by `{id}`. - [Create a new order](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/orders/create-new-order.md): Create an order. You can place two types of orders: limit and market. Orders can only be placed if your account has sufficient funds. Once an order is placed, your account funds will be put on hold for the duration of the order. How much and which funds are put on hold depends on the order type and… - [Get all fills](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/orders/get-all-fills.md): Get a list of fills. A fill is a partial or complete match on a specific order. - [Get all orders](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/orders/get-all-orders.md): List your current open orders. Only open or un-settled orders are returned by default. As soon as an order is no longer open and settled, it will no longer appear in the default request. Open orders may change state between the request and the response depending on market conditions. - [Get single order](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/orders/get-single-order.md): Get a single order by `id`. #### Products - [Get all known trading pairs](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/products/get-all-known-trading-pairs.md): Gets a list of available currency pairs for trading. - [Get all product volume](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/products/get-all-product-volume.md): Gets 30day and 24hour volume for all products and market types - [Get product book](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/products/get-product-book.md): Get a list of open orders for a product. The amount of detail shown can be customized with the `level` parameter. - [Get product candles](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/products/get-product-candles.md): Historic rates for a product. Rates are returned in grouped buckets. Candle schema is of the form `[timestamp, price_low, price_high, price_open, price_close]` - [Get product stats](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/products/get-product-stats.md): Gets 30day and 24hour stats for a product. - [Get product ticker](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/products/get-product-ticker.md): Gets snapshot information about the last trade (tick), best bid/ask and 24h volume. - [Get product trades](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/products/get-product-trades.md): Gets a list the latest trades for a product. - [Get single product](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/products/get-single-product.md): Get information on a single product. #### Profiles - [Create a profile](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/profiles/create-profile.md): Create a new profile. Will fail if no name is provided or if user already has max number of profiles. - [Delete a profile](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/profiles/delete-profile.md): Deletes the profile specified by `profile_id` and transfers all funds to the profile specified by `to`. Fails if there are any open orders on the profile to be deleted. - [Get profile by id](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/profiles/get-profile-by-id.md): Information for a single profile. Use this endpoint when you know the profile_id. - [Get profiles](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/profiles/get-profiles.md): Gets a list of all of the current user's profiles. - [Rename a profile](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/profiles/rename-profile.md): Rename a profile. Names 'default' and 'margin' are reserved. - [Transfer funds between profiles](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/profiles/transfer-funds-profile.md): Transfer an amount of currency from one profile to another. #### Reports - [Create a report](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/reports/create-report.md): Generates a report. You can create reports with historical data for all report types. [Balance reports](#balance-reports) can be snapshots of historical or current data. - [Get a report](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/reports/get-report.md): Get a specific report by `report_id`. - [Get all reports](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/reports/get-all-reports.md): Gets a list of all user generated reports. #### Transfers - [Deposit from Coinbase account](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/transfers/deposit-from-coinbase-account.md): Deposits funds from a www.coinbase.com wallet to the specified `profile_id`. - [Deposit from payment method](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/transfers/deposit-from-payment-method.md): Deposits funds from a linked external payment method to the specified `profile_id`. - [Get a single transfer](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/transfers/get-single-transfer.md): Get information on a single transfer. - [Get all payment methods](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/transfers/get-all-payment-methods.md): Gets a list of the user's linked payment methods. - [Get all transfers](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/transfers/get-all-transfers.md): Gets a list of in-progress and completed transfers of funds in/out of any of the user's accounts. - [Get fee estimate for crypto withdrawal](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/transfers/get-fee-estimate.md): Gets the fee estimate for the crypto withdrawal to crypto address - [Submit travel information for a transfer](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/transfers/submit-travel-info.md): Submit travel information for a transfer - [Withdraw to Coinbase account](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/transfers/withdraw-to-coinbase-account.md): Withdraws funds from the specified `profile_id` to a www.coinbase.com wallet. - [Withdraw to counterparty Id](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/transfers/withdraw-to-counterparty.md): Withdraw funds from a specified currency account to a counterparty account - [Withdraw to crypto address](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/transfers/withdraw-to-crypto-address.md): Withdraws funds from the specified `profile_id` to an external crypto address - [Withdraw to payment method](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/transfers/withdraw-to-payment-method.md): Withdraws funds from the specified `profile_id` to a linked external payment method #### Travel Rules - [Create travel rule entry](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/travel-rules/create-travel-rule.md): Create travel rule entry for sending address - [Delete existing travel rule entry](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/travel-rules/delete-existing-travel-rule.md): Delete existing travel rule entry - [Get all travel rule information](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/travel-rules/get-all-travel-rule.md): Return a list of all stored travel rule information #### Users - [Get user exchange limits](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/users/get-user-exchange-limits.md): Gets exchange limits information for a single user. - [Get user trading volume](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/users/get-user-trading-volume.md): Gets aggregated and individual trading volumes for users. - [Update settlement preference](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/users/update-settlement-preference.md): Updates the settlement preference to hold funds in either USDC or USD. #### Wrapped Assets - [Create a new redeem](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/wrapped-assets/create-new-redeem.md): Redeems `from_currency` to `to_currency`. Funds are redeemed in the profile associated with the API key. - [Create a new stake-wrap](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/wrapped-assets/create-new-stake-wrap.md): Stakes and wraps `from_currency` to `to_currency`. Funds are stake-wrapped in the profile associated with the API key. - [Get a single redeem](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/wrapped-assets/get-single-redeem.md): Get details for a specific redeem in the profile associated with the API key. - [Get a single stake-wrap](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/wrapped-assets/get-a-single-stake-wrap.md): Get details for a specific stake-wrap in the profile associated with the API key. - [Get all redeems](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/wrapped-assets/get-all-redeems.md): Get details for all redeems in the profile associated with the API key. - [Get all stake-wraps](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/wrapped-assets/get-all-stake-wraps.md): Get details for all stake-wraps in the profile associated with the API key. - [Get all wrapped assets](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/wrapped-assets/get-all-wrapped-assets.md): Returns a list of all supported wrapped assets details objects - [Get wrapped asset conversion rate](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/wrapped-assets/get-wrapped-asset-conversion-rate.md): Returns the conversion rate of a wrapped asset - [Get wrapped asset details](https://docs.cdp.coinbase.com/api-reference/exchange-api/rest-api/wrapped-assets/get-wrapped-asset-details.md): Returns the circulating and total supply of a wrapped asset, and its conversion rate ### FIX API - [Exchange FIX API Connectivity](https://docs.cdp.coinbase.com/exchange/fix-api/connectivity.md) - [Exchange FIX Best Practices](https://docs.cdp.coinbase.com/exchange/fix-api/best-practices.md) - [FIX Rate Limits Overview](https://docs.cdp.coinbase.com/exchange/fix-api/rate-limits.md) - [Exchange FIX Drop Copy 5.0](https://docs.cdp.coinbase.com/exchange/fix-api/drop-copy.md) - [Exchange FIX Market Data Messages 5.0](https://docs.cdp.coinbase.com/exchange/fix-api/market-data.md) - [Exchange FIX Dictionary Downloads](https://docs.cdp.coinbase.com/exchange/fix-api/dictionary-downloads.md) #### Order Entry Messages - [Exchange FIX Order Entry Messages 5.0](https://docs.cdp.coinbase.com/exchange/fix-api/order-entry-messages/order-entry-messages5.md) - [Exchange Take Profit Stop Loss Orders](https://docs.cdp.coinbase.com/exchange/fix-api/order-entry-messages/tpsl-orders.md) - [Exchange Limit With Funds Orders](https://docs.cdp.coinbase.com/exchange/fix-api/order-entry-messages/limit-orders.md) ### Websocket Feed - [Exchange WebSocket Overview](https://docs.cdp.coinbase.com/exchange/websocket-feed/overview.md) - [Exchange WebSocket Best Practices](https://docs.cdp.coinbase.com/exchange/websocket-feed/best-practices.md) - [Exchange WebSocket Authentication](https://docs.cdp.coinbase.com/exchange/websocket-feed/authentication.md) - [Exchange WebSocket Channels](https://docs.cdp.coinbase.com/exchange/websocket-feed/channels.md) - [Exchange WebSocket Rate Limits](https://docs.cdp.coinbase.com/exchange/websocket-feed/rate-limits.md) - [Exchange WebSocket Errors](https://docs.cdp.coinbase.com/exchange/websocket-feed/errors.md)