submitTrade

Submits a new Block/ECRP report. Returns a Reference ID which should be copied and distributed to all contra parties so that they may accept or reject the trade. Note that while trades can be modified after submission via the web GUI they cannot be modified ("replaced") using the API.

Table 1. submitTrade
Parameter	Required	Description
Command	Y	submitTrade
related_position	N*	The related position information, e.g., VX Buy 100 2021-10-12 100 Call 100 12 Delta Follow the format: instrument_or_underlying side size expiry strike call_put price delta Delta Only applies when trade_type is ecrp.
product-1	Y	The product (underlying symbol) of this leg. Valid values can be viewed with the getProducts command.
instrument-1	Y	The instrument (symbol id) of this leg. Valid values can be viewed with the getInstrumentsForProduct command.
size-1	Y	The size of this leg.
price-1	Y	The price of this leg.
side-1	Y	The side of this leg. Valid values are [Buy, Sell]
blockTradeComplexType-1	Y	The trade type of this leg Valid values are [Complex, Simple, Strip]
product-2	N	Format for adding an additional leg. Up to four legs total may be specified on any given trade report.
instrument-2	N*
size-2	N*
price-2	N*
side-2	N*
blockTradeComplexType-2	N*
trade_time	Y	The time the trade took place (central time; e.g. 11:20:00).
arrangement_time	Y	The time the trade was arranged (central time; e.g. 11:20:00).
reportingPartyEfid	Y	The executing firm id of the reporting party (e.g. CBOE).
reportingPartyAccount	Y	The Account of the reporting party.
sub_account	N	The Clearing Account of the reporting party.
cti_code	Y	The CTI Code of the reporting party; valid values are 1, 2, 3, or 4.
cmta	N	The CMTA (Give Up) of the reporting party.
capacity	Y	The Capacity of the reporting party; valid values are C (customer) or F (firm).
operatorid	Y	The Operator ID of the reporting party.
frequentTraderId	N	The Frequent Trader ID of the reporting party.
exec_source	Y	The execution source of the reporting party Valid values are [W, Y, C, G, H, D] W: Desk (High Touch) Y: Electronic C: Vendor-provided Platform billed by Executing Broker G: Sponsored Access via Exchange API or FIX provided by Executing Broker H: Premium Algorithmic Trading Provider billed by Executing Broker D: Other, including Other-provided screen
contra_efid-1	Y	The executing firm id (e.g. CBOE) for this contra.
contra_size_leg1-1	Y	Size allocated to this contra for the first leg.
contra_size_leg2-1	N	Size allocated to this contra for the second leg (if exists) .
contra_size_leg3-1	N*	Size allocated to this contra for the third leg (if exists).
contra_size_leg4-1	N*	Size allocated to this contra for the fourth leg (if exists).
contra_efid-2	N*	Format for adding additional counterparties. Up to 35 counterparties may be specified on any given trade report.
contra_size_leg1-2	N*
contra_size_leg2-2	N*
contra_size_leg3-2	N*
contra_size_leg4-2	N*
trade_type	Y	Either block or ecrp.
country_alpha2_code	Y	The Country of origin of the party to the Block/ECRP trade. Block and ECRP trades that include a country code for a comprehensively sanctioned country on either side of the trade will be rejected.

Example Response

{
    "code": "200",
    "msg": "Trade report successfully submitted",
    "data": {
        "referenceId": "5237D"
    }
}

New to Options?

Next Level Learning for More Advanced Investors

submitTrade