Available Endpoints

https://[domain]/ws/

Digital AM Web Service will be available on the following domains(unless otherwise specified): 

Production Instance:

• api.ibkr.com (non-HK and non-China region only)

• www.ibkr.com.cn (China/Hong Kong)

Quality Instance: https://qa.interactivebrokers.com

Create Accounts and Updating Account Information

Endpoint	Description
/create	This is used for account creation.
/submitDocuments	Service provides a mechanism to submit standard forms and agreements for account creation.
/update	Used to submit POI/POA documents for PENDING accounts and update account information for accounts that are already OPEN.
/sso/create	Create an SSO session for accessing IBKR Portal (White Branded).

View Account Information and Registration Tasks

Endpoint	Description
/callback	Receive notifications via RESTful Web API when status of request submitted via DAM changes.
/getAccountDetail	Service is used to view account information for an existing account.
/getAccountStatus	Query status of account(s).
/getLoginMessages	Query login messages for account(s).
/getPendingTasks	Query pending tasks for account(s)
/getRegistrationTasks	Query registration tasks (both complete and incomplete) for account(s).
/getClientData	Query list of accounts that meet certain criteria.

Retrieve information for files submitted using the API 

Endpoint	Description
/getAmRequestStatus	Query status of request that was submitted using /update endpoint.
/getBatchDetails	When you receive the response, you will receive a batch ID. Service allows you to query batch details.
/getFileDetails	Service to get Request and Response file Details of one or more accounts.
/getResponseFile	Pull response file using external ID.
/getStatus	If you misplace the response file (but stored the batch ID), you can reference the batch ID to pull the response file again.

Schema and Healthcheck

Endpoint	Description
/getEnumerations	Query ECA Enumerations.
/getXMLSchema	Service is used to obtain the latest XML Schema (XSD).
/healthcheck	Allows you to check whether DAM WS is up and running.
/validateXML	Endpoint is to perform primary validations on (just) the XML document (whether mandatory data is missing, etc.) prior to submitting requests to create accounts.

Pre-Trade Compliance

Endpoint	Usage
/apply	Service is used to manage restrictions, rules, and associations for Pre-Trade Compliance using the API.
/verify	Service is used to validate that the contents included in the CSV file is in good order.

Additional Features

Endpoint	Description
/preference/set	Set preferred language for existing account.
/preference/getSingle	View preferred language for existing account.
/cacapi.ext/submit	Manage Corporate Action. Service includes viewing corporate action detail(s) and submitting corporate action election(s) for account(s).