CME GC Allocation API - Message Specification - Search Collateral
Request one ore more collateral allocations and/or substitutions using custom search criteria. Results will be limited to active trades, and trades that 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 |
|---|---|---|---|---|---|---|---|
| Application Name | Header |
| No |
| REQUIRED | Name of the customer system that generated the message. Must match the system name as certified in AutoCert+ exactly. |
| Application Vendor | Header |
| No |
| REQUIRED | Name of the vendor who provided the customer system. For a proprietary system, use the firm name. |
| Application Version | Header |
| No |
| REQUIRED | Version identifier for the customer system. |
| Request ID | Header |
| No |
| REQUIRED | Identifier for the customer message. |
| Transaction Time | Header |
| No | Format: | OPTIONAL | Timestamp of when the message was sent from customer system. |
| Collateral GUID | Query |
| No |
| OPTIONAL |
|
| End Last Update Time | Query |
| No | Format: | OPTIONAL |
|
| End Substitutions Remaining Count | Query |
| No |
| OPTIONAL |
|
| End Transaction Time | Query |
| No | Format: | OPTIONAL |
|
| General Collateral Instrument CUSIP | Query |
| No |
| OPTIONAL |
|
| Exchange ID | Query |
| No |
| OPTIONAL |
|
| General Collateral Instrument GUID | Query |
| No |
| OPTIONAL |
|
| General Collateral Instrument ISIN | Query |
| No |
| OPTIONAL |
|
| Instrument CUSIP | Query |
| No |
| OPTIONAL |
|
| Instrument GUID | Query |
| No |
| OPTIONAL |
|
| Instrument ISIN | Query |
| No |
| OPTIONAL |
|
| Original Collateral GUID | Query |
| No |
| OPTIONAL |
|
| Side GUID | Query |
| No |
| OPTIONAL |
|
| Start Last Update Time | Query |
| No | Format: | OPTIONAL |
|
| Start Substitutions Remaining Count | Query |
| No |
| OPTIONAL |
|
| Start Transaction Time | Query |
| No | Format: | OPTIONAL |
|
| Collateral Status | Query | No |
| OPTIONAL |
| |
| Substitution Indicator | Query | No |
| OPTIONAL |
|
Response - 200
Body
Collateral Response Message - CollateralResponseMessage
Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
Payload |
|
|
|
|
Collateral - CollateralResponseMessage.payload[]
Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
| Accrued Interest Amount |
|
| CONDITIONAL |
|
| Clean Price |
|
| ALWAYS |
|
| Collateral GUID |
|
| ALWAYS |
|
| Deal ID |
|
| ALWAYS |
|
| Dirty Price |
|
| ALWAYS |
|
| End Cash |
|
| CONDITIONAL |
Not present for EONIA repos.
|
| Last Update Time |
| Format: | ALWAYS |
|
| Notification Quantity |
|
| CONDITIONAL |
Aggregate quantity of all remaining, unfilled notifications on this allocation
|
| Original Collateral GUID |
|
| CONDITIONAL |
|
| Original Transaction Time |
| Format: | ALWAYS |
|
| Original Venue Collateral Number |
|
| CONDITIONAL |
|
| Quantity |
|
| ALWAYS |
|
| Side GUID |
|
| ALWAYS |
|
| Side Indicator |
| ALWAYS |
| |
| Start Cash |
|
|