/getClientData

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

  • Service query list of accounts that meet certain criteria.

    • State and/or country of residence

    • Fee configuration

    • Market data services

    • Requested, approved, and/or activated trading capabilities

    • Trading permission(s)

    • Employment type

  • HTTP Request Type: POST

Name

Value

Description

Usage

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

 

Required

filter

Filter options: 

capabilitiesRequested

capabilitiesApproved

capabilitiesActivated

tradingPermission

employmentType

phoneCountry

residenceCountry

residenceState

feeTemplate

marketDataServiceId

Select one or multiple filter options.

Required

filterParameter

Expected value will vary based on the filter.

capabilitiesRequested | capabilitiesApproved | capabilitiesActivated

  • BOND

  • FOP

  • FUND

  • FUT

  • MRGN

  • MULT

  • OPT

  • SSF

  • CFD

  • STK

  • CLP

  • LEVFX

  • CMDTY

tradingPermission

employmentType

residenceState | residenceCountry | phoneCountry

  • 3122 ISO Code.

feeTemplate

marketDataServiceId

  

JSON Request

Copy 
{"CSID":"<client-service-id>","filter": {"<filter>": ["<filterParameter>", "<filterParameter>"]}}

Sample

Copy 
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getClientData -d '{"CSID":"TesterCSID",{"capabilitiesApproved": ["LEVFX", "OPT"]}}

JSON Response

Copy 

{
   "result":[
      {
           "acctId":"<acct_id1>","<acct_id2>"
      }
   ],
   "timestamp":"<timestamp>"
}

Sample

Copy 
{"result":["U3333333","U444444444","U333334"],"length":4,"timestamp":"2022-04-22 09:58:05"}