CME AMS API CME ClearPort and CME Direct - Globex - Specifications

These specifications are for CME ClearPort and CME Direct (Globex). ICC specifications are located here.

Contents

User Firms and Services 

GET Call

Returns results for all clearing firms, and all account management services that the customer is permissioned for.

Method

GET

URL

_/v#/myFirms/

URL Parameters

None

Pagination Enabled?

No

HATOAS Links

Links to retrieve permissioned accounts by service:

  • Retrieve CMED Accounts

  • Retrieve CPC Accounts

  • Retrieve ICC Accounts

Example Return Message

{ "entitlements": [ { "service": "CPC", "clearingFirms": [ { "firmName": "GREENTEA_API_CLEARING2", "firmLongName": "GREENTEA_API_CLEARING2", "clearingId": "780" } ] }, { "service": "CMED", "clearingFirms": [ { "firmName": "GREENTEA_API_CLEARING2", "firmLongName": "GREENTEA_API_CLEARING2", "clearingId": "780" } ] }, { "service": "ICC", "clearingFirms": [ { "firmName": "GREENTEA_API_CLEARING2", "firmLongName": "GREENTEA_API_CLEARING2", "clearingId": "780" } ] } ], "links": [ { "rel": "Retrieve CMED Accounts", "href": "_/v#/accounts/clearing/CMED/GREENTEA_API_CLEARING2" }, { "rel": "Retrieve CPC Accounts", "href": "_/v#/accounts/clearing/CPC/GREENTEA_API_CLEARING2" }, { "rel": "Retrieve ICC Accounts", "href": "_/v#/accounts/clearing/ICC/GREENTEA_API_CLEARING2" } ] }



Output Parameters

Output Parameters

Definition

Example

Supported Values

Data Types

Notes

Output Parameters

Definition

Example

Supported Values

Data Types

Notes

entitlements

Services and firms user has access to









service

Venue

CPC

CPC

CMED

ICC (Globex)

string



clearingFirms

Contains clearing firm information on firms user has access to









firmName

Firm identifier

GREENTEA_API_CLEARING1



string

unique

firmLongName

Firm identifier (firm long name)

GREENTEA_API_CLEARING1



string

not unique

clearingId

Firm identifier

984



string

unique

links

Links to navigate the site's REST interfaces dynamically





string



Return to top

Retrieve all Accounts

GET Call

Retrieves all of the accounts the user has access to for a specific service (venue), type (clearing) and clearing firm. Account owner and number are optional.

Method

GET

URL

_/v#/accounts/[Type]/[Service]/[Clearing Firm]/[Account Owner]/[Account Number]

Pagination Enabled?

Yes

HATEOAS Links

Links to retrieve all other account-related details:

  • get accountLimitsUtilization

  • get marketPermissions

  • get productPermissions

  • get brokerPermissions

  • get eligibleBrokers

  • get eligibleProducts

Input Parameters

Input Parameters

Definition

Example

Required?

Supported Values

Data Types

Notes

Input Parameters

Definition

Example

Required?

Supported Values

Data Types

Notes

type

Clearing account

clearing

Yes

clearing

string



service

Venue

CPC

Yes

CPC

CMED

ICC

string



clearingFirm 

Firm identifier

027

Yes



string



accountOwner

Firm that owns the account (uses it for trading)

Generic_trading

No



string



accountNumber

Number of the account

GT_12345

No



string



from

Audit date

2023-03-01

No



string



to

Audit date

2023-03-15

No



string





Venue: CME ClearPort Example Return Messages

{ "service": "CPC", "counts": 1, "clearingAccounts": [ { "clearingFirm": "GREENTEA_API_CLEARING1", "accountNumber": "4343", "owner": "bancone", "segType": "C", "status": "Active", "ownerLongName": "Banc One", "links": [ { "rel": "self", "href": "https://amsapinr.cmegroup.com/rest/v2/accounts/clearing/CPC/GREENTEA_API_CLEARING1?accountNumber=4343" }, { "rel": "get accountLimitsUtilization", "href": "https://amsapinr.cmegroup.com/rest/v2/accountLimitsUtilization/clearing/CPC/GREENTEA_API_CLEARING1/4343" }, { "rel": "get marketPermissions", "href": "https://amsapinr.cmegroup.com/rest/v2/marketPermissions/clearing/CPC/GREENTEA_API_CLEARING1/4343" }, { "rel": "get productPermissions", "href": "https://amsapinr.cmegroup.com/rest/v2/productPermissions/clearing/CPC/GREENTEA_API_CLEARING1/4343" }, { "rel": "get brokerPermissions", "href": "https://amsapinr.cmegroup.com/rest/v2/brokerPermissions/clearing/CPC/GREENTEA_API_CLEARING1/4343" }, { "rel": "get eligibleBrokers", "href": "https://amsapinr.cmegroup.com/rest/v2/eligibleBrokers/clearing/CPC/GREENTEA_API_CLEARING1/4343" }, { "rel": "get eligibleProducts", "href": "https://amsapinr.cmegroup.com/rest/v2/eligibleProducts/clearing/CPC/GREENTEA_API_CLEARING1/4343" } ] }, ]

 

Venue: CME Direct

{ "service": "CMED", "counts": 2, "clearingAccounts": [ { "clearingFirm": "GREENTEA_API_CLEARING2", "accountNumber": "DV101218B", "owner": "0202TP4", "segType": "C", "status": "Active", "senderComp": "XX0212", "links": [ { "rel": "self", "href": "_/v#/accounts/clearing/CMED/GREENTEA_API_CLEARING2?accountNumber=DV101218B" }, { "rel": "get accountLimitsUtilization", "href": "_/v#/accountLimitsUtilization/clearing/CMED/GREENTEA_API_CLEARING2/DV101218B" }, { "rel": "get marketPermissions", "href": "_/v#/marketPermissions/clearing/CMED/GREENTEA_API_CLEARING2/DV101218B" }, { "rel": "get productPermissions", "href": "_/v#/productPermissions/clearing/CMED/GREENTEA_API_CLEARING2/DV101218B" }, { "rel": "get brokerPermissions", "href": "_/v#/brokerPermissions/clearing/CMED/GREENTEA_API_CLEARING2/DV101218B" }, { "rel": "get eligibleBrokers", "href": "_/v#/eligibleBrokers/clearing/CMED/GREENTEA_API_CLEARING2/DV101218B" }, { "rel": "get eligibleProducts", "href": "_/v#/eligibleProducts/clearing/CMED/GREENTEA_API_CLEARING2/DV101218B" } ] } ], "limit": 50, "offset": 1, "availableOffsets": 1 }

Output Parameters

Output Parameters

Definition

Example

Supported Values

Data Types

Notes

Output Parameters

Definition

Example

Supported Values

Data Types

Notes

service

Venue

CPC

CPC

CMED

string



counts

Number of accounts returned

2



number



type

Clearing  account

clearingAccounts

clearingAccounts

string



id

Unique alias

A-7400



string



clearingFirm

Firm identifier

092



string



accountNumber

Number of the account

OTCFXACCT2



string



owner

Trading Firm Owner of the account

KRBroker7



string



segType

Account segregation Customer or House

H

C

H

string



status

Status of an account

active

active

inactive

closed

string



senderComp

CMED only: senderComp associated to an account specific to venue

2MG350



string

Only for Service CMED

assetmanager

Asset Manager assigned to an account

ENERGY ACTIVE TRADERS



string

optional field may or may not have a value

links

Information to navigate the site's REST interfaces dynamically.









Return to top

Limits and Utilization for an Account

GET Call

Retrieves all limits and utilization for a specific account by venue.

Method

GET

URL

_/v#/accountLimitsUtilization/[Type]/[Service]/[Clearing Firm]/[Account Number]

Pagination Enabled?

No

HATOAS Links

Links available from an Account Limits Utilization query:

  • get/update accountLimitsUtilization

  • delete accountLimitsUtilization

Notes

  • Products with unlimited long / short limits with utilization in the current business day will be included.

  • Products with unlimited long / short limits without utilization in the current business day will be excluded.

Input Parameters

Input Parameters

Definition

Example

Required?

Supported Values

Data Types

Notes

Input Parameters

Definition

Example

Required?

Supported Values

Data Types

Notes

type

Clearing  account

clearing

Yes

clearing

string



service

Venue

CPC

Yes

o

string

one service at a time

clearingFirm

Firm identifier

027

Yes



string



accountNumber

Number of the account

011

Yes



string



tradable

Retrieve limit utilization for tradable products

true

No

true

false

string

When called with tradable=true, any products with limits, that are no longer tradable for the account are filtered out. 

If not supplied, this defaults to false.

nonZeroLimits

Filter products with 0 (zero) limits

true

No

true

false

string

If nonZeroLimits=true, then any products that have 0 limits will be filtered out.



Example Return Messages for Venue CME ClearPort





Output Parameters

Output Parameters

Definition

Example

Supported Values

Data Types

Notes

Output Parameters

Definition

Example

Supported Values

Data Types

Notes

service

Venue

CPC

CPC

CMED

string



clearingFirm

Firm identifier

027



string



accountNumber

Number of the account

011



string



limits

Returns limits information by credit control type

limits

limit information

string



product

Symbol.ProductType.Exchange

11.FUT.CBT



string

Also used with Span Limit.

productFullName

Full name of product

$10 DOW JONES FUTURES



string



currency

currency for RAV Limit or Credit Limit

USD



string

Used with RAV  Limit or Credit Limit.

limitType

Used for RAV limit or Credit limit

RAV Limit - CPC

Credit Limit - CMED



string



limit

Amount of RAV limit or Credit limit

999999999



number



usage

Amount usage of RAV limit or Credit limit

999999



number

Used with RAV  Limit or Credit Limit.

productLimits

Value of the limit

20



number

Limit field will be populated if there is any value set.

short

Short Limit for Product

10000



number



long

Long Limit for Product

10000



number



netFills

The difference between the working long and short





number



workingLong

The portion of the long limit that is being used





number



workingShort

The portion of the short limit that is being used





number



links

Information to navigate the site's REST interfaces dynamically





string




POST Call

Update, add or delete account limits using the accountsLimitsUtilization POST call.

  • To post a delete, append the call with ?delete=true

  • When Request body is submitted for Limits Update (Post) or Delete - usage field is ignored, it cannot be updated

  • Usage, Working Long, Working Short, and Net Fills cannot be edited



Method

POST

Function

Update or Delete Limits for an Account

URL

_/v#/accountLimitsUtilization/[Type]/[Service]/[Clearing Firm]/[Account Number]

Pagination Enabled?

No

HATOAS Links

Links available from an Account Limits Utilization query:

  • get/update accountLimitsUtilization

  • delete accountLimitsUtilization

Input Parameters



Example Input Body and Return Messages

Input Body for Limits Update 

Update product 11.FUT.CBT short limit from 10000 to 500.

See input specifications for RAV Limit or Credit Limit.

Output After Update 

Will have all records, updated limit and reference links.

Return to top

Market Type Permissions for an Account

GET Call

Retrieves market permissions for a specific account, by service, clearing firm and account number. CPC and CMED only.

Method

GET

URL

_/v#/marketPermissions/[Type]/[Service]/[Clearing Firm]/[Account Number]

Pagination Enabled?

Yes

HATOAS Links

Links available from a Market Permissions query:

  • get/update marketPermissions

  • delete marketPermissions

Input Parameters


Example Return Message



Output Parameters

POST Call

Add or delete market permissions for a specific account, by service.

  • To post a delete, append the call with ?delete=true

Method

POST

URL

_/v#/marketPermissions/[Type]/[Service]/[Clearing Firm]/[Account Number]

Pagination Enabled?

Yes

HATOAS Links

Links available from a Market Permissions query:

  • get/update marketPermissions

  • delete marketPermissions

Input Parameters

Example Input Body and Return Messages

Input Body for Market Permissions

Update Market permissions for CBOT (CME ClearPort) from "Specific" to "None."

Output After Update 
Will have all records, updated market permissions and reference links. CBOT (CME ClearPort) market permissions are now "None."

Return to top

Eligible Products and Permissioned Products for an Account

GET Call to Retrieve Eligible Products

Retrieves all eligible products for a specific account, by venue.

Method

GET

URL

_/v#/eligibleProducts/[Type]/[Service]/[Clearing Firm]/[Account Number]

Pagination Enabled?

Yes

HATOAS Links

Links available from an Eligible Products query::

  • get/update productPermissions

  • delete productPermissions

Input Parameters

Example Return Message with Venue CME ClearPort 

This is a partial list, all eligible products will be returned on the call.



Output Parameters

GET Call to Retrieve Permissioned Products

Retrieves all products permissioned for the Account by service, clearing firm and account number.

Method

GET

URL

_/v#/productPermissions/[Type]/[Service]/[Clearing Firm]/[Account Number]

Pagination Enabled?

Yes

HATOAS Links

Links to available from a Product Permissions query:

  • get/update productPermissions

  • delete productPermissions

Input Parameters

Example Return Message for CPC service

Output Parameters

POST Call to Update or Delete Product Permissions

  • To add products, the account must be permissioned for the market type for the product.

  • To post a delete, append the call with ?delete=true

Method

POST

URL

_/v#/productPermissions/[Type]/[Service]/[Clearing Firm]/[Account Number]

Pagination Enabled?

No

HATOAS Links

Links available from a Product Permissions query:

  • get/update productPermissions

  • delete productPermissions

Input Parameters

Example Input Body and Return Messages

Example Input Body

Example Return Message

Return to top

Eligible Brokers and Permissioned Brokers for an Account

GET Call to Retrieve Eligible Brokers

Input Parameters

Example Return Message

Example return message for CPC service.



Output Parameters

GET Call to Retrieve Broker Permissions

Return permissions for eligible brokers for an account, based on account market permissions.

Method

GET

URL

_/v#/brokerPermissions/[Type]/[Service]/[Clearing Firm]/[Account Number]

Pagination Enabled?

Yes

HATOAS Links

Links available from a Broker Permissions query:

  • get/update brokerPermissions

  • delete brokerPermissions

Input Parameters


Example: GET Call to Retrieve Broker Permissions



Output Parameters

POST Call to Update or Delete for Broker Permissions

  • To post a delete, append the call with ?delete=true

Method

POST

URL

_/v#/brokerPermissions /[Type]/[Service]/[Clearing Firm]/[Account Number]

Pagination Enabled?

No

HATOAS Links

Links available from a Broker Permissions query:

  • get/update brokerPermissions

  • delete brokerPermissions

Input Parameters

 

Example Input Body and Return Message

Example Input Body

Output after Update

Return to top

Copy an Existing Account to Create New Accounts

Note: This option is only applicable to accounts with CME ClearPort and/or CME Direct (CME Globex) services. 

Method

POST

URL

_/v#/copy/[Type]/[Clearing Firm]

Pagination Enabled?

No

Input Parameters

Definition

Example

Required?

Supported Values

Data Types

Notes

Input Parameters

Definition

Example

Required?

Supported Values

Data Types

Notes

templateAccountNumber

Template account, copy from

01080815



string





accountNumbers

List of the accounts numbers that have to be created

newCopyic12,

newCopyic13



List of string





Example: Copy an Existing Account to Create New Accounts

Input for Copy Existing Account

The body content for copy an existing account has the template account that will be copied from, and the numbers for the new accounts will be created.


Output for Copy Existing Accounts

The output will have information for the new accounts. This example shows a successful account creation and the error message that will display if the new account number that is used is a duplicate of an existing account.

Return to top

Update an Account to Active or Inactive

Method

POST

URL

_/v#/status/[type]/[clearingFirm]

Pagination Enabled?

No

Input Parameters

Example: Update an Account to Active or Inactive

Account Information Before Update

Clearing Firm account information only, as shown in a "Retrieve all Accounts" call.

Input body for POST to update status to Active or Inactive

Successful Return Message


Account information after update

Output Parameters will be account parameters with updated status. Status is now "Inactive." 




How was your Client Systems Wiki Experience? Submit Feedback

Copyright © 2024 CME Group Inc. All rights reserved.