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
- 1 User Firms and Services
- 1.1 GET Call
- 2 Retrieve all Accounts
- 2.1 GET Call
- 3 Limits and Utilization for an Account
- 4 Market Type Permissions for an Account
- 5 Eligible Products and Permissioned Products for an Account
- 6 Eligible Brokers and Permissioned Brokers for an Account
- 7 Copy an Existing Account to Create New Accounts
- 8 Update an Account to Active or Inactive
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:
|
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
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:
|
Input Parameters
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
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:
|
Notes |
|
Input Parameters
Example Return Messages for Venue CME ClearPort
{
"service": "CPC",
"clearingFirm": "GREENTEA_API_CLEARING2",
"accountNumber": "DV101218B",
"limits": [
{
"currency": "USD",
"limitType": "RAV Limit",
"limit": 999999999999999,
"usage": 0
},
{
"product": "11.FUT.CBT",
"productFullName": "$10 DOW JONES FUTURES",
"productLimits": {
"short": 10000,
"long": 10000
},
"netFills": "",
"workingLong": "",
"workingShort": ""
},
{
"product": "11.OOF.CBT",
"productFullName": "$10 DOW JONES OPTIONS",
"productLimits": {
"short": 10000,
"long": 10000
},
"netFills": "",
"workingLong": "",
"workingShort": ""
},
{
"product": "CL.FUT.NYMEX",
"productFullName": "Light Sweet Crude Oil Futures",
"productLimits": {
"short": "unlimited",
"long": "unlimited"
},
"netFills": 0,
"workingLong": 0,
"workingShort": 0
}
]
}
"links": [
{
"rel": "get/update accountLimitsUtilization",
"href": "_/v#/accountLimitsUtilization/clearing/CPC/GREENTEA_API_CLEARING2/GREENTEA_DV101218B"
},
{
"rel": "delete accountLimitsUtilization",
"href": "_/v1/accountLimitsUtilization/clearing/CPC/GREENTEA_API_CLEARING2/GREENTEA_DV101218B?delete=true"
}
]
}
Output Parameters
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:
|
Input Parameters
How was your Client Systems Wiki Experience? Submit Feedback
Copyright © 2024 CME Group Inc. All rights reserved.