Instruments

Get instruments

An instruments request returns the instruments that are supported for trading on Paradigm. If the resulting returned list of instruments is too large, it is divided into pages. Each request returns a single page.

GET/v1/ob/instruments/

Authorization

HeaderAPIKeyAuthenticationHeaderAPIKeyAuthentication

Query parameters

Response

200

Body

application/json

countinteger

Example: 123

nextnullable string

resultsarray of Instrument (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/ob/instruments/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Bearer"
    },
});
const data = await response.json();

Response

200

{
  "count": 123,
  "next": "text",
  "results": [
    {
      "base_currency": {},
      "expiration": 0,
      "kind": {},
      "margin_kind": {},
      "mark_price": "text",
      "name": "text",
      "option_kind": "CALL",
      "product_code": "text",
      "strike": "text",
      "venue": {},
      "venue_name": "text"
    }
  ]
}

Get instrument by name

Get a single intrument by specifying venue and instrument name.E.g: DBT and BTC-15MAY24-64500-C

GET/v1/ob/instruments/{venue}/{name}/

Authorization

HeaderAPIKeyAuthenticationHeaderAPIKeyAuthentication

Path parameters

name*string

venue*string

Response

200

Body

application/json

base_currency*all of

expiration*number (double)

greeks*nullable object

kind*all of

margin_kind*all of

mark_price*nullable string

name*string

option_kind*nullable one of

OptionKindEnum (enum)NullEnum (enum)

product_code*string

strike*string (decimal)

venue*all of

venue_name*string

Request

JavaScriptCurlPython

const response = await fetch('/v1/ob/instruments/{venue}/{name}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer Bearer"
    },
});
const data = await response.json();

Response

200

{
  "base_currency": {},
  "expiration": 0,
  "kind": {},
  "margin_kind": {},
  "mark_price": "text",
  "name": "text",
  "option_kind": "CALL",
  "product_code": "text",
  "strike": "text",
  "venue": {},
  "venue_name": "text"
}