Product Groups


GET productgroups

Description

Get the entire set of product group definitions, unsorted.

Resource URL

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

Example Request

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

Example Response

[ {
  "id" : 1,
  "symbol" : "ES",
  "category" : "Equities",
  "sub_category" : "US Indexes",
  "name" : "E-mini S&P 500 Options",
  "time_zone" : "America/Chicago",
  "exchange" : "CME",
  "market_data_group" : "CME",
  "mic" : "XCME",
  "currency" : "USD"
} ]

GET productgroups/:id

Description

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

Resource URL

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

Parameters

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

Example Request

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

Example Response

{
  "id" : 1,
  "symbol" : "ES",
  "category" : "Equities",
  "sub_category" : "US Indexes",
  "name" : "E-mini S&P 500 Options",
  "time_zone" : "America/Chicago",
  "exchange" : "CME",
  "market_data_group" : "CME",
  "mic" : "XCME",
  "currency" : "USD"
}

GET productgroups/:id/expirations

Description

Get all expiration summaries for the specified product group.

Resource URL

https://api.optionscity.com/productgroups/:id/expirations
Authentication Required
HTTP Methods GET
Media Types application/json
Response Object Expiration Summary
Response Type Standard

Parameters

NameDescriptionRequired?Type
id The unique City API identifier for the product group. Yes Number
min_expiration Filter out expirations below this date and time. Default value is the current time. No DateTime*

Example Request

GET https://api.optionscity.com/productgroups/4/expirations

Example Response

[ {
  "date" : "2019-09-23T20:45:03.089Z",
  "display_date" : "2019-09-23",
  "underlying_id" : 8,
  "expiration_type" : "S",
  "exercise_procedure" : "American"
} ]

GET productgroups/:id/spreadtypes

Description

Get all spread type summaries for the specified product group.

Resource URL

https://api.optionscity.com/productgroups/:id/spreadtypes
Authentication Required
HTTP Methods GET
Media Types application/json
Response Object Spread Type Summary
Response Type Standard

Parameters

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

Example Request

GET https://api.optionscity.com/productgroups/4/spreadtypes

Example Response

[ {
  "description" : "Jelly Roll",
  "code" : "JRL"
} ]

Product Group Object

Description

Common properties for a group of products (and instruments).

Fields

Field Type Optional Description
id Number No Identifier assigned by City API.
symbol String No The exchange symbol used to commonly identify the product group.
category String No Used to group related instruments.
sub_category String No Used to further group related instruments.
name String No Nicely formatted name suitable for display.
trading_status String Yes 'Open', 'Rotation', 'Closed', 'PreOpen', 'PreClosed', 'Halted' or 'Disabled'.
time_zone String No Source exchange's local timezone description (e.g. 'America/Chicago').
is_open Boolean Yes Whether the product group is currently open for trading according to its normal schedule. For up-to-the-second status, refer to 'trading_status'. Does not account for holidays.
open_time String Yes If the the product group is currently open, the time it opened. Otherwise the time it will open next. Does not account for holidays.
close_time String Yes If the the product group is currently closed, the time it closed. Otherwise the time it will close next. Does not account for holidays.
exchange String No 'CME', 'KCBT', etc.
market_data_group String No 'CME', 'ICE', etc.
mic String No The exchange ISO market identification code (e.g. 'XCME', 'IFUS').
currency String Yes 'USD', 'EUR', etc.
enabled Boolean No Whether the requester is enabled for trading (has risk limits configured) on this product group.

JSON Sample

{
  "id" : 1,
  "symbol" : "ES",
  "category" : "Equities",
  "sub_category" : "US Indexes",
  "name" : "E-mini S&P 500 Options",
  "time_zone" : "America/Chicago",
  "exchange" : "CME",
  "market_data_group" : "CME",
  "mic" : "XCME",
  "currency" : "USD"
}

Expiration Summary Object

Description

Summarizes properties for a group of options with a common expiration.

Fields

Field Type Optional Description
date DateTime* No The exact expiration date and time.
display_date LocalDate* No The expiration as commonly referenced.
underlying_id Number No The underlying ID of all options in the group.
expiration_type String No The type of expiration of all options in the group.
exercise_procedure String No 'American' or 'European'.

JSON Sample

{
  "date" : "2019-09-23T20:45:03.089Z",
  "display_date" : "2019-09-23",
  "underlying_id" : 8,
  "expiration_type" : "S",
  "exercise_procedure" : "American"
}

Spread Type Summary Object

Description

Summarizes properties for a class of spread.

Fields

Field Type Optional Description
description String No Human-readable description of the spread type.
code String No Immutable code for spread type assigned by City API.

JSON Sample

{
  "description" : "Jelly Roll",
  "code" : "JRL"
}

* Date and time elements are ISO-8601 string representations