API product catalogCorporate Actions & Shareholder Governance

Get authoritative corporate-action details

Corporate Actions & Shareholder Governance

GET

/corporate-actions/{actionId}

Sandbox availablegetCorporateAction

Parameters

actionIdstringpathRequired

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

actionobject

action.idstringRequired

Example: "ca_abc123"

action.symbolstringRequired

Example: "SCOM.KE"

action.namestring | null

action.exchangestring | null

Example: "NSE"

action.typestringRequired

Example: "RIGHTS_ISSUE"

action.statusstringRequired

Example: "OPEN"

action.titlestringRequired

action.summarystring | null

action.termsstring | null

action.recordDatestring | null

action.electionDeadlinestring | null

action.effectiveDatestring | null

action.defaultOptionIdstring | null

action.optionsobject[]

action.documentsobject[]

action.authoritativeboolean

Response codes

200Corporate action, options, deadlines, default treatment, terms, and source documents.

404Corporate action not found

Sandbox playground

Read-only sandbox request

actionId Required · pathSandbox API keyYour key stays in this page’s memory.

https://mystocks.africa/api/sandbox/v1/partner/corporate-actions/%7BactionId%7D

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "action": {
      "type": "object",
      "required": [
        "id",
        "symbol",
        "type",
        "title",
        "status"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "ca_abc123"
        },
        "symbol": {
          "type": "string",
          "example": "SCOM.KE"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "exchange": {
          "type": [
            "string",
            "null"
          ],
          "example": "NSE"
        },
        "type": {
          "type": "string",
          "example": "RIGHTS_ISSUE"
        },
        "status": {
          "type": "string",
          "example": "OPEN"
        },
        "title": {
          "type": "string"
        },
        "summary": {
          "type": [
            "string",
            "null"
          ]
        },
        "terms": {
          "type": [
            "string",
            "null"
          ]
        },
        "recordDate": {
          "type": [
            "string",
            "null"
          ],
          "format": "date"
        },
        "electionDeadline": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "effectiveDate": {
          "type": [
            "string",
            "null"
          ],
          "format": "date"
        },
        "defaultOptionId": {
          "type": [
            "string",
            "null"
          ]
        },
        "options": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "label"
            ],
            "properties": {
              "id": {
                "type": "string",
                "example": "ACCEPT_ALL"
              },
              "label": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "requiresUnits": {
                "type": "boolean",
                "default": false
              },
              "allowPartial": {
                "type": "boolean",
                "default": false
              },
              "isDefault": {
                "type": "boolean",
                "default": false
              }
            }
          }
        },
        "documents": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "url": {
                "type": "string",
                "format": "uri"
              }
            }
          }
        },
        "authoritative": {
          "type": "boolean"
        }
      }
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/corporate-actions/%7BactionId%7D' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

GET /corporate-actions

GET /dividends/{symbol}/history