API Documentation

Getting Started

AltIndex API is a simple HTTP REST API for searching and retrieving alternative data on public companies. You need an API key to use the API - this is a unique key that identifies your requests.

This API can help you answer questions like:

What companies are outperforming their stock price?
Is company A popular on Reddit?
Is company B looking to hire more people?
How many visitors does company.com get every month?
What companies have the most popular mobile apps?

If you have any problems or requests, please contact us.

Get your key

To get started you'll need an API key. They're currently available to our PRO and Enterprise users.
Your key is unique and should not be shared with others.

Rate Limits

A rate limit is the number of API calls a user can make within a given time period. If this limit is exceeded, the request will return a HTTP 400 status code.

A Pro user may use up to 50 requests per day. If you need more requests than that, please contact us.

The rate limits help us provide the reliable and scalable API that our developer community relies on.

Errors

If you make a bad request we'll let you know by returning a relevant HTTP status code along with more details in the body.

Error response example

{
    status: 400,
    code: "apiKey Missing",
    message: "Your API key is missing. Append this to the URL with the apiKey param."
}

Endpoints

Our Restful API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. Here are the EndPoints the API support.

Ticker

/ticker

Our Ticker API lets you search for companies via their specific ticker.

Method: GET

Request Example: https://api.altindex.com/ticker/?apiKey=your_key&ticker=TSLA

Response Example

{
 status: 200,
 id: "1",
 name: "Tesla",
 logo: "https://altindex.com/assets/images/tickers/TSLAjpg",
 domain: "tesla.com",
 ticker: "TSLA",
 industry: "Autos",
 employees: "70757",
 description: "Tesla Inc is a vertically integrated sustainable energy company. It designs, develops, manufactures and sells high-performance fully electric vehicles and electric vehicle  powertrain components.",
 facebook_id: null,
 twitter_screenname: "tesla",
 instagram: "teslamotors",
 ios_app: "https://apps.apple.com/us/app/tesla/id582007913",
 android_app: "https://play.google.com/store/apps/details?id=com.teslamotors.tesla"
}

Timeline

/timeline

Providing a company or cryptocurrency's symbol (ticker), the /timeline endpoint returns all the timeline data such as Reddit mentions, App Downlods, Job posts, etc.

Method: GET

Request Example: https://api.altindex.com/timeline/?apiKey=your_key&symbol=TSLA

Response Example

{
status: 200,
id: "1",
name: "Tesla",
logo: "https://altindex.com/assets/images/tickers/TSLA.jpg",
domain: "tesla.com",
ticker: "TSLA",
description: "Tesla Inc is a vertically integrated sustainable energy company. It designs, develops, manufactures and sells high-performance fully electric vehicles and electric vehicle powertrain components.",
industry: "Autos",
facebook: null,
twitter: "https://twitter.com/tesla",
instagram: "https://instagram.com/teslamotors",
youtube: "https://youtube.com/channel/UC5WjFrtBdufl6CZojX3D8dQ",
reddit_sub: "https://reddit.com/r/teslamotors",
discord: null,
telegram: null,
ios_app: "https://apps.apple.com/us/app/id582007913",
android_app: "https://play.google.com/store/apps/details?id=com.teslamotors.tesla",
peers: [
    "TSLA",
    "TM",
    "F",
    "GM",
    "TTM",
    "VC",
    "NIO",
    "GOEV",
    "FSR",
    "RIDE",
    "NKLA",
    "WKHS",
    "LCID"
],
data: {
    daily: [{
        date: "2021-10-04",
        news_mentions: 535,
        reddit_mentions: 447,
        reddit_sentiment: 69,
        reddit_subscribers_total: 1348178,
        stocktwits_mentions: 484,
        stocktwits_sentiment: 80,
        stocktwits_subscribers_total: 717865,
        tipranks_followers_total: 56227,
        tipranks_sentiment: 74,
        tipranks_score: 5,
        twitter_mentions: 20387,
        twitter_followers_total: 11114490,
        instagram_followers_total: 8775518,
        youtube_subscribers_total: 2070000,
        ios_downloads: 5952,
        ios_reviews_total: 5415,
        ios_rating: 3.7,
        android_downloads: 1842,
        android_reviews_total: 18088,
        android_rating: 3.4,
        app_downloads: 3897,
        jobs_glassdoor: 6776,
        jobs_indeed: 3409,
        jobs_linkedin: 6000,
        job_posts: 5395,
        sentiment: 74,
        patents: 242,
        financials: {
            price: 781.53,
            target_price: 833.795,
            analyst_target_price: 690.64,
            buy_ratio: 44,
            market_cap: 783112667000,
            pe_ratio: 412.09,
            shares_outstanding: 1001770000,
            shorted_shares: 26999700
        },
        ai_scores: {
            score: 41,
            audience: 56,
            employement: 57,
            customer: 25,
            fundamental: 25
        }
    }...

Benchmark

/industry_benchmark

Providing a company or cryptocurrency's symbol (ticker), the /industry_benchmark endpoint returns the most recent benchmark score along with all peers data for all data sources.

Method: GET

Request Example: https://api.altindex.com/industry_benchmark/?apiKey=your_key&symbol=TSLA

Response Example

{
status: 200,
symbol: "TSLA",
data: {
    news_mentions: {
        date: "2021-10-04",
        value: 535,
        benchmark: 1,
        delta: 282.14
        peers: [{
            id: "11138",
            name: "Lucid Motors",
            ticker: "LCID",
            domain: "lucidmotors.com",
            logo: "https://altindex.com/assets/images/tickers/LCID.jpg",
            value: 6
        },
        {
            id: "19",
            name: "Ford",
            ticker: "F",
            domain: "ford.com",
            logo: "https://altindex.com/assets/images/tickers/F.jpg",
            value: 315
        }..
        ],
    }..