Get portfolio income calendar

Income for a portfolio over a period, grouped by month. Each key is the first
day of the month the income is paid or received in, not the payment date
itself; read PaymentDate on each record for the day. Covers dividends and
crypto income. Status Actual means income recorded on the holding, which
includes a declared dividend whose payment date is still ahead, so Actual is
not proof the money has arrived. Status Estimated means a forecast from the
holding's dividend history, added only when the period runs past today.

Access

OAuth scope: performance:read

Plan feature: Income Calendar

Available on: Standard, Premium and Pro

Free trial: not available

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Body Params

application/json-patch+json

Example

{
    "from": "2019-08-24T14:15:22.123Z",
    "to": "2019-08-24T14:15:22.123Z",
    "filters": [
        {
            "type": "string",
            "value": null,
            "operator": "string",
            "logicalOperator": "string"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "incomeRecords": {
        "property1": [
            {
                "id": "string",
                "holdingId": 0,
                "holdingTypeId": 0,
                "symbol": "string",
                "name": "string",
                "exchange": "string",
                "displayExchange": "string",
                "exDividendDate": "2019-08-24T14:15:22.123Z",
                "paymentDate": "2019-08-24T14:15:22.123Z",
                "frankedAmount": 0,
                "unfrankedAmount": 0,
                "frankingCredits": 0,
                "netAmount": 0,
                "grossAmount": 0,
                "status": "string",
                "logoUrl": "string"
            }
        ],
        "property2": [
            {
                "id": "string",
                "holdingId": 0,
                "holdingTypeId": 0,
                "symbol": "string",
                "name": "string",
                "exchange": "string",
                "displayExchange": "string",
                "exDividendDate": "2019-08-24T14:15:22.123Z",
                "paymentDate": "2019-08-24T14:15:22.123Z",
                "frankedAmount": 0,
                "unfrankedAmount": 0,
                "frankingCredits": 0,
                "netAmount": 0,
                "grossAmount": 0,
                "status": "string",
                "logoUrl": "string"
            }
        ]
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠429