Requests for Quotes


POST rfqsubmit

Description

Submit a request for quote (RFQ) to the exchange.

Resource URL

https://api.optionscity.com/rfqsubmit
Authentication Required
HTTP Methods POST
Media Types application/json
Response Object None
Response Type Standard
Request Object RFQ Submission

Example Request

POST https://api.optionscity.com/rfqsubmit
{
  "acct_id" : 2,
  "instrument_id" : 1,
  "quantity" : 10
}

GET rfqs

Description

Get recent RFQs for a set of parent symbols (limited to 100).

Resource URL

https://api.optionscity.com/rfqs
Authentication Required
HTTP Methods GET
Media Types application/json
Response Object Request for Quote
Response Type Standard

Parameters

NameDescriptionRequired?Type
product_group_ids The set of product group IDs for which to fetch RFQs. Yes StringArray
since_id Only include RFQs that have appeared after the RFQ with this ID. No String
embed_instrument Whether instrument, product and product group details should be embedded in each RFQ definition. No Boolean

Example Request

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

Example Response

[ {
  "id" : "123",
  "instrument_id" : 1,
  "quantity" : 10,
  "submitted_at" : "2019-09-23T20:45:54.431Z"
} ]

Request for Quote Submission Object

Description

Defines a request for quote (RFQ) to be submitted to the exchange.

Fields

Field Type Optional Description
acct_id Number No The account for which to submit the RFQ.
instrument_id Number No City API assigned instrument identifier.
quantity Number No Trade quantity desired.

JSON Sample

{
  "acct_id" : 2,
  "instrument_id" : 1,
  "quantity" : 10
}

Request for Quote Object

Description

Defines a request for quote (RFQ) from the exchange.

Fields

Field Type Optional Description
id String No City API assigned identifier.
instrument_id Number No City API assigned instrument identifier.
quantity Number No Trade quantity desired.
submitted_at DateTime* No The time the RFQ was submitted.

JSON Sample

{
  "id" : "123",
  "instrument_id" : 1,
  "quantity" : 10,
  "submitted_at" : "2019-09-23T20:45:54.430Z"
}

* Date and time elements are ISO-8601 string representations