CME GC Allocator API - Message Specification - Get Trade

Request a trade by Side GUID. Results will be limited to active trades, and trades which have ended within the last 7 calendar days.

Content

Request

Parameter	Name	Location	Type	Multi-ple	Values	Usage	Description

Parameter	Name	Location	Type	Multi-ple	Values	Usage	Description
`CME-Application-Name`	Application Name	Header	`String`	No		REQUIRED	Name of the customer system that generated the message. Must match the system name as certified in AutoCert+ exactly.
`CME-Application-Vendor`	Application Vendor	Header	`String`	No		REQUIRED	Name of the vendor who provided the customer system. For a proprietary system, use the firm name.
`CME-Application-Version`	Application Version	Header	`String`	No		REQUIRED	Version identifier for the customer system.
`CME-Request-ID`	Request ID	Header	`String`	No		REQUIRED	Identifier for the customer message.
`CME-Transact-Time`	Transaction Time	Header	`DateTime`	No	Format: `yyyy-mm-ddThh:mm:ss.dZ`	OPTIONAL	Timestamp of when the message was sent from customer system.
`sideGuid`	Side GUID	Path	`String`	No		REQUIRED

Field	Name	Type	Values	Usage	Description

Field	Name	Type	Values	Usage	Description
payload[]	Payload	`Trade`

Field	Name	Type	Values	Usage	Description

Field	Name	Type	Values	Usage	Description
`collateralStatus`	Collateral Status	TradeCollateralStatus	`CANCELED` `FULL` `NONE` `PARTIAL`	ALWAYS
`dealId`	Deal ID	`String`		ALWAYS
`endCash`	End Cash	`Decimal`		CONDITIONAL	Not present for EONIA repos.
`endDt`	End Date	`Date`	Format: `yyyy-mm-dd`	ALWAYS
`executionTime`	Execution Time	`DateTime`	Format: `yyyy-mm-ddThh:mm:ss.dZ`	ALWAYS
`hardWarningTime`	Hard Warning Time	`DateTime`	Format: `yyyy-mm-ddThh:mm:ss.dZ`	CONDITIONAL	Always when `CollateralStatus <> FULL` and `SideIndicator = SELL`
`maximumCollateralInstruments`	Maximum Collateral Instruments	`Integer`		ALWAYS
`price`	Price	`Price`		ALWAYS
`qty`	Quantity	`Quantity`		ALWAYS
`softWarningTime`	Soft Warning Time	`DateTime`	Format: `yyyy-mm-ddThh:mm:ss.dZ`	CONDITIONAL	Always when `CollateralStatus <> FULL` and `SideIndicator = SELL`
`startCash`	Start Cash	`Decimal`		ALWAYS
`startDt`	Start Date	`Date`	Format: `yyyy-mm-dd`	ALWAYS
`tradeDt`	Trade Date	`Date`	Format: `yyyy-mm-dd`	ALWAYS
`tradeType`	Trade Type	TradeType	`PRIVATELY_NEGOTIATED` `REGULAR`	ALWAYS
`transactionTime`	Transaction Time	`DateTime`	Format: `yyyy-mm-ddThh:mm:ss.dZ`	ALWAYS
`venueType`	Venue Type	VenueType	`ELECTRONIC` `EXTERNAL` `QUOTE_DRIVEN`	ALWAYS
instrument	Instrument	`Instrument`
sides[]	Sides	`TradeSide`

Field	Name	Type	Values	Usage	Description

Field	Name	Type	Values	Usage	Description
`bilateralInd`	Bilateral Indicator	YesNoIndicator	`NO` `YES`	ALWAYS
`clearingOrganizationId`	Clearing Organization ID	`String`		CONDITIONAL	Always when `BilateralIndicator = NO`
`cusip`	CUSIP	`String`		CONDITIONAL	Only present on US securities.
`exchangeId`	Exchange ID	`String`		ALWAYS
`guid`	GUID	`String`		ALWAYS
`isin`	ISIN	`String`		CONDITIONAL	Only present on non-US securities.
`longName`	Long Name	`String`		ALWAYS
`productSubType`	Product Sub-Type	ProductSubType	`GC`	ALWAYS
`productType`	Product Type	ProductType	`REPO`	ALWAYS

Field	Name	Type	Values	Usage	Description

Field	Name	Type	Values	Usage	Description
`aggressorInd`	Aggressor Indicator	YesNoIndicator	`NO` `YES`	ALWAYS
`lastUpdateTime`	Last Update Time	`DateTime`	Format: `yyyy-mm-ddThh:mm:ss.dZ`	ALWAYS
`memo`	Memo	`String`		CONDITIONAL	Present if there is data from the user to populate.
`remainingAllocationQty`	Remaining Allocation Quantity	`Quantity`