CME GC Allocator API - Message Specification - Get Instrument for Trade
Request a general collateral repo instrument and the individual collateral instruments that are eligible to be allocated for it, by the Side Guid of the trade where it was used. Results will be limited to active trades, and trades which have ended within the last 7 calendar days.
URL |
|
---|---|
HTTP Method |
|
Version | 1.0.30 |
Content |
---|
Â
Â
Â
Request
Parameters
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 | Â |
Response - 200
Body
Instrument Response Message - InstrumentResponseMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
payload[] | Payload | Instrument | Â | Â | Â |
Instrument - InstrumentResponseMessage.payload[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
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 | Â |
priceSource | Price Source |
| ALWAYS | Price applied for the cash flow valuation | |
collateral[] | Collateral | Instrument | Â | Â | Â |
Instrument - InstrumentResponseMessage.payload[].collateral[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
cleanPrice | Clean Price | Price | Â | ALWAYS | Â |
couponRt | Coupon Rate | Decimal | Â | ALWAYS | Â |
cusip | CUSIP | String | Â | CONDITIONAL | Only present on US securities. |
dirtyPrice | Dirty Price | Price | Â | ALWAYS | Â |
guid | GUID | String | Â | ALWAYS | Â |
isin | ISIN | String | Â | CONDITIONAL | Only present on non-US securities. |
longName | Long Name | String | Â | ALWAYS | Â |
maturityDt | Maturity Date | Date | Format:Â yyyy-mm-dd | ALWAYS | Â |
Response - 401
Response - 404
How was your Client Systems Wiki Experience? Submit Feedback
Copyright © 2024 CME Group Inc. All rights reserved.