viewTrades
Use this command to retrieve trade details. The response will provide the order_id, exec_id, item and other fields to help identify which executed trades to modify when using the addToQueue command. Note that even though an executed trade may show in the response, it may not be available for modification. For example, if a trade has been modified but not submitted to the clearinghouse, the trade will not be eligible for modification until the clearinghouse submission has been completed.
A response to viewTrades is limited to 10,000 trade records. The following table describes the filters that can be added to the viewTrades command in order to reduce the number of trades returned in the response.
| Parameter | Required | Description |
|---|---|---|
| command | Y | viewTrades |
| clearing_corp | N | Valid values included OCC or CCUS. If field not specified, the value defaults to OCC. |
| account | Y | |
| call_put_flag | Y |
|
| capacity | Y |
|
| cl_order_id (C1 only) | Y | ID chosen by client, 20 characters or less. Characters in ASCII range 33-126 are allowed, except for comma, semicolon, and pipe |
| clearing_account | Y | Referred to as Sub Account in GUI. |
| clearing_firm | Y | The EFID used in the relationship. Referred to as Broker Id in GUI. Returned as "executing_firm_id" in the viewTrades results. |
| cmta | Y | |
| Y | Only Y and N values are accepted. |
| exec_id | Y | Cboe-created execution id. |
| Y | |
| Y | Identifies the frequent trader program in which the order is participating, 6 characters or less, ASCII 33-126 |
| Y | |
| open_close | Y |
|
| order_id | Y | Cboe-created order id. |
| ors_eligible (C1 only) | Y | Only Y and N values are accepted. |
| osi_root | Y | |
| price | Y | |
| side | Y | Valid values are B and S. |
| status | Y |
|
| strategy_id (C1 only) | Y |
|
| strike_price | Y |
Example Response
{"code":"200",
"data":[
{"cmta":"111", "call_put_flag":"Call", "executing_firm_id":"CBOE", "size":"10", "capacity":"Customer", "ts":"09:30:01.02021", "expire_date":"3006-01-01", "cl_order_id":"AAAAAAAAAAAAA", "sub_account":"", "revision":0,"status":"", "strike_price":"10.0000", "order_id":"123456789012", "price":"0.6000", "account":"AAAA", "firm_sub_id":"0003", "firm_id":"CBOE", "position":"Open", "osi_root":"A", "exec_id":"01XX00001", "routing_broker":"", "item":"", "mod_contact_id":0,"side":"Buy", "clearing_opt_data": ""}
],
"msg":""
}