Overview
- Introduction
- Authentication
- Querying
- Bulk Downloads
- Frequently Asked Questions
Data Tables
- Indicator Descriptions
- Fundamentals
- Equity Prices
- Fund Prices
- Corporate Actions
- Material Corporate Events
- S&P500 Constituents
- Price Based Metrics
- Insiders
- Tickers and Metadata
- Daily Fundamentals
- Institutional Investors
- Institutional Investors Summary by Ticker
- Institutional Investors Summary by Investor
Corporate Actions
Returns data from the [actions] table.
This table provides detailed corporate actions information such as splits, dividends and ticker changes for more than 20,000 US public companies and 6,000 US ETFs and CEFs.
For more information on the dataset and the available indicators, please review the actions table on the Explorer page.
The table is queried via the following endpoint
https://api.sharadar.com/v1.0/data/actions?api_key=test-api-keyThe queries are authenticated and filtered using query parameters. A query parameter specifies a particular option or filter for the data to be returned. Examples of query parameter include the data format to be returned (format), the table columns to return (fields) or a filter to be applied (tablename). These are appended to the endpoint above, following a ?. The most important of these is your API key (api_key) which is used to authenticate you. Without a valid API key, results will not be returned.
The actions table supports the following query parameters.
| Parameter | Description | Default | Examples |
|---|---|---|---|
| format | The format of the results to be returned. | csv | format=json |
| years | Bulk download only. History length to download: 5, 10, or full. Defaults to the longest history included in your subscription that has a published bulk file. Alias: history. | max available | years=5 |
| from | Specifies the filing date from which to return data. | 30 days ago | from=2023-08-01 |
| to | Specifies the filing date to return data until. | prior day | to=2023-08-31 |
| fields | The fields (table columns) to return. | all | fields=date,ticker,action,contraticker |
| action | Returns results for the specified action. | all | action=split |
| contraticker | Returns results where the corporate action is related to the specified company (contraticker) (e.g. a company delisted as a result of an acquisition will specify the aquiring company in the contraticker). | all | contraticker=GE |
| ticker | Returns results for the specified ticker. Multiple tickers should be separated with a comma(,). | all | ticker=TSLA |
| limit | The number of records to return. | 10000 | limit=100000 |
| skip | The number of results to skip before returning data. | 0 | skip=10000 |
| sort | The field used to sort the data and the sort method (asc/desc). | date.desc | sort=action.asc |
Return all corporate actions for a ticker
https://api.sharadar.com/v1.0/data/actions?api_key=test-api-key&format=csv&ticker=AAPLReturn all corporate actions in a specific date range
https://api.sharadar.com/v1.0/data/actions?api_key=test-api-key&format=csv&from=2023-08-01&to=2023-08-31Return specific corporate actions in specific date range
https://api.sharadar.com/v1.0/data/actions?api_key=test-api-key&format=csv&action=split&from=2023-08-01&to=2023-08-31In Google Sheets, retrieve corporate actions for a single ticker (AAPL) with IMPORTDATA. You can change the query parameters (ticker, dates, fields, filters, and so on) in the same way as the Examples in the preceding section. Paste this formula into a cell (A1):
=IMPORTDATA("https://api.sharadar.com/v1.0/data/actions?api_key=test-api-key&format=csv&ticker=AAPL")Download the [actions] table as a compressed CSV. The API responds with a redirect to a time-limited download URL.
https://api.sharadar.com/v1.0/data/actions?api_key=test-api-key&bulk=TrueUse years=5, years=10, or years=full to select history length when split bulk files are published. If years is omitted, the longest history included in your subscription is used.
https://api.sharadar.com/v1.0/data/actions?api_key=test-api-key&bulk=True&years=5https://api.sharadar.com/v1.0/data/actions?api_key=test-api-key&bulk=True&years=10https://api.sharadar.com/v1.0/data/actions?api_key=test-api-key&bulk=True&years=fullExample using curl (follow redirects and write the file):
curl -L -o actions-5Y.csv.zip "https://api.sharadar.com/v1.0/data/actions?api_key=test-api-key&bulk=True&years=5"Check bulk file status for all history lengths (or pass years= to filter to one):
https://api.sharadar.com/v1.0/data/actions?api_key=test-api-key&status=Truehttps://api.sharadar.com/v1.0/data/actions?api_key=test-api-key&status=True&years=5Example response (all histories):
{
"table": "actions",
"files": [
{ "history": "5y", "historyLabel": "5 Years", "name": "actions-5Y.csv.zip", "size": 2892113, "sizeLabel": "2.76 MB", "modified": "…", "available": true },
{ "history": "10y", "historyLabel": "10 Years", "name": "actions-10Y.csv.zip", "size": 5056475, "sizeLabel": "4.82 MB", "modified": "…", "available": true },
{ "history": "full", "historyLabel": "Full History", "name": "actions.csv.zip", "size": 9843380, "sizeLabel": "9.39 MB", "modified": "…", "available": true }
]
}