Get instrument details

GET

api

instruments

{instrument}

curl --request GET \
  --url https://api.international.coinbase.com/api/v1/instruments/{instrument}

{
  "instrument_id": 22653087021498350,
  "instrument_uuid": "97645486-8058-4d98-aa1e-5ab2685d09c8",
  "symbol": "BTC-USDC",
  "type": "PERP",
  "mode": "STANDARD",
  "base_asset_id": 2919822098049565,
  "base_asset_uuid": "592a8039-db3e-45ed-b752-ffd1983eead2",
  "base_asset_name": "BTC",
  "quote_asset_id": 45922259775510770,
  "quote_asset_uuid": "a96dc949-7650-4a70-8227-955366a22297",
  "quote_asset_name": "USDC",
  "base_increment": 0.000001,
  "quote_increment": 0.01,
  "price_band_percent": 0.02,
  "market_order_percent": 0.015,
  "qty_24hr": 4318.12,
  "notional_24hr": 86362400,
  "avg_daily_qty": 5741.531,
  "avg_daily_notional": 109430620,
  "previous_day_qty": 5741.531,
  "open_interest": 100,
  "position_limit_qty": "<string>",
  "position_limit_adq_pct": 0.03,
  "position_notional_limit": "57509393.1183",
  "open_interest_notional_limit": "299974395.974",
  "replacement_cost": 421.31,
  "base_imf": 0.1,
  "default_imf": 0.2,
  "min_notional_value": 10,
  "funding_interval": 36000000000,
  "trading_state": "TRADING",
  "quote": {
    "best_bid_price": 20000.5,
    "best_bid_size": 3.541424,
    "best_ask_price": 20001.75,
    "best_ask_size": 2.8754,
    "trade_price": 20000.63,
    "trade_qty": 0.73,
    "index_price": 20001.45,
    "mark_price": 20000.63,
    "settlement_price": 20000.23,
    "limit_up": 21056.35,
    "limit_down": 19531.5,
    "predicted_funding": 0.1543,
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "base_asset_multiplier": 1,
  "underlying_type": "SPOT",
  "rfq_maker_fee_rate": 0.01
}

InstrumentsService instrumentsService = IntxServiceFactory.createInstrumentsService(client);
GetInstrumentRequest request = new GetInstrumentRequest.Builder()
    .instrumentId("BTC-PERP")
    .build();
GetInstrumentResponse response = instrumentsService.getInstrument(request);

For more information, please visit the INTX Java SDK.

InstrumentsService instrumentsService = IntxServiceFactory.createInstrumentsService(client);
GetInstrumentRequest request = new GetInstrumentRequest.Builder()
    .instrumentId("BTC-PERP")
    .build();
GetInstrumentResponse response = instrumentsService.getInstrument(request);

For more information, please visit the INTX Java SDK.

var instrumentsService = new InstrumentsService(client);
var request = new GetInstrumentRequest(
    InstrumentId: "BTC-PERP",
);
var response = instrumentsService.GetInstrument(request);

For more information, please visit the INTX .NET SDK.

instrumentsSvc := instruments.NewInstrumentsService(client)
request := &instruments.GetInstrumentRequest{
    InstrumentId: "BTC-PERP",
}
response, err := instrumentsSvc.GetInstrument(context.Background(), request)

For more information, please visit the INTX Go SDK.

client = IntxClient()
request = GetInstrumentDetailsRequest(
    instrument_id="BTC-PERP",
)
response = client.get_instrument_details(request)

For more information, please visit the INTX Python SDK.

const instrumentsService = new InstrumentsService(client);

instrumentsService.getInstrument({
    instrumentId: 'ETH-PERP',
}).then(async (response) => {
    console.log('Instrument: ', response);
})

For more information, please visit the INTX TS SDK.

intxctl get-instrument-details --help

For more information, please visit the INTX CLI.

Path Parameters

instrument

string

required

Identifies the instrument by name (e.g., BTC-USDC), UUID (e.g., ce55a827-f04a-45c0-9d9b-8bbdb9b48065), or instrument ID (e.g., 7149252043835013)

Response

200

application/json

Instrument

The response is of type object.

Get historical funding rates

Get quote per instrument

curl --request GET \
  --url https://api.international.coinbase.com/api/v1/instruments/{instrument}

{
  "instrument_id": 22653087021498350,
  "instrument_uuid": "97645486-8058-4d98-aa1e-5ab2685d09c8",
  "symbol": "BTC-USDC",
  "type": "PERP",
  "mode": "STANDARD",
  "base_asset_id": 2919822098049565,
  "base_asset_uuid": "592a8039-db3e-45ed-b752-ffd1983eead2",
  "base_asset_name": "BTC",
  "quote_asset_id": 45922259775510770,
  "quote_asset_uuid": "a96dc949-7650-4a70-8227-955366a22297",
  "quote_asset_name": "USDC",
  "base_increment": 0.000001,
  "quote_increment": 0.01,
  "price_band_percent": 0.02,
  "market_order_percent": 0.015,
  "qty_24hr": 4318.12,
  "notional_24hr": 86362400,
  "avg_daily_qty": 5741.531,
  "avg_daily_notional": 109430620,
  "previous_day_qty": 5741.531,
  "open_interest": 100,
  "position_limit_qty": "<string>",
  "position_limit_adq_pct": 0.03,
  "position_notional_limit": "57509393.1183",
  "open_interest_notional_limit": "299974395.974",
  "replacement_cost": 421.31,
  "base_imf": 0.1,
  "default_imf": 0.2,
  "min_notional_value": 10,
  "funding_interval": 36000000000,
  "trading_state": "TRADING",
  "quote": {
    "best_bid_price": 20000.5,
    "best_bid_size": 3.541424,
    "best_ask_price": 20001.75,
    "best_ask_size": 2.8754,
    "trade_price": 20000.63,
    "trade_qty": 0.73,
    "index_price": 20001.45,
    "mark_price": 20000.63,
    "settlement_price": 20000.23,
    "limit_up": 21056.35,
    "limit_down": 19531.5,
    "predicted_funding": 0.1543,
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "base_asset_multiplier": 1,
  "underlying_type": "SPOT",
  "rfq_maker_fee_rate": 0.01
}

REST API

FIX API

WEBSOCKET FEED

Get instrument details

Path Parameters

Response