Get Account Information

GET

/gw/api/v1/accounts/:accountId/details

GET

/gw/api/v1/accounts/:accountId/details

$ curl https://api.ibkr.com/gw/api/v1/accounts/accountId/details \
>      -H "Content-Type: application/json"

1 {
2   "error": {
3     "status": 400,
4     "error": "BadRequest",
5     "message": "Invalid account ID provided"
6   },
7   "hasError": true,
8   "errorDescription": "The accountId parameter is invalid or missing.",
9   "account": {
10     "accountId": "U1234567",
11     "masterAccountId": "M7654321",
12     "mainAccount": "U1234567",
13     "sourceAccountId": "SRC987654",
14     "primaryUser": "john.doe",
15     "clearingStatus": "Active",
16     "clearingStatusDescription": "Account is active and cleared for trading",
17     "stateCode": "NY",
18     "optionLevel": 3,
19     "baseCurrency": "USD",
20     "dateBegun": "2020-01-15",
21     "dateApproved": "2020-01-20",
22     "dateOpened": "2020-01-22",
23     "dateFunded": "2020-01-25",
24     "dateClosed": null,
25     "dateLinked": "2020-02-01",
26     "dateDelinked": null,
27     "accountTitle": "John Doe Trading Account",
28     "officialTitle": "Johnathan A. Doe",
29     "accountAlias": "JDoeMain",
30     "emailAddress": "john.doe@example.com",
31     "margin": "Enabled",
32     "applicantType": "Individual",
33     "subType": "Cash",
34     "stockYieldProgram": {
35       "enrolled": "true",
36       "programType": "Dividend Reinvestment"
37     },
38     "feeTemplate": {
39       "templateName": "Standard Fees",
40       "version": "v2.1"
41     },
42     "capabilities": {
43       "dataAccess": [
44         "RealTimeQuotes",
45         "HistoricalData"
46       ],
47       "trading": [
48         "Stocks",
49         "Options",
50         "Futures"
51       ]
52     },
53     "limitedOptionTrading": "No",
54     "investmentObjectives": [
55       "Growth",
56       "Income"
57     ],
58     "dividendReinvestment": {
59       "AAPL": true,
60       "MSFT": false
61     },
62     "externalId": "EXT-998877",
63     "mifidCategory": "Professional",
64     "mifirStatus": "Compliant",
65     "equity": 125000.75,
66     "household": "Doe Family",
67     "propertyProfile": "Residential",
68     "processType": "Standard",
69     "riskScore": 5,
70     "class_action_program": "Enrolled",
71     "trustType": "Revocable",
72     "orgType": "Individual",
73     "businessDescription": "N/A",
74     "usTaxPurposeType": "Taxable",
75     "tradeIntentionType": "Active",
76     "registeredAddress": {
77       "city": "New York",
78       "country": "USA",
79       "postalCode": "10001",
80       "state": "NY",
81       "street": "123 Main St"
82     },
83     "mailing": {
84       "city": "New York",
85       "country": "USA",
86       "postalCode": "10002",
87       "state": "NY",
88       "street": "PO Box 456"
89     },
90     "countryOfCorporation": "USA",
91     "taxIds": [
92       {
93         "SSN": "123-45-6789"
94       }
95     ],
96     "taxTreatyDetails": [
97       {
98         "country": "USA",
99         "treatyRate": "15%"
100       }
101     ],
102     "signatures": [
103       "John Doe"
104     ]
105   },
106   "associatedPersons": [
107     {
108       "entityId": 101,
109       "externalCode": "EMP1001",
110       "firstName": "Jane",
111       "middleName": "A.",
112       "middleInitial": "A",
113       "lastName": "Doe",
114       "suffix": "Jr.",
115       "username": "jane.doe",
116       "passwordDate": "2023-12-01",
117       "userStatus": "Active",
118       "userStatusTrading": "Enabled",
119       "lastLogin": "2024-06-10T09:15:00Z",
120       "gender": "Female",
121       "maritalStatus": "Married",
122       "salutation": "Ms.",
123       "ownershipPercentage": 25,
124       "email": "jane.doe@example.com",
125       "countryOfCitizenship": "USA",
126       "countryOfBirth": "USA",
127       "dateOfBirth": "1985-04-12",
128       "motersMaidenName": "Smith",
129       "numberOfDependents": 2,
130       "securityDevice": "YubiKey",
131       "commercial": "No",
132       "countryOfLegalResidence": "USA",
133       "stateOfLegalResidence": "NY",
134       "mdSubscriberStatus": "Subscribed",
135       "phones": {
136         "home": "+1-212-555-5678",
137         "mobile": "+1-212-555-1234"
138       },
139       "residence": {
140         "city": "New York",
141         "country": "USA",
142         "postalCode": "10003",
143         "state": "NY",
144         "street": "456 Elm St"
145       },
146       "mailing": {
147         "city": "New York",
148         "country": "USA",
149         "postalCode": "10003",
150         "state": "NY",
151         "street": "456 Elm St"
152       },
153       "associations": [
154         "Account Holder",
155         "Power of Attorney"
156       ],
157       "identityDocuments": [
158         {
159           "country": "USA",
160           "expiryDate": "2030-12-31",
161           "number": "X1234567",
162           "type": "Passport"
163         }
164       ],
165       "employmentType": "Full-Time",
166       "employmentDetails": {
167         "employer": "Tech Solutions Inc.",
168         "position": "Software Engineer",
169         "startDate": "2010-06-01"
170       },
171       "subscribedServices": [
172         {
173           "serviceName": "Market Data Pro",
174           "subscriptionDate": "2023-01-15"
175         }
176       ],
177       "taxTreatyDetails": [
178         {
179           "country": "USA",
180           "treatyRate": "15%"
181         }
182       ]
183     }
184   ],
185   "associatedEntities": [
186     {
187       "entityId": 201,
188       "externalCode": "ORG2001",
189       "name": "Doe Family Trust",
190       "email": "trustee@doefamilytrust.com",
191       "organizationCountry": "USA",
192       "phones": {
193         "office": "+1-212-555-7890"
194       },
195       "residence": {
196         "city": "New York",
197         "country": "USA",
198         "postalCode": "10004",
199         "state": "NY",
200         "street": "789 Oak St"
201       },
202       "mailing": {
203         "city": "New York",
204         "country": "USA",
205         "postalCode": "10004",
206         "state": "NY",
207         "street": "789 Oak St"
208       },
209       "associations": [
210         "Trustee"
211       ],
212       "identityDocuments": [
213         {
214           "documentId": "TA-2023-001",
215           "type": "Trust Agreement"
216         }
217       ],
218       "taxTreatyDetails": [
219         {
220           "country": "USA",
221           "treatyRate": "0%"
222         }
223       ],
224       "AssociatedPersons": [
225         {
226           "entityId": 101,
227           "externalCode": "EMP1001",
228           "firstName": "Jane",
229           "middleName": "A.",
230           "middleInitial": "A",
231           "lastName": "Doe",
232           "suffix": "Jr.",
233           "username": "jane.doe",
234           "passwordDate": "2023-12-01",
235           "userStatus": "Active",
236           "userStatusTrading": "Enabled",
237           "lastLogin": "2024-06-10T09:15:00Z",
238           "gender": "Female",
239           "maritalStatus": "Married",
240           "salutation": "Ms.",
241           "ownershipPercentage": 25,
242           "email": "jane.doe@example.com",
243           "countryOfCitizenship": "USA",
244           "countryOfBirth": "USA",
245           "dateOfBirth": "1985-04-12",
246           "motersMaidenName": "Smith",
247           "numberOfDependents": 2,
248           "securityDevice": "YubiKey",
249           "commercial": "No",
250           "countryOfLegalResidence": "USA",
251           "stateOfLegalResidence": "NY",
252           "mdSubscriberStatus": "Subscribed",
253           "phones": {
254             "home": "+1-212-555-5678",
255             "mobile": "+1-212-555-1234"
256           },
257           "residence": {
258             "city": "New York",
259             "country": "USA",
260             "postalCode": "10003",
261             "state": "NY",
262             "street": "456 Elm St"
263           },
264           "mailing": {
265             "city": "New York",
266             "country": "USA",
267             "postalCode": "10003",
268             "state": "NY",
269             "street": "456 Elm St"
270           },
271           "associations": [
272             "Account Holder",
273             "Power of Attorney"
274           ],
275           "identityDocuments": [
276             {
277               "country": "USA",
278               "expiryDate": "2030-12-31",
279               "number": "X1234567",
280               "type": "Passport"
281             }
282           ],
283           "employmentType": "Full-Time",
284           "employmentDetails": {
285             "employer": "Tech Solutions Inc.",
286             "position": "Software Engineer",
287             "startDate": "2010-06-01"
288           },
289           "subscribedServices": [
290             {
291               "serviceName": "Market Data Pro",
292               "subscriptionDate": "2023-01-15"
293             }
294           ],
295           "taxTreatyDetails": [
296             {
297               "country": "USA",
298               "treatyRate": "15%"
299             }
300           ]
301         }
302       ]
303     }
304   ],
305   "withHoldingStatement": {
306     "2022": "Received",
307     "2023": "Received"
308   },
309   "marketData": [
310     {
311       "AAPL": "145.32",
312       "MSFT": "299.01"
313     }
314   ],
315   "financialInformation": {
316     "cashBalance": 5000,
317     "marginBalance": 20000,
318     "netLiquidation": 130000
319   },
320   "sourcesOfWealth": [
321     {
322       "employmentIncome": {
323         "annualAmount": "120000"
324       },
325       "investmentIncome": {
326         "annualAmount": "15000"
327       }
328     }
329   ],
330   "tradeBundles": [
331     "EquitiesBundle2024"
332   ],
333   "individualIRABeneficiaries": [
334     {
335       "firstName": "Emily",
336       "lastName": "Doe",
337       "dateOfBirth": "1990-07-15",
338       "type": "Primary",
339       "identification": {
340         "SSN": "987-65-4321"
341       },
342       "location": {
343         "city": "Boston",
344         "country": "USA",
345         "state": "MA"
346       },
347       "relationship": "Daughter",
348       "ownership": 50,
349       "perStripes": "No"
350     }
351   ],
352   "entityIRABeneficiaries": [
353     {
354       "name": "Doe Family Trust",
355       "entityType": "Trust",
356       "type": "Contingent",
357       "location": {
358         "city": "New York",
359         "country": "USA",
360         "state": "NY"
361       },
362       "articleOfWill": "Article 5"
363     }
364   ],
365   "decedents": [
366     {
367       "dateOfDeath": "2018-11-20",
368       "name": "Robert Doe",
369       "relationship": "Father"
370     }
371   ],
372   "restrictions": [
373     {
374       "id": 101,
375       "byIB": true,
376       "name": "Trading Suspension"
377     }
378   ]
379 }

Scope: accounts.read
Security Policy: HTTPS

Path parameters

accountIdstringRequired

Response

View information associated with account including contact data, financial information and trading configuration.

errorobject

hasErrorboolean

errorDescriptionstring

accountobject

associatedPersonslist of objects

associatedEntitieslist of objects

withHoldingStatementmap from strings to strings

marketDatalist of maps from strings to strings

financialInformationmap from strings to objects

sourcesOfWealthlist of maps from strings to objects

tradeBundleslist of strings

individualIRABeneficiarieslist of objects

entityIRABeneficiarieslist of objects

decedentslist of maps from strings to strings

restrictionslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error