Tipranks.com API

For any company (e.g. Tesla) the API returns

• price targets (mean, high, low, etc) calculated from analyst estimates
• news sentiment data (bullish vs bearish) based on published articles in the last week

Examples

Tesla Price Targets

{
    "symbol": "TSLA",
    "priceTargets": {
        "mean": 297.3333333333333,
        "median": 300,
        "highest": 500,
        "lowest": 54,
        "numberOfEstimates": 21
    }
}

Tesla News Sentiment

{
    "symbol": "TSLA",
    "sentiment": {
        "bullishPercent": 0.4062,
        "bearishPercent": 0.5938
    },
    "buzz": {
        "articlesInLastWeek": 143,
        "weeklyAverage": 147.25,
        "buzz": 0.9711
    },
    "sectorAverageBullishPercent": 0.6204,
    "sectorAverageNewsScore": 0.52,
    "companyNewsScore": 0.3969
}

Setup

• Install Node.js (which includes npm) if you haven't already. On Mac in the command line type brew install node. More information here: nodejs.org
• Set up a new Node.js project. In the command line type
  • mkdir my-new-project && cd my-new-project to create a new folder
  • npm init to scaffold the Node.js project
  • touch index.js to create the file index.js
  • npm install tipranks-api-v2 to install the library to access the API
  • Copy/paste the example code below inside the index.js file

const tipranksApi = require('tipranks-api-v2');
tipranksApi.getPriceTargets('MU').then(result => console.log(result));
tipranksApi.getNewsSentimentData('MU').then(result => console.log(result));

• node index.js to run the code inside the index.js file
• Done! Now you should see the price targets and the news sentiment for the ticker MU

Documentation

The API supports the following commands:

• getPriceTargets(ticker)

  • ticker is a string representing the company ticker, e.g. TSLA.
  • This method returns the mean price target, median target, highest target, lowest target, and the number of analyst estimates. See below for an example.

• getNewsSentimentData(ticker)

  • ticker is a string representing the company ticker, e.g. TSLA.
  • This method returns the bullish and bearish sentiment in percent, the number of articles published last week, sector average bullish percent, sector average news score, and the company's news score. See example below.

Examples

Get Price Targets: getPriceTargets

index.js File

• Copy the code below into the index.js file
• node index.js to run the code

const tipranksApi = require('tipranks-api-v2');

tipranksApi.getPriceTargets('TSLA').then(result => console.log(result));

Output

{
    "symbol": "TSLA",
    "priceTargets": {
        "mean": 297.3333333333333,
        "median": 300,
        "highest": 500,
        "lowest": 54,
        "numberOfEstimates": 21
    }
}

Get News Sentiment: getNewsSentimentData

index.js File

• Copy the code below into the index.js file
• node index.js to run the code

const tipranksApi = require('tipranks-api-v2');

tipranksApi.getNewsSentimentData('TSLA').then(result => console.log(result));

Output

{
    "symbol": "TSLA",
    "sentiment": {
        "bullishPercent": 0.4062,
        "bearishPercent": 0.5938
    },
    "buzz": {
        "articlesInLastWeek": 143,
        "weeklyAverage": 147.25,
        "buzz": 0.9711
    },
    "sectorAverageBullishPercent": 0.6204,
    "sectorAverageNewsScore": 0.52,
    "companyNewsScore": 0.3969
}