/getAccountStatus

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

Service to query status of account(s).
Query by account, custom group of accounts, all accounts associated with master, for accounts created within certain date range, OR status
HTTP Request Type: POST

Request Parameters

Name	Value	Description	Usage
CSID	Client Service ID	Unique identifier issued by Interactive Brokers.	Required
accountIds	IBKR Client Account Number	List of one or more accounts	Optional- if querying by account ID or custom group of accounts.
startDate	yyyy-mm-dd	View status for accounts created within certain time period.	Optional- if querying for accounts created within specific date range.
endDate	yyyy-mm-dd	Filter by date when account was created. If start date is provided, end date is mandatory	If startDate is provided, endDate is mandatory.
status	A N O C P R	A= Abandoned (i.e. application was deleted) N= New Account / Not Yet Open - No Funding Details have been provided. O= Open (Considered active accounts) C= Closed (considered accounts that were once active OR open accounts that were and then closed.) P= Pending- Funding instructions have been provided. R= Rejected (meaning account was never approved/opened- rejected by Compliance)	Optional- if querying for accounts based on status.

Option 1: By Account(s)

Copy

JSON Request

{"CSID":"<client-service-id>","accountIds":["<ID1>","<ID2>","..."]}

Copy

Sample

curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getAccountStatus -d '{"CSID":"TesterCSID","accountIds":["U11111111","U222222","U333333"]}'

Option 2: All Sub Accounts

Copy

JSON Request

{"CSID":"<client-service-id>"}

Copy

Sample

curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getAccountStatus -d '{"CSID":"TesterCSID"}'

Option 3: Accounts created within certain date range

Copy

JSON Request

{"CSID":"<client-service-id>","startDate":"<yyyy-mm-dd>","endDate":"<yyyy-mm-dd>"}

Copy

Sample

curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getAccountStatus -d '{"CSID":"TesterCSID", "startDate":"2019-11-26","endDate":"2021-05-12"}'

Option 4: By Status

Copy

JSON Request

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

Copy

Sample

curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getAccountStatus -d '{"CSID":"TesterCSID", "status":"P"}'

Response Parameters

Name	Value	Description
timestamp	YYYY-MM-DD HH:MM:SS	Date/Time which the request was processed at.
isError	Boolean	Indicates if there was an error when processing the request.
Error	String AND only populated if isError="true"	Description of error.
status	A= Abandoned (i.e. application was deleted) N= New Account (Account is not yet open and no funding details have been provided. O= Open (Considered active accounts) C= Closed (considered accounts that were once active OR open accounts that were and then closed.) P= Pending Application, funding details have been provided. R= Rejected (meaning account was never approved/opened- rejected by Compliance)	Current status of the account.
state	Incomplete Application = Client Action Needed, use /getPendingTasks to view pending registration tasks. Documents Required = Client Action Needed, use /getPendingTasks to view documents required for approval. Under Review with IBKR = Application is PENDING on IBKR, no action needed. Pending Approval = Account is in the approval queue and should be opened by the following business day.	State of the application.

JSON Response

Copy

{
  "timestamp": "<timestamp>",
  "status" : [{
    "accountId" : "<ID1>",
    "isError" : false,
    "description" : "<Status Description>",
    "status" : "<Status Code>"
  }, {
    "accountId" : "ID2",
    "isError" : true,
    "error" : "<Error Description>."
  }]
}

Sample

Copy

Success:

{"timestamp":"2020-02-07 15:48:02","status":[{"accountId":"U3022862","isError":false,"description":"New Account","state":"Documents Required","status":"N"}

Copy

Error

{"timestamp":"2020-02-11 14:32:02","status":[{"accountId":"U30222","isError":true,"error":"U30222 is not associated with your Advisor/iBroker Account."}]}Error