/getAmRequestStatus

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

  • Service to check the status of requests submitted using /update endpoint.

  • HTTP Request Type: POST

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
request_id String

Unique ID which IBKR assigns to the request to track status.

  • This should match the request_id value that was returned in response file when submitting the request via /update.

Optional

Option 1: By Account

  • Returns a list of all requests submitted via /update for the given account(s).

Copy
JSON Request
{
  "CSID":"<client-service-id>",
  "accountIds":[“<ID1>","<ID2>","<ID3>",...]
}  
Copy
Sample
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getAmRequestStatus -d '{"CSID":"testerCSID","accountIds":"U1234567"}

Option 2: By request_id

Copy
JSON Request
{
  "CSID":"<client-service-id>",
  "request_id":["<ID1>","<ID2>","<ID3>",...]
}  
Copy
Sample
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getAmRequestStatus -d '{"CSID":"testerCSID","request_id":"12311"}

Name

Value

Description

Status

PROCESSED

REJECTED

PENDING

Status of the request.

isError

Boolean

Indicates if there was an error when processing the request.

acctId        

Client Account Number

 

Error

String AND only populated if isError="true"

 

Description of error.

timestamp

YYYY-MM-DD HH:MM:SS

Date/Time request was submitted.

JSON Response

Copy 
{"result":[
 
{"RequestType":
 
{"data":[{"RequestDetail":"<code>","status":"<status>"},{...},{...},{...}],
 
"files":["<file-name>"]},
 
{...}, {...}, {...}],
 
"timestamp":"2021-04-18 16:10:14"}