API product catalogCorporate Actions & Shareholder Governance

Dividend calendar

Corporate Actions & Shareholder Governance

GET

/dividends/calendar

Dividend calendar

Sandbox availablelistCalendar

Returns dividend declarations for stocks held across the partner's sub-accounts. Pass all=true to include declarations for symbols that no sub-account currently holds.

Parameters

statusDECLARED | PAID | CANCELLED | ALLquery

Filter declarations by lifecycle status.

allbooleanquery

Return declarations for all symbols, including those not held by partner sub-accounts.

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

declarationsobject[]

declarations[].idstring

declarations[].symbolstring

declarations[].namestring

declarations[].amountnumber

declarations[].currencystring

declarations[].exDividendDatestring | null

declarations[].recordDatestring | null

declarations[].paymentDatestring | null

declarations[].statusstring

declarations[].partnerEligibleboolean

declarations[].createdAtstring | null

countinteger

Response codes

200Dividend declarations visible to this partner.

Sandbox playground

Read-only sandbox request

status Optional · queryall Optional · querySandbox API keyYour key stays in this page’s memory.

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

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "declarations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "amount": {
            "type": "number"
          },
          "currency": {
            "type": "string"
          },
          "exDividendDate": {
            "type": [
              "string",
              "null"
            ]
          },
          "recordDate": {
            "type": [
              "string",
              "null"
            ]
          },
          "paymentDate": {
            "type": [
              "string",
              "null"
            ]
          },
          "status": {
            "type": "string"
          },
          "partnerEligible": {
            "type": "boolean"
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ],
            "format": "date-time"
          }
        }
      }
    },
    "count": {
      "type": "integer"
    }
  }
}

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

GET /dividends/{symbol}/history

GET /report/dividends