CA Detail For Given Exchanges

GET 
/corporate-actions/source/data

This service is used to get the corporate actions data for all the symbols of an exchange specified by request parameter source-id.

Request

Query Parameters

source-id stringrequired

Default value: NSDQ

The sourceId of the exchange you want to request corporate action data of. It will also be used for authorization.

action-type string
start-date string

Possible values: Value must match regular expression yyyyMMddHHmmss

The start date of the range for filtering records on EFFECTIVE_DATE.

end-date string

Possible values: Value must match regular expression yyyyMMddHHmmss

The end date of the range for filtering records on EFFECTIVE _DATE.

last-update-time string

Possible values: Value must match regular expression yyyyMMddHHmmss

The optional parameter which supports retrieval of data in delta mode.

required-fields string[]

The optional parameter which specifies the fields required in the response.

response-type string

Possible values: [json, csv, xml]

Default value: json

The response format for example json, csv or xml. The default is json.

rows int32

Default value: 10

Number of records per page in the response.

page int32

Default value: 0

Number of records per page in the response.

Responses

200

OK

application/json

Schema

Schema

response object
numFound integer
start integer
docs object[]
Array [
KEY string
EFFECTIVE_DATE string
CD_PERIOD string
CORP_ACT_TYPE string
Find CA types here
CURRENCY_ID string
DIVIDEND_AMOUNT string
RIGHTS_END_DATE string
ACTION_PRIORITY string
SOURCE_ID string
NUMBER_OF_SHARES string
LAST_UPDATED_ON string
TICKER_ID string
ANN_DATE string
NUMBER_OF_SHARES_NEW string
ACTION_ID string
SPLIT_FACTOR string
CD_YEAR string
ISSUE_PRICE string
NUMBER_TREASURY_STOCKS string
PERIOD_END_DATE string
EVENT_LABEL string
]

Example (from schema)

{
  "response": {
    "numFound": 0,
    "start": 0,
    "docs": [
      {
        "KEY": "string",
        "EFFECTIVE_DATE": "string",
        "CD_PERIOD": "string",
        "CORP_ACT_TYPE": "string",
        "CURRENCY_ID": "string",
        "DIVIDEND_AMOUNT": "string",
        "RIGHTS_END_DATE": "string",
        "ACTION_PRIORITY": "string",
        "SOURCE_ID": "string",
        "NUMBER_OF_SHARES": "string",
        "LAST_UPDATED_ON": "string",
        "TICKER_ID": "string",
        "ANN_DATE": "string",
        "NUMBER_OF_SHARES_NEW": "string",
        "ACTION_ID": "string",
        "SPLIT_FACTOR": "string",
        "CD_YEAR": "string",
        "ISSUE_PRICE": "string",
        "NUMBER_TREASURY_STOCKS": "string",
        "PERIOD_END_DATE": "string",
        "EVENT_LABEL": "string"
      }
    ]
  }
}

example

{
  "response": {
    "numFound": 2902,
    "start": 0,
    "docs": [
      {
        "KEY": "TDWL~1214",
        "EFFECTIVE_DATE": "2016-11-06T00:00:00Z",
        "CD_PERIOD": "3",
        "CORP_ACT_TYPE": "7",
        "CURRENCY_ID": "SAR",
        "DIVIDEND_AMOUNT": "0.75",
        "RIGHTS_END_DATE": "2016-11-03T00:00:00Z",
        "ACTION_PRIORITY": "0",
        "SOURCE_ID": "TDWL",
        "NUMBER_OF_SHARES": "63000000",
        "LAST_UPDATED_ON": "2018-10-10T18:04:31Z",
        "TICKER_ID": "1214",
        "ANN_DATE": "2016-10-17T00:00:00Z",
        "NUMBER_OF_SHARES_NEW": "63000000",
        "ACTION_ID": "160257",
        "SPLIT_FACTOR": "0.75",
        "CD_YEAR": "2016",
        "ISSUE_PRICE": "1",
        "NUMBER_TREASURY_STOCKS": "0",
        "PERIOD_END_DATE": "2019-12-31T00:00:00Z",
        "EVENT_LABEL": "Announcement"
      }
    ]
  }
}

Loading...