API product catalogCorporate Actions & Shareholder Governance

Report — Dividends

Corporate Actions & Shareholder Governance

GET

/report/dividends

Report — Dividends

Sandbox availablegetDividendReport

Aggregated dividend distributions paid to sub-accounts for a given period. Returns totals, a per-symbol breakdown, and a per-sub-account breakdown. Add ?format=csv to download a spreadsheet of the by-symbol totals.

Parameters

fromstringquery

Start of period (ISO date, e.g. 2026-01-01). Defaults to 365 days ago.

tostringquery

End of period (ISO date). Defaults to today.

formatcsvquery

Pass csv to receive a downloadable spreadsheet instead of JSON.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

totalUsdReceivednumber

Total USD credited to sub-accounts as dividends in the period.

distributionCountinteger

Number of individual distribution transactions.

currencystring

Example: "USD"

fromstring

tostring

bySymbolobject[]

Totals grouped by stock symbol.

bySymbol[].symbolstring

bySymbol[].totalUsdnumber

bySymbol[].countinteger

bySubAccountobject[]

Totals grouped by sub-account.

bySubAccount[].subAccountIdstring

bySubAccount[].externalIdstring | null

bySubAccount[].displayNamestring | null

bySubAccount[].totalUsdnumber

bySubAccount[].countinteger

Response codes

200Dividend distribution report (JSON) or CSV file.

Sandbox playground

Read-only sandbox request

from Optional · queryto Optional · queryformat Optional · querySandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/report/dividends

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "totalUsdReceived": {
      "type": "number",
      "description": "Total USD credited to sub-accounts as dividends in the period."
    },
    "distributionCount": {
      "type": "integer",
      "description": "Number of individual distribution transactions."
    },
    "currency": {
      "type": "string",
      "example": "USD"
    },
    "from": {
      "type": "string",
      "format": "date-time"
    },
    "to": {
      "type": "string",
      "format": "date-time"
    },
    "bySymbol": {
      "type": "array",
      "description": "Totals grouped by stock symbol.",
      "items": {
        "type": "object",
        "properties": {
          "symbol": {
            "type": "string"
          },
          "totalUsd": {
            "type": "number"
          },
          "count": {
            "type": "integer"
          }
        }
      }
    },
    "bySubAccount": {
      "type": "array",
      "description": "Totals grouped by sub-account.",
      "items": {
        "type": "object",
        "properties": {
          "subAccountId": {
            "type": "string"
          },
          "externalId": {
            "type": [
              "string",
              "null"
            ]
          },
          "displayName": {
            "type": [
              "string",
              "null"
            ]
          },
          "totalUsd": {
            "type": "number"
          },
          "count": {
            "type": "integer"
          }
        }
      }
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/report/dividends' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

GET /dividends/calendar

GET /shareholder-meetings