Table of Contents
Web Service Summary
| Group | Name | Path | Method | Description |
|---|---|---|---|---|
| Get Collateral | Get Collateral | /collateral/{collateralGuid} | GET | Request a collateral allocation by its GUID. Results will be limited to active trades, and trades which have ended within the last 7 calendar days. |
| Get Instruments | Get Instruments | /instruments/{guid} | GET | Request a general collateral repo instrument and the individual collateral instruments that are eligible to be allocated for it, by the GUID of the general collateral repo instrument. |
| Get Notifications | Get Notifications | /notifications/{notificationGuid} | GET | Request a notification by Notification GUID. Results will be limited to top-day notifications. |
| Get Trade | Get Trade | /trades/{sideGuid} | GET | Request a trade by Side GUID. Results will be limited to active trades, and trades which have ended within the last 7 calendar days. |
| Get Trade Instrument | Get Instrument for Trade | /instruments/trades/{sideGuid} | GET | 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. |
| List Trade Collateral | List Trade Collateral | /collateral/trades/{sideGuid} | GET | List all collateral allocations and substitutions currently in force on a trade. Results will be limited to active trades, and trades which have ended within the last 7 calendar days. |
| Search Collateral | Search Collateral | /collateral/search | GET | Request one ore more collateral allocations and/or substitutions using custom search criteria. Results will be limited to active trades, and trades which have ended within the last 7 calendar days. |
| Search Events | Search Events | /events/search | GET | Search for trade events. Results will be limited to top-day events. |
| Search Instrument | Search Instrument | /instrument/search | GET | Request a general collateral repo instrument and the individual collateral instruments that are eligible to be allocated for it, by the Product Identifier and custom Start and End Dates. |
| Search Notifications | Search Notifications | /notifications/search | GET | Request one or more notifications of intent to substitute an existing collateral allocation or substitution using customer search criteria. Results will be limited to top-day notifications. |
| Search Trades | Search for Trades | /trades/search | GET | Request one or more trades using custom search criteria. Results will be limited to active trades, and trades which have ended within the last 7 calendar days. |
| Submit Acknowledgments | Submit Acknowledgments | /notifications/acknowledgements | POST | Acknowledge a notification of substitution sent by trade counterparty. |
| Submit Collateral Allocations | Submit Collateral Allocation | /collateral | POST | Submit allocations of collateral. |
| Submit Collateral Substitutions | Submit Collateral Substitutions | /collateral/substitutions | POST | Submit substitutions of collateral. |
| Submit Notifications | Submit Notifications | /notifications | POST | Submit notification of intent to substitute an existing collateral allocation or substitution. |
GC API Reponses & Errors
The HTTP GET & Post Request to various GC API end points will result in following responses, in case of Errors.
Error Response Message - ErrorResponseMessage
| Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
| errors[] | Errors | Error | |||
Error - ErrorResponseMessage.errors[]
Field | Name | Type | Values | Usage | Description |
|---|---|---|---|---|---|
| code | Code | String | 400, 401 & 500 | ALWAYS | HTTP Error codes. |
| instance | Instance | String | OPTIONAL | ||
| message | Message | String | ALWAYS | A string detailing the actual error messages. | |
| referenceIndex | Reference Index | Integer | ALWAYS |
Error - Code
GC Allocator API uses standard HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success; codes in the 4xx range indicate an error resulting from the query request; and codes in the 5xx range indicate an error with the CME Group servers.
Code | Description |
|---|---|
| 200 | Returned on successful server response with response payload. |
| 400/404 | Invalid parameters or identifiers in Client request. |
| 401/403 | Incorrect Client API ID entitlement. Buy side allocation attempt. |
| 500 | Server side incorrect product configuration. |
| 503 | GC Allocator service unavailable. |