/getForms

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

  • Service to query the following:

    • View details associated with a form including the date modified, filename, size, and sha1_checksum.

    • Pull the form directly from the server.

  • HTTP Request Type: POST

  • Optionally, forms can be pulled from public FTP (ftp://ftp2.interactivebrokers.com/outgoing/Forms/)

Name

Value

Description

Usage

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

 

Required

fromDate

yyyy-mm-dd

View forms that are updated as of fromDate

Optional- only applicable if retrieving forms that were updated between certain date range.

toDate

yyyy-mm-dd

View forms that are updated between fromDate and toDate

Optional- Only applicable IF fromDate is provided

form_no

Numeric

Form number

Optional- used if querying details for a specific form.

getDocs

T

F

T= True (Documents will be pulled)

F= False (Documents will not be pulled) 

Optional- only required if pulling CIP documents (ie. Proof of Address, Proof of ID, etc.).

  • If querying for multiple accounts, maximum of 5 accounts can be included.

  • Date range is not available for this request.

 

Download Forms

Copy
JSON Request
{"CSID":"<client-service-id>","getDocs":"T", "form_no":"<FormNumber>",}
Copy
Sample
curl -k -H "Content-Type:application/json" -X POST https://qa.interactivebrokers.com/ws/eca/getForms -d ' {"CSID":"TesterCSID","form_no":["2109","5002","4543"],"getDocs":"T"}'