These specifications are for CME ClearPort and CME Direct (Globex). ICC specifications are located here.
...
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
|
|---|
...
| Expand |
|---|
| 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
...
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: |
|---|
...
| Expand |
|---|
| 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.
...
| Expand |
|---|
| Output Parameters | Definition | Example | Supported Values | Data Types | Notes |
|---|
| service | Venue | CPC | CPC CMED | string |
| clearingFirm | Clearing ID | 027 | Yes | string |
| | accountNumber | Number of the account | DG-41 |
| string |
| | brokers | List of brokers enabled to trade the account (Firm - ShortName) and Full Name | CMEG |
| string |
| | shortName | Broker Short Name | 001 |
| string |
| | fullName | Broker Full Name | Test broker name 1 |
| string |
| | links | Information to navigate the site's REST interfaces dynamically |
|
| string |
|
|
POST Call to Update or Delete for Broker Permissions
...
| Code Block |
|---|
{
"clearingFirm": "GREENTEA_API_CLEARING2",
"accountNumber": "DV101218B",
"owner": "050",
"segType": "C",
"status": "Active"
} |
Input body for POST to update status to Active or Inactive
| Code Block |
|---|
{
"service": "CPC",
"clearingAccounts": [
{
"clearingFirm": "GREENTEA_API_CLEARING2",
"accountNumber": "DV101218B",
"status": "I"
}
]
} |
...