CME STP BaCE API Functional Specification

Submit trade records

saveDeals(username, password, CHML.Deals.Deal)

Verify and reject trades, and update reference numbers for trades

updateDeals(username, password, CHML.CHRequest.UpdateRequest)

Retrieve reference data

getReferenceData(username, password, CHML.CHRequest.RefDataQuery)

Change a user password 

changePassword(username, password, newPassword)

CHDealID

CME STP BaCE uses this to uniquely identify a trade. This ID does not change across multiple versions of a trade.

CHDealID="10261356"

CHDealID="10261356"

CHTransactionID

CME STP BaCE uses this to uniquely identify a version of a trade. This ID changes for each version of a trade, and it is globally unique.

CHTransactionID=""1242334"

CHTransactionID=""1258794"

CHVersionID

CME STP BaCE uses this to uniquely identify the version number of the trade. It is incremented with each trade amendment.

CHVersionID="1"

CHVersionID="2"

username

Username provided by CME STP BaCE. Usually a username dedicated to the API.

string

password

Password provided by CME STP BaCE.

string

CHML.Deals.Deal

An XML string that represents one or more deals (trade records). For a complete list of request parameters, refer to "Submitting trade records (CHML.Deals.Deal)" in the CME BaCE XML Schema Reference. To submit multiple trade records, create the Deals element, which can contain multiple Deal elements.

string

username

Username provided by CME STP BaCE. Usually and API dedicated username.

string

password

Password provided by CME STP BaCE.

string

CHML.CHRequest.UpdateRequest

An XML string that represents the information to update in the trade. There are three types of update:

• verify

• reject

• update reference number

string

username

Username provided by CME STP BaCE. Usually a username dedicated to the API.

string

password

Password provided by CME STP BaCE.

string

CHML.CHRequest.RefDataQuery

An XML string that represents query parameters. For a complete list of request parameters, refer to "Querying CME STP BaCE for reference-data tables in the database (CHML.CHRequest.RefDataQuery)" in the CME STP BaCE XML Schema Reference.

string

TableName

Table name to query for reference data. If this is not specified, CME STP BaCE returns all tables in the reference data.

string

UpdatedSinceDate

•        To retrieve reference data added or updated in the table after a certain date, specify that date in the U.S. Eastern time zone, which may be adjusted for Daylight Savings Time, depending on the time of year.

•        To retrieve all reference data from this table, you can omit this attribute.

The date and time have the following format:

YYYY-MM-DDThh:mm:ss.nnn, for example, 2012-03-05T10:02:24.617 

dateTime

username

Username provided by CME STP BaCE. Usually an API dedicated username.

string

password

Password provided by CME STP BaCE.

string

newPassword

New password.

string

3

This indicates password or account errors.

Generate an alert, pause the service, and inspect your credentials.

10

This indicates that the submitted XML document has an unknown format.

Generate an alert. Do not retry the transaction, which is problematic and must be corrected.

12

This indicates an error in the request due to invalid XML. This may be caused by one of the following, as indicated in the error message:

• XML schema validation error.

• Deal node not found.

• Schema version not found.

• CHML node is empty.

Generate an alert. Do not retry the transaction, which is problematic and must be corrected.

17

This indicates an error in the request for one of the following reasons, as indicated in the error message:

• Invalid SubmitterTypeID.

• TradingCompany node is required but not found.

• Counterparty node is required but not found.

• Broker node is required but not found.

• Invalid broker. The expected value of the Broker.BrokerageCompanyID attribute is indicated in the error message.

• Invalid exchange. The expected value of the Exchange.ExchangeCompanyID attribute is indicated in the error message.

• Invalid Deal.CommodityId attribute. The value of the attribute is indicated in the error message.

• Invalid Deal.DealType attribute. The value of the attribute is indicated in the error message. The value must be either Physical or Financial.

• Invalid Submitter.SubmitterId attribute. The value of the attribute is indicated in the error message.

• Submitter.BidFlag attribute is required but not found.

•  TradingCompany.BidFlag attribute is required but not found.

• Counterparty.BidFlag attribute is required but not found.

• Invalid Submitter.BidFlag attribute. The value of the attribute is indicated in the error message. It must be 0 or 1.

• Submitter.BidFlag attribute must be the same as TradingCompany.BidFlag.

• Submitter.BidFlag attribute cannot be the same as Counterparty.BidFlag.

• The indicated value of the TradingCompany.ReferenceNumber attribute must be the same as the indicated value of the Submitter.SubmitterDealID attribute.

• TradingCompany.CompanyId attribute is required but not found.

• Invalid TradingCompany.CompanyId attribute. The value of the attribute is indicated in the error message.

• Authorization failed, because the specified user is not authorized to submit deal with the specified CHBatchID, CompanyID, CommodityID, and DealType.

• Submission failed, because it was an attempt to submit the specified version of the deal when a newer version already exists.

Generate an alert. Do not retry the transaction, which is problematic and must be corrected.

26

This indicates an expired password.

Generate an alert, pause the service, and inspect your credentials.

Use the changePassword API method to change your password.

You can resubmit after changing your password.

100

This general service error often indicates connection timeouts or other system issues not captured by other error codes.

Generate an alert, but keep retrying the transaction.

The CME STP BaCE API service may be unavailable some nights and weekends for regular maintenance. Please consider this in your alerting mechanism.