CME GC Allocator API - Message Specification - Search Notifications

Owned by
CME Group
Apr 26, 2024
3 min read

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.

URL

/notifications/search

HTTP Method

GET

Version

1.0.30

Content







Request

Parameters

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.

acknowledgementStatus

Acknowledgement Status

Query

TransactionAcknowledgementStatus

No

  • ACKNOWLEDGED

  • CANCELED

  • COMPLETED

  • NOTIFIED

OPTIONAL



exchangeId

ExchangeId

Query

String

No



OPTIONAL



Accepts BTEU for BrokerTec EU, or BTUS for BrokerTec US



notificationGuid

Notification GUID

Query

String

No



OPTIONAL



verboseInd

Verbose Indicator

Query

YesNoIndicator

No

  • NO

  • YES

OPTIONAL



Allows for responses with additional fields



Response - 200

Body

Collateral Notification Response Message - CollateralNotificationResponseMessage

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

payload[]

Payload

CollateralNotification







Collateral Notification - CollateralNotificationResponseMessage.payload[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

acknowledgementStatus

Acknowledgement Status

TransactionAcknowledgementStatus

  • ACKNOWLEDGED

  • CANCELED

  • COMPLETED

  • NOTIFIED

ALWAYS



notificationGuid

Notification GUID

String



ALWAYS



notificationQty

Notification Quantity

Integer



ALWAYS



notificationQtyRemaining

Notification Remaining Quantity

Integer



ALWAYS



notificationSequenceNbr

Notification Sequence Number

String



ALWAYS



transactionTime

Transaction Time

DateTime

Format:  yyyy-mm-ddThh:mm:ss.dZ

ALWAYS



verboseInd

Verbose Indicator

YesNoIndicator

  • NO

  • YES

ALWAYS



collateral

Collateral

Collateral







trade

Trade

Trade







Collateral - CollateralNotificationResponseMessage.payload[].collateral

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

collateralGuid

CollateralGuid

String



ALWAYS



The collateralGuid associated with the notification record at the time of the query. May change over time.



lastUpdateTime

Last Update Time

DateTime

Format:  yyyy-mm-ddThh:mm:ss.dZ

CONDITIONAL

  • Always when  VerboseIndicator = YES

instrument

Instrument

Instrument







Instrument - CollateralNotificationResponseMessage.payload[].collateral.instrument

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

longName

Long Name

String



CONDITIONAL

  • Always when  VerboseIndicator = YES

Trade - CollateralNotificationResponseMessage.payload[].trade

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

dealId

Deal ID

String



ALWAYS



endDt

End Date

Date

Format:  yyyy-mm-dd

CONDITIONAL

  • Always when  VerboseIndicator = YES

price

Price

Price



CONDITIONAL

  • Always when  VerboseIndicator = YES

qty

Quantity

Quantity



CONDITIONAL

  • Always when  VerboseIndicator = YES

startDt

Start Date

Date

Format:  yyyy-mm-dd

CONDITIONAL

  • Always when  VerboseIndicator = YES

instrument

Instrument

Instrument



sides[]

Sides

TradeSide







Instrument - CollateralNotificationResponseMessage.payload[].trade.instrument

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

exchangeId

Exchange ID

String



ALWAYS



longName

Long Name

String



CONDITIONAL

  • Always when  VerboseIndicator = YES

Trade Side - CollateralNotificationResponseMessage.payload[].trade.sides[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

sideGuid

Side GUID

String



ALWAYS



sideInd

Side Indicator

MarketSideIndicator

  • BUY

  • SELL

CONDITIONAL

  • Always when  VerboseIndicator = YES

tradeId

Trade ID

String



ALWAYS



entities

Entities

TradeSideEntities







Trade Side Entities - CollateralNotificationResponseMessage.payload[].trade.sides[].entities

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

executingFirmId

Executing Firm ID

String



CONDITIONAL

  • Always when  VerboseIndicator = YES

operatorId

Operator ID

String



CONDITIONAL

  • Always when  VerboseIndicator = YES

Response - 400

Body

Error Response Message - ErrorResponseMessage

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

errors[]

Errors

Error 







Error - ErrorResponseMessage.errors[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

code

Code

String



ALWAYS



instance

Instance

String



OPTIONAL



message

Message

String



ALWAYS



referenceIndex

Reference Index

Integer



ALWAYS



Response - 401

Response - 404



How was your Client Systems Wiki Experience? Submit Feedback

Copyright © 2024 CME Group Inc. All rights reserved.