Products


GET products

Description

Get the entire set of product definitions, unsorted.

Resource URL

https://api.optionscity.com/products
Authentication Required
HTTP Methods GET
Media Types application/json
Response Object Product
Response Type Standard

Parameters

NameDescriptionRequired?Type
group_id Only return products belonging to this product group. No Number
instrument_type Only return products with this instrument type (future, option, spread). No String

Example Request

GET https://api.optionscity.com/products

Example Response

[ {
  "id" : 1,
  "group_id" : 2,
  "parent_symbol" : "ES",
  "clearing_symbol" : "ES",
  "instrument_type" : "Option",
  "is_weekly" : false,
  "settlement_type" : "Cash",
  "exercise_procedure" : "American",
  "expiration_type" : "S",
  "display_factor" : 0.01,
  "tick_size" : 25,
  "tick_value" : 12.5,
  "tick_boundaries" : [ ],
  "tick_sizes" : [ ],
  "base_factor" : 1,
  "session_start_times" : [ 1020, 2460, 3900, 5340, 6780 ],
  "session_end_times" : [ 2415, 3855, 5295, 6735, 8175 ]
} ]

GET products/:id

Description

Get common properties for all member instruments of the given product.

Resource URL

https://api.optionscity.com/products/:id
Authentication Required
HTTP Methods GET
Media Types application/json
Response Object Product
Response Type Standard

Parameters

NameDescriptionRequired?Type
id The unique City API identifier for the product. Yes Number

Example Request

GET https://api.optionscity.com/products/1

Example Response

{
  "id" : 1,
  "group_id" : 2,
  "parent_symbol" : "ES",
  "clearing_symbol" : "ES",
  "instrument_type" : "Option",
  "is_weekly" : false,
  "settlement_type" : "Cash",
  "exercise_procedure" : "American",
  "expiration_type" : "S",
  "display_factor" : 0.01,
  "tick_size" : 25,
  "tick_value" : 12.5,
  "tick_boundaries" : [ ],
  "tick_sizes" : [ ],
  "base_factor" : 1,
  "session_start_times" : [ 1020, 2460, 3900, 5340, 6780 ],
  "session_end_times" : [ 2415, 3855, 5295, 6735, 8175 ]
}

Product Object

Description

Common properties for a group of instruments.

Fields

Field Type Optional Description
id Number No Identifier assigned by City API.
group_id Number No The ID of the group to which the product belongs.
parent_symbol String No The parent symbol supplied by the source exchange.
instrument_type String No Future, Option or Spread.
clearing_symbol String No Unique symbol used by clearing firm to identify this instrument class.
display_factor Number No Used to determine transformation needed to raw exchange prices to produce commonly quoted convention.
tick_size Number No The minimum amount by which exchange prices fluctuate. For example, an instrument with a tick of 0.25 would have valid prices of 0.00, 0.25, 0.50, etc.
tick_value Number No The dollar value of a tick in the instrument's native currency.
tick_boundaries StringArray No The prices below which the tick size is reduced. Thecorresponding reduced tick size is found in the parallel 'tick_sizes' array.
tick_sizes StringArray No The minimum price fluctuation for a given price range as specified by the parallel 'tick_boundaries' array.
base_factor Number No Used to determine transformation needed to raw exchange prices to produce commonly quoted convention.
session_start_times StringArray No The start times of open trading sessions in minutes from the start of the week, CST, not including holidays.
session_end_times StringArray No The end times of open trading sessions in minutes from the start of the week, CST, not including holidays.
settlement_type String No 'Cash' or 'Physical'.
exercise_procedure String No 'American' or 'European'.
expiration_type String No Designates quarterly (Q), serial (S), monthly (M) option expiration type.
is_weekly Boolean No Whether this product represents options with a weekly expiration.

JSON Sample

{
  "id" : 1,
  "group_id" : 2,
  "parent_symbol" : "ES",
  "clearing_symbol" : "ES",
  "instrument_type" : "Option",
  "is_weekly" : false,
  "settlement_type" : "Cash",
  "exercise_procedure" : "American",
  "expiration_type" : "S",
  "display_factor" : 0.01,
  "tick_size" : 25,
  "tick_value" : 12.5,
  "tick_boundaries" : [ ],
  "tick_sizes" : [ ],
  "base_factor" : 1,
  "session_start_times" : [ 1020, 2460, 3900, 5340, 6780 ],
  "session_end_times" : [ 2415, 3855, 5295, 6735, 8175 ]
}

* Date and time elements are ISO-8601 string representations