/getEnumerations

https://[domain]/ws/eca/getEnumerations

  • Service to check query updated list of ECA enumerations for attributes included within elements such as TradingPermission, FinancialInformation, ExtPositionTransfer, AffiliationDetails, etc.

    • Response file will include CSV file with list of enumeration values.

  • HTTP Request Type: POST

Name

Value

Description

Usage

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

 

Required

type

FIN_INFO_RANGES

EMPLOYEE_TRACK

BUSINESS_OCCUPATION

EXCHANGE_BUNDLES

ACATS

MARKET_DATA

PROHIBITED_COUNTRY

EDD_AVT

EMPLOYEE_PLANS

FIN_INFO_RANGES= Query most up to date range IDs by currency  for annual_net_income, net_worth, liquid_net_worth.

 

EMPLOYEE_TRACK= Query most up to date company_id for account. Used if AffiliationDetails, if the company has an existing IBKR Employee Track account.

 

BUSINESS_AND_OCCUPATION = List of occupation AND employer_business for EmployerD EmploymentDetails.

 

EXCHANGE_BUNDLES = Query most up to date ECA Enumerations for TradingPermissions exchange_group.

 

ACATS =Query most up to date values for broker_id and broker_name. Used if funding via ACATS (ExtPositionsTransfer).

 

MARKET_DATA= Query MDServices for the Market Data subscriptions.

 

PROHIBITED_COUNTRY=

  • Applicants that reside in PROHIBITED_COUNTRY are restricted from opening an account with IBKR. Error will be thrown IF LegalResidenceCountry, OR country (included within Residence, MailingAddress and employer_address, TaxResidency node) = PROHIBITED_COUNTRY

  • citizenship OR CountryOfBirth = PROHIBITED_COUNTRY, Prohibited Country Questionnaire will be assigned to the account.

EDD_AVT= Query questions associated with EDD (Enhanced Due Diligence) or AVT (Additional Verification) tasks assigned to an account.

EMPLOYEE_PLANS: View EPA associated with the master account.

Required

currency
AUD  GBP  KRW PLN USD
CAD  HKD  MXN RUB  
CHF  ILS  SEK SGD  
EUR  JPY NZD TRY  

 

Required if type=FIN_INFO_RANGES only.

formNumber

String

Form number associated with the EDD/AVT (Additional Verification) task.

Use the following endpoints to query the form number:

/getPendingTasks

/getRegistrationTasks

Required if type=EDD_AVT only.

JSON Request

Copy 
{
  "CSID":"<client-service-id>",
  "type":"<type>"
}
 
 

Sample

CopyACATS 
curl -H "Content-Type: application/json" -k -XPOST  https://api.ibkr.com/ws/eca/getEnumerations -d '{"CSID":"TESTERCSID", "type":"ACATS"}' 
Copy
exchange_group (Trading Permissions)
curl -H "Content-Type: application/json" -k -XPOST  https://api.ibkr.com/ws/eca/getEnumerations -d '{"CSID":"TESTERCSID", "type":"EXCHANGE_BUNDLES"}' 
Copy
employer_business
curl -H "Content-Type: application/json" -k -XPOST  https://api.ibkr.com/ws/eca/getEnumerations -d '{"CSID":"TESTERCSID", "type":"BUSINESS_AND_OCCUPATION"}' 
Copy
company_id
curl -H "Content-Type: application/json" -k -XPOST  https://api.ibkr.com/ws/eca/getEnumerations -d '{"CSID":"TESTERCSID", "type":"EMPLOYEE_TRACK"}' 
Copy
FinancialInformation
curl -H "Content-Type: application/json" -k -XPOST  https://api.ibkr.com/ws/eca/getEnumerations -d '{"CSID":"TESTERCSID", "currency":"USD", "type":"FIN_INFO_RANGES"}'
CopyMARKET_DATA 
curl -H "Content-Type: application/json" -k -XPOST  https://api.ibkr.com/ws/eca/getEnumerations -d '{"CSID":"TESTERCSID", "type":"MARKET_DATA"}' 
CopyPROHIBITED_COUNTRY 
curl -H "Content-Type: application/json" -k -XPOST  https://api.ibkr.com/ws/eca/getEnumerations -d '{"CSID":"TESTERCSID", "type":"PROHIBITED_COUNTRY"}' 
CopyEDD/AVT 
curl -H "Content-Type: application/json" -k -XPOST  https://api.ibkr.com/ws/eca/getEnumerations -d '{"CSID":"TESTERCSID", "type":"EDD_AVT","formNumber":"3400"}'