Trading Sessions


Trading Session Object

Description

Basic information for a trading session.

Fields

Field Type Optional Description
id Number Yes The City API ID for the trading session.
trading_group_id Number No The City API ID for the trading group.
ip String No The session ip address.
port String No The session port.
session_id String No The session id.
password String No The session password.
trading_platform String Yes The trading platform.
clearing_source String Yes The clearing source.

JSON Sample

{
  "id" : 1,
  "trading_group_id" : 1,
  "ip" : "10.0.1.105",
  "port" : "22",
  "session_id" : "sessionid",
  "password" : "sessionpw",
  "trading_platform" : "CME"
}

GET tradingsessions

Description

Get the details for all trading sessions associated with the given trading group id.

Resource URL

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

Parameters

NameDescriptionRequired?Type
trading_group_id City API issued id for trading group Yes Number

Example Request

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

Example Response

{
  "id" : 1,
  "trading_group_id" : 1,
  "ip" : "10.0.1.105",
  "port" : "22",
  "session_id" : "sessionid",
  "password" : "sessionpw",
  "trading_platform" : "CME"
}

POST tradingsessions

Description

Create new trading session.

Resource URL

https://api.optionscity.com/tradingsessions
Authentication Required
HTTP Methods POST
Media Types application/json
Response Object Tradingsessions
Response Type Standard

Parameters

NameDescriptionRequired?Type
trading_group_id City API issued id for trading group Yes Number
ip The trading session's ip address Yes String
port The trading session's ip port Yes String
session_id The trading session's id Yes String
password The trading session's password Yes String
trading_platform The trading session's platform (ex: CME, ICE, etc.) No String
clearing_src_id The trading session's clearing source id No Number

Example Request

POST https://api.optionscity.com/tradingsessions

Example Response

{
  "id" : 1,
  "trading_group_id" : 1,
  "ip" : "10.0.1.105",
  "port" : "22",
  "session_id" : "sessionid",
  "password" : "sessionpw",
  "trading_platform" : "CME"
}

PUT tradingsessions

Description

Modify an existing trading session.

Resource URL

https://api.optionscity.com/tradingsessions
Authentication Required
HTTP Methods PUT
Media Types application/json
Response Object Tradingsessions
Response Type Standard

Example Request

PUT https://api.optionscity.com/tradingsessions/1
{
  "trading_group_id" : 1,
  "ip" : "10.0.1.105",
  "port" : "22",
  "session_id" : "sessionid",
  "password" : "sessionpw",
  "trading_platform" : "CME"
}

Example Response

{
  "id" : 1,
  "trading_group_id" : 1,
  "ip" : "10.0.1.105",
  "port" : "22",
  "session_id" : "sessionid",
  "password" : "sessionpw",
  "trading_platform" : "CME"
}

DELETE tradingsessions

Description

Delete an existing trading session.

Resource URL

https://api.optionscity.com/tradingsessions
Authentication Required
HTTP Methods DELETE
Media Types application/json
Response Object Tradingsessions
Response Type Standard

Example Request

DELETE https://api.optionscity.com/tradingsessions/1

* Date and time elements are ISO-8601 string representations