API Tutorial
Introduction
Requesting an API Key
To obtain an API key, start by subscribing to at least one signal from Signal DB. Once subscribed, you can locate your API key in the User Center under API. If you don't subscribe to any signals, you wil not see the APl section in your user center.
Accessing Data via API
After subscribing to Signal DB or specific API services, you'll receive an API URL for the datasets you requested. Use this URL to access your subscribed signals and services through your API key.
Using the API
Basic Usage
Simply copy and paste the API URL into your preferred browser. If you’re familiar with programming, you can also use tools like wget or curl to make API calls directly from the command line.
Default Data Retrieval
When you include both the product_id and api_key in the URL, the API will return the latest available data by default.
[ { "momentum_score": 8, "company_name": "AGILENT TECH", "kscore": 5, "trade_date": "2019-06-28", "growth_score": 5, "symbol": "A", "quality_score": 9, "value_score": 4, "country": "US", "sector": "Health Care" }, { "momentum_score": 6, "company_name": "ALCOA CORP", "kscore": 1, "trade_date": "2019-06-28", "growth_score": 8, "symbol": "AA", "quality_score": 5, "value_score": 9, "country": "US", "sector": "Materials" }, { "momentum_score": 1, "company_name": "AAC HOLDINGS", "kscore": 9, "trade_date": "2019-06-28", "growth_score": 2, "symbol": "AAC", "quality_score": 2, "value_score": 1, "country": "US", "sector": "Health Care" }, { "momentum_score": 9, "company_name": "AMER AIRLINES", "kscore": 1, "trade_date": "2019-06-28", "growth_score": 1, "symbol": "AAL", "quality_score": 5, "value_score": 7, "country": "US", "sector": "Industrials" }, { "momentum_score": 1, "company_name": "ALTISOURCE ASST", "kscore": 5, "trade_date": "2019-06-28", "growth_score": 2, "symbol": "AAMC", "quality_score": 7, "value_score": 2, "country": "US", "sector": "Financials" } ]
Filtering by Symbol
You can specify multiple symbols in your query to limit the results and reduce the number of rows returned. This allows you to retrieve data only for the symbols you’re interested in.
[ { "momentum_score": 7, "quality_score": 8, "kscore": 3, "value_score": 6, "symbol": "AAPL", "company_name": "APPLE INC", "trade_date": "2018-07-16", "growth_score": 5, "country": "US", "sector": "Information Technology" }, { "momentum_score": 8, "quality_score": 6, "kscore": 9, "value_score": 2, "symbol": "AMZN", "company_name": "AMAZON.COM INC", "trade_date": "2018-07-16", "growth_score": 9, "country": "US", "sector": "Consumer Discretionary" } ]
Querying Historical Data by Trade Date
Use the "trade_date" parameter to retrieve historical data for specific dates.
[ { "momentum_score": 2, "company_name": "AGILENT TECH", "kscore": 1, "trade_date": "2018-07-16", "growth_score": 8, "symbol": "A", "quality_score": 8, "value_score": 5, "country": "US", "sector": "Health Care" }, { "momentum_score": 1, "company_name": "ALTABA INC", "kscore": "9", "trade_date": "2018-07-16", "growth_score": 2, "symbol": "AABA", "quality_score": 5, "value_score": 2, "country": "US", "sector": "Consumer Discretionary" }, { "momentum_score": 6, "company_name": "AAC HOLDINGS", "kscore": 6, "trade_date": "2018-07-16", "growth_score": 2, "symbol": "AAC", "quality_score": 4, "value_score": 2, "country": "US", "sector": "Health Care" }, { "momentum_score": 1, "company_name": "AMER AIRLINES", "kscore": 1, "trade_date": "2018-07-16", "growth_score": 3, "symbol": "AAL", "quality_score": 8, "value_score": 7, "country": "US", "sector": "Industrials" }, { "momentum_score": 1, "company_name": "ALTISOURCE ASST", "kscore": 5, "trade_date": "2018-07-16", "growth_score": 2, "symbol": "AAMC", "quality_score": 7, "value_score": 2, "country": "US", "sector": "Financials" } ]
Selecting Multiple Columns
Use the "field" parameter to query multiple columns in a single request.
[ { "sector": "Information Technology", "kscore": 3, "trade_date": "2018-07-16", "symbol": "AAPL" }, { "sector": "Consumer Discretionary", "kscore": 9, "trade_date": "2018-07-16", "symbol": "AMZN" } ]
Downloading Complete Historical Data
The API is limited to 10,000 rows per request. To access the entire historical dataset, use the CSV download button. Data is available in daily, monthly, or yearly intervals.
Usage Limits
This service is available exclusively to subscribers, who are limited to 10 API requests per minute.