API Tutorial

1. Introduction

1.1 Request an API Key: To get an API key, please sign up for a free account. You can find your API Key on your product page.

1.2 Access data from API: All Kavout products can be accessed via the API. Once subscribed to our products, you will automatically receive the API URL for the requested datasets.

2. Usage

To use the API, copy and paste the URL into you preferred browser. Users with programming experience can also use wget or curl to run these calls from the command line.

2.1 Default

If the product_id and api_key are in the URL, it returns the most recent updated data.

Sample Request: https://www.kavout.com/api?product_id=kscore_us&api_key=YourAPIKey

Example Response


[
    {
        "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"
    }
]

2.2 Filter by Symbol

Multiple symbols can be selected when querying as to reduce the number of rows being returned.

Sample Request: https://www.kavout.com/api?product_id=kscore_us&symbol=AAPL,AMZN&api_key= YourAPIKey

Example Response（display 5 rows below）


[
    {
        "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"
    }
]

2.3 Query historical data by trade_date

This format allows historical data to be queried via "trade_date".

Sample Request: https://www.kavout.com/api?product_id=kscore_us&trade_date=2018-07-16&api_key=YourAPIKey

Example Response（display 5 rows below）


[
    {
        "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"
    }
]

2.4 Select multiple columns

Multiple colunms can be queried via "field".

Sample Request: https://www.kavout.com/api?product_id=kscore_us&trade_date=2018-07-16&api_key= YourAPIKey&symbol=AAPL,AMZN&field=symbol,trade_date,kscore,sector

Example Response


[
    {
        "sector": "Information Technology",
        "kscore": 3,
        "trade_date": "2018-07-16",
        "symbol": "AAPL"
    },
    {
        "sector": "Consumer Discretionary",
        "kscore": 9,
        "trade_date": "2018-07-16",
        "symbol": "AMZN"
    }
]

2.5 Download entire historical data: The API has a limit of 10,000 rows of data. If you require all historical data, please use the CSV download button. Datasets are available daily, monthly or yearly.

3. Limits

This service only available to subscribers.
Subscribers are limited to 10 API requests per minute.