Fetch Dividend Details

GET

/gw/api/v1/tax-vouchers/dividends

GET

/gw/api/v1/tax-vouchers/dividends

$ curl -G https://api.ibkr.com/gw/api/v1/tax-vouchers/dividends \
>      -H "Content-Type: application/json" \
>      -d countryCode=countryCode \
>      -d custAcctId=custAcctId \
>      -d year=year

1 [
2   {
3     "currency": "USD",
4     "exDate": "2023-08-15",
5     "payDate": "2023-08-30",
6     "corpactionId": "CA123456789",
7     "country": "US",
8     "isin": "US0378331005",
9     "securityDesc": "Apple Inc. Common Stock",
10     "symbol": "AAPL",
11     "voucher": {
12       "requestId": "REQ-20230815-001",
13       "custAcctId": "ACC1234567",
14       "corpactionId": "CA123456789",
15       "requestState": "COMPLETED",
16       "fee": 2.5,
17       "divAmount": 150.75,
18       "withHeldAmount": 22.61,
19       "countryCode": "US",
20       "year": 2023,
21       "migratedCustAcctId": "ACC9876543"
22     }
23   }
24 ]

Retrieves dividend details for the given customer account, year, and country.

Scope: tax-vouchers.read
Security Policy: HTTPS

Query parameters

custAcctIdstringRequired

Customer account ID

yearstringRequired

Tax year (e.g. 2023)

countryCodestringRequired

Country code (e.g. DE)

Response

List of dividends returned successfully

currencystring

exDatestring

payDatestring

corpactionIdstring

countrystring

isinstring

securityDescstring

symbolstring

voucherobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

Headers

Query parameters

Response

Errors