Corporate Actions

<b>BETA:</b> Returns corporate actions library

get/sites/{site-identifier}/corporate-actions

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/corporate-actions
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

Query parameters

ActionTypestring

The corporate action type.

SecurityIDstring

The security identifier.

FromDatestring date

Date range.

ToDatestring date

Date range.

Fundstring

The fund code.

Response

Success

SecurityIDstring
Typestring
Descriptionstring
SecurityDescriptionstring
RecordDatestring date
EffectiveDatestring date
PostDatestring date
Activeboolean
Sourcestring
CorporateActionDefinitionGUIDstring

Example response

[
  {
    "SecurityID": "CBA",
    "Type": "BONUS",
    "Description": "CBA MYEO Attaching Option",
    "SecurityDescription": "CBA Adelaide Brighton Ordinary Fully Paid",
    "RecordDate": "2023-06-02",
    "EffectiveDate": "2023-06-03",
    "PostDate": "2023-06-03",
    "Active": true,
    "Source": "ASX, SITE or FUND",
    "CorporateActionDefinitionGUID": "b44f03f7-d531-2993-ad14-4ee0b8c50c67",
    "Permissions": [
      [
        "delete",
        "deactivate",
        "activate",
        "unsynchronise",
        "synchronise"
      ]
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.