GET
/
api
/
v3
/
brokerage
/
products
curl --request GET \
  --url https://api.coinbase.com/api/v3/brokerage/products
{
  "products": [
    {
      "product_id": "BTC-USD",
      "price": "140.21",
      "price_percentage_change_24h": "9.43%",
      "volume_24h": "1908432",
      "volume_percentage_change_24h": "9.43%",
      "base_increment": "0.00000001",
      "quote_increment": "0.00000001",
      "quote_min_size": "0.00000001",
      "quote_max_size": "1000",
      "base_min_size": "0.00000001",
      "base_max_size": "1000",
      "base_name": "Bitcoin",
      "quote_name": "US Dollar",
      "watched": true,
      "is_disabled": false,
      "new": true,
      "status": "<string>",
      "cancel_only": true,
      "limit_only": true,
      "post_only": true,
      "trading_disabled": false,
      "auction_mode": true,
      "product_type": "<any>",
      "quote_currency_id": "USD",
      "base_currency_id": "BTC",
      "fcm_trading_session_details": {
        "is_session_open": true,
        "open_time": "<string>",
        "close_time": "<string>",
        "session_state": "<any>",
        "after_hours_order_entry_disabled": true,
        "closed_reason": "<any>",
        "maintenance": {
          "start_time": "<string>",
          "end_time": "<string>"
        }
      },
      "mid_market_price": "140.22",
      "alias": "BTC-USD",
      "alias_to": [
        "BTC-USDC"
      ],
      "base_display_symbol": "BTC",
      "quote_display_symbol": "USD",
      "view_only": true,
      "price_increment": "0.00000001",
      "display_name": "BTC PERP",
      "product_venue": "<any>",
      "approximate_quote_24h_volume": "1908432",
      "new_at": "2021-07-01T00:00:00.000Z",
      "future_product_details": {
        "venue": "<string>",
        "contract_code": "<string>",
        "contract_expiry": "<string>",
        "contract_size": "<string>",
        "contract_root_unit": "<string>",
        "group_description": "<string>",
        "contract_expiry_timezone": "<string>",
        "group_short_description": "<string>",
        "risk_managed_by": "<any>",
        "contract_expiry_type": "<any>",
        "perpetual_details": {
          "open_interest": "<string>",
          "funding_rate": "<string>",
          "funding_time": "<string>",
          "max_leverage": "<string>",
          "base_asset_uuid": "<string>",
          "underlying_type": "<string>"
        },
        "contract_display_name": "<string>",
        "time_to_expiry_ms": "<string>",
        "non_crypto": true,
        "contract_expiry_name": "<string>",
        "twenty_four_by_seven": true
      }
    }
  ],
  "num_products": 100
}

Query Parameters

​
limit
integer

The number of products to be returned.

​
offset
integer

The number of products to skip before returning.

​
product_type
enum<string>
default:UNKNOWN_PRODUCT_TYPE

Only returns the orders matching this product type. By default, returns all product types.

Available options:
UNKNOWN_PRODUCT_TYPE,
SPOT,
FUTURE
​
product_ids
string[]

The list of trading pairs (e.g. 'BTC-USD').

​
contract_expiry_type
enum<string>
default:UNKNOWN_CONTRACT_EXPIRY_TYPE

Only returns the orders matching the contract expiry type. Only applicable if product_type is set to FUTURE.

Available options:
UNKNOWN_CONTRACT_EXPIRY_TYPE,
EXPIRING,
PERPETUAL
​
expiring_contract_status
enum<string>
default:UNKNOWN_EXPIRING_CONTRACT_STATUS

Only returns contracts with this status (default is UNEXPIRED).

Available options:
UNKNOWN_EXPIRING_CONTRACT_STATUS,
STATUS_UNEXPIRED,
STATUS_EXPIRED,
STATUS_ALL
​
get_tradability_status
boolean

Whether or not to populate view_only with the tradability status of the product. This is only enabled for SPOT products.

​
get_all_products
boolean

If true, return all products of all product types (including expired futures contracts).

​
products_sort_order
enum<string>
default:PRODUCTS_SORT_ORDER_UNDEFINED

The order in which products are returned. By default, products are returned in 24 hour volume descending (in quote).

Available options:
PRODUCTS_SORT_ORDER_UNDEFINED,
PRODUCTS_SORT_ORDER_VOLUME_24H_DESCENDING,
PRODUCTS_SORT_ORDER_LIST_TIME_DESCENDING

Response

200
application/json

A successful response.

The response is of type object.