These specifications are for Inline Credit Controls. CME Direct and CME ClearPort specifications are located
here.
...
Returns results for all clearing firms, and Account management services that the customer has access to.
| 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 / fradingFirms | Contain 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 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 | ICC | ICC | 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. | | executionFirms | List of execution Firms and suspended status |
|
| Execution firm and suspended information |
| | efID | Execution Firm ID |
|
| String |
| suspended | Is Firm Suspended | N | N |
| Should always be N | | links | Links to navigate the site's REST interfaces dynamically |
|
|
|
|
|
Return to top
Retrieve Eligible Products for an Account
...
| Expand |
|---|
| Output Parameters | Definition | Example | Supported Values | Data Types | Notes |
|---|
| service | Venue | ICC |
| string |
| | clearingFirm | Firm identifier | 027 |
| string |
| | accountNumber | Number of the account | 011 |
| string |
| | products | Indicates return of products for one or more services |
|
| String |
| | executionFirm | Execution firm identifier for ICC | 0OJ |
| string |
| | productList | Encapsulates list of products | productList |
| string |
| | product | Symbol.ProductType.Exchange | GLB.FUT.CME |
| string |
| | productFullName | Full name of product | ONE-MONTH SOFR FUTURES |
| string |
| | links | Information to navigate the site's REST interfaces dynamically: - get/update accountLimitsUtilization
- delete accountLimitsUtilization
|
|
| string |
|
|
...
Retrieve status (suspended = "Y" or "N") for a Clearing Firm's execution firms.
Method | GET |
|---|
URL | _/v#/efStatus/[Type]/[Service]/[Clearing Firm]/[Account Number] |
|---|
Pagination Enabled? | Yes |
|---|
| HATEOAS Links | Links to available from Execution Firm Status call: |
|---|
...
| Expand |
|---|
| Output Parameters | Definition | Example | Supported Values | Data Types | Notes |
|---|
| service | Venue | ICC |
| string |
| | clearingFirm | Firm identifier | 027 |
| string |
| | accountNumber | Number of the account | 011 |
| string |
| | owner | Account Owner | Account Owner |
| String |
| | executionFirms | Execution firms associated with the Account | returns execution firm and suspended status |
| string |
| | efID | Executing firm ID | 4V9 |
| string |
| | suspended | Status - is suspended or not | N | Y, N | string |
| | links | Information to navigate the site's REST interfaces dynamically: |
|
| string |
|
|
Return to top
...
Update status (suspended = "Y" or "N") for one or more of a Clearing Firm's execution firms. If suspended, an account cannot trade.
Method | POST |
|---|
URL | _/v#/efStatus/[Type]/[Service]/[Clearing Firm]/[Account Number] |
|---|
Pagination Enabled? | Yes |
|---|
| HATEOAS Links | Links to available from Execution Firm Status call: |
|---|
...