API product catalogCorporate Actions & Shareholder Governance

Get record-date voting entitlement and ballot

Corporate Actions & Shareholder Governance

GET

/users/{userId}/shareholder-meetings/{meetingId}/ballot

Sandbox availablegetShareholderBallot

Parameters

userIdstringpathRequired

meetingIdstringpathRequired

Headers

AuthorizationstringRequired

Bearer sk_sandbox_<your_key> for sandbox requests.

Response fields

meetingobject

meeting.idstringRequired

Example: "mtg_abc123"

meeting.symbolstringRequired

Example: "SCOM.KE"

meeting.namestring | null

meeting.exchangestring | null

Example: "NSE"

meeting.meetingTypeAGM | EGM | COURT | CLASS | OTHERRequired

meeting.statusOPEN | CLOSED | CONFIRMED | CANCELLEDRequired

meeting.titlestringRequired

meeting.descriptionstring | null

meeting.meetingDatestringRequired

meeting.recordDatestringRequired

meeting.votingDeadlinestringRequired

meeting.defaultTreatmentstring

meeting.documentsobject[]

meeting.resolutionsobject[]

eligibleboolean

entitlementobject | null

ballotobject[]

voteunion

Response codes

200Meeting

Sandbox playground

Read-only sandbox request

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

https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/shareholder-meetings/%7BmeetingId%7D/ballot

Open in API Tester API Reference

Response schema

{
  "type": "object",
  "properties": {
    "meeting": {
      "type": "object",
      "required": [
        "id",
        "symbol",
        "meetingType",
        "status",
        "title",
        "meetingDate",
        "recordDate",
        "votingDeadline"
      ],
      "properties": {
        "id": {
          "type": "string",
          "example": "mtg_abc123"
        },
        "symbol": {
          "type": "string",
          "example": "SCOM.KE"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "exchange": {
          "type": [
            "string",
            "null"
          ],
          "example": "NSE"
        },
        "meetingType": {
          "type": "string",
          "enum": [
            "AGM",
            "EGM",
            "COURT",
            "CLASS",
            "OTHER"
          ]
        },
        "status": {
          "type": "string",
          "enum": [
            "OPEN",
            "CLOSED",
            "CONFIRMED",
            "CANCELLED"
          ]
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "meetingDate": {
          "type": "string",
          "format": "date-time"
        },
        "recordDate": {
          "type": "string",
          "format": "date"
        },
        "votingDeadline": {
          "type": "string",
          "format": "date-time"
        },
        "defaultTreatment": {
          "type": "string"
        },
        "documents": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "url": {
                "type": "string",
                "format": "uri"
              },
              "type": {
                "type": "string",
                "example": "PROXY_FORM"
              }
            }
          }
        },
        "resolutions": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "title",
              "choices"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "number": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "title": {
                "type": "string"
              },
              "description": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "managementRecommendation": {
                "type": "string",
                "enum": [
                  "FOR",
                  "AGAINST",
                  "NONE"
                ]
              },
              "choices": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "eligible": {
      "type": "boolean"
    },
    "entitlement": {
      "type": [
        "object",
        "null"
      ]
    },
    "ballot": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "vote": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "status": {
              "type": "string",
              "enum": [
                "PENDING_CUSTODIAN",
                "ACCEPTED",
                "REJECTED"
              ]
            },
            "revision": {
              "type": "integer",
              "minimum": 1
            },
            "submittedAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            },
            "amendedAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            },
            "custodianReference": {
              "type": [
                "string",
                "null"
              ]
            },
            "custodianReason": {
              "type": [
                "string",
                "null"
              ]
            },
            "acceptedAt": {
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            },
            "confirmationDocumentUrl": {
              "type": [
                "string",
                "null"
              ],
              "format": "uri"
            }
          }
        },
        {
          "type": "null"
        }
      ]
    }
  }
}

curl -X GET 'https://mystocks.africa/api/sandbox/v1/partner/users/%7BuserId%7D/shareholder-meetings/%7BmeetingId%7D/ballot' \
  -H "Authorization: Bearer $MYSTOCKS_SANDBOX_API_KEY"

GET /users/{userId}/corporate-actions/{actionId}/entitlement

GET /users/{userId}/shareholder-meetings/{meetingId}/votes