Overview
- Introduction
- Authentication
- Querying
- Bulk Downloads
- Frequently Asked Questions
Data Tables
- Indicator Descriptions
- Fundamentals
- Stock 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
Indicator Descriptions
The table is queried via the following endpoint:
The 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 descriptions table supports the following query parameters:
| Parameter | Description | Default | Examples |
|---|---|---|---|
| format | The format of the results to be returned. | csv | format=json |
| years | Triggers a bulk download of the full table as a compressed CSV. Values: 5, 10, or full. The API redirects to a time-limited download URL. | years=5 | |
| fields | The fields (table columns) to return. | all | fields=tablename,indicator,description |
| tablename | The table to return descriptions for. | all | tablename=fundamentals |
| limit | The number of records to return. | 10000 | limit=10000 |
| skip | The number of results to skip before returning data. Alias: offset. | 0 | skip=10000 |
| sort | The field used to sort the data and the sort method (asc/desc). | date.desc | sort=indicator.asc |
| indicator | The the indicator to return data for. | all | indicator=revenue |
Retrieve the PostgreSQL schema:
Retrieve the SQLite schema:
Retrieve the MySQL schema:
Return the the indicator details for all tables in the dataset:
Return the indictors and descriptions for a specific table (e.g. fundamentals):
Return the details for a single indicator on a table (e.g. the revenue indicator on the fundamentals table):
In Google Sheets, retrieve indicator descriptions for a table (fundamentals) 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/descriptions?api_key=test-api-key&format=csv&tablename=fundamentals")Download the [descriptions] table as a compressed CSV by setting years to 5, 10, or full. The API responds with a redirect to a time-limited download URL:
Example using curl (follow redirects and write the file):
curl -L -o descriptions.csv.zip "https://api.sharadar.com/v1.0/data/descriptions?api_key=test-api-key&years=full"Check the bulk file status (name, size, last modified) without downloading:
Example response:
{
"table": "descriptions",
"name": "descriptions.csv.zip",
"size": 15948,
"sizeLabel": "15.6 KB",
"modified": "2026-06-23T07:29:29.106000+00:00"
}