Which tier would you like to upgrade your app to?
Starter
$10/Mo
Premium
$40/Mo
Enterprise
See Details
Developer Logs
Filter by error
Create a new app
Hey it looks like you are trying to create a new app. You can create 5 apps per account. Any developer subscriptions do not transfer between applications unless you have special permission
Cancel
Yes, get started
Tell us about your app
Oh no, you already used this name
Create App
Choose a plan
You can choose on of our three developer plans. You can choose view them on our solutions page. Alternatively you can do this later.
Skip for now
Select a plan
Start Programming
We have collections of REST APIs and packages in all yoru favourite languages to make integrating our data into your system as seamless as possible. Check out our documentation to start right away.
Finish Up
See documentation
Security check
We can provide custom documentation for your configuration if you authenticate. We ask you to authenticate as we populate the documentation with your auth credentials.
Authenticate
I'll do it later
New App
Get stock data with our REST endpoints
Our REST endpoints are a simple lightweight way to interact with our API and data. We have client support in Node JS and Python. As such we recommend where possible use our client libraries. We provide REST endpoints for use in languages that we do not support with our client libraries.
Realtime
We have several realtime data endpoints. Two of these are available to all app tiers. These allow you to access different attributes of a stock's social media data.
Parsed Data
Sandbox
Starter
Premium
Enterprise
Our parsed data endpoint allows you to access our four primary metrics. These metrics have been backtested and refined to be easiest to incorporated into trading algorithms. You can learn more about our parsed metrics in our Learn section.
https://api.sentimentinvestor.com/v4/parsed?symbol=AAPL
"symbol
Adjust the symbol
"key"
You can retrieve your API Key from the developer dashboard
"token"
You can retrieve your API Token from the developer dashboard
//expected output as a JSON object

{
success: true,
symbol: 'AAPL',
results: {
AHI: 1.35,
RHI: 1.2,
sentiment: 0.49,
SGP: 0.89,
}
}
Raw Data
Sandbox
Starter
Premium
Enterprise
Our raw data endpoint allows you to access enriched data from social platforms we monitor. We suggest you use this endpoint to get intuitive data that is directly intregratable into strategies and backtests. You can learn about what exactly each raw data metric means in our Learn Section.
https://api.sentimentinvestor.com/v4/raw?symbol=AAPL
"symbol
Adjust the symbol
"key"
You can retrieve your API Key from the developer dashboard
"token"
You can retrieve your API Token from the developer dashboard
//expected output as a JSON object

{
success: true,
symbol: 'AAPL',
results: {
reddit_comment_mentions: 43,
reddit_comment_sentiment: 0.34,
reddit_post_mentions: 3,
reddit_post_sentiment: 3,
tweet_mentions: 88,
tweet_sentiment: 0.97,
stocktwits_post_mentions: 43,
stocktwits_post_sentiment: 43,
yahoo_finance_comment_mentions: 3,
yahoo_finance_comment_sentiment: 0.34,
}
}
Quote Data
Starter
Premium
Enterprise
You can use our quote data endpoint to access all realtime data about stocks along with further data enrichments that are not provided in the Raw Data and Parsed Data return objects. The data enrichment boolean is by default false - Premium and Enterprise apps can set this to true to recieve more data enrichments
https://api.sentimentinvestor.com/v4/quote?symbol=AAPL
"symbol"
Adjust the symbol
"enrich" [optional]
Premium and Enterprise apps can enrich their quote data by setting this to true, by default it is false
"key"
You can retrieve your API Key from the developer dashboard
"token"
You can retrieve your API Token from the developer dashboard
//expected output as a JSON object

{
success: true,
symbol: 'AAPL',
results: {
AHI: 1.35,
RHI: 1.2,
sentiment: 0.49,
SGP: 0.89,
reddit_comment_mentions: 43,
reddit_comment_sentiment: 0.34,
reddit_post_mentions: 3,
reddit_post_sentiment: 3,
tweet_mentions: 88,
tweet_sentiment: 0.97,
stocktwits_post_mentions: 43,
stocktwits_post_sentiment: 43,
yahoo_finance_comment_mentions: 3,
yahoo_finance_comment_sentiment: 0.34,


//the following data enrichments are only accessible if the "enrich" parameter is set to true


subreddits: {
wallstreetbets_mentions: 46,
wallstreetbets_sentiment: 0.35,
pennystocks_mentions: 23,
pennystocks_sentiment: 0.98,
stocks_mentions: 23,
stocks_sentiment: 0.78,
//further subreddit data enrichments
}
engagement: {
tweet_likes: 46,
reddit_post_likes: 0.35,
reddit_comment_likes: 23,
stocktwits_post_likes: 0.98,
yahoo_finance_comment_likes: 23,
}
//further data enrichments
}
}
Bulk Data
Premium
Enterprise
The bulk parameter allows you to access the data from many stocks simultaneously. This counts calls based on the number of stocks you request, for example requesting data on AAPL, GME, and TSLA would count as three calls.
https://api.sentimentinvestor.com/v4/bulk?symbols=AAPL,GME,TSLA
"symbols"
Set this parameter to an a string of comma-separated symbols i.e. ("GME,TSLA,AAPL")
"enrich" [optional]
Premium and Enterprise apps can enrich their quote data by setting this to true, by default it is false
"key"
You can retrieve your API Key from the developer dashboard
"token"
You can retrieve your API Token from the developer dashboard
//expected output as a JSON object

{
success: true,
symbols: ['AAPL','GME', 'TSLA'],
results: [
{
symbol: 'AAPL',
AHI: 1.35,
reddit_comment_mentions: 43,
reddit_comment_sentiment: 0.34,
reddit_post_mentions: 3,
reddit_post_sentiment: 0.13,
tweet_mentions: 88,
//further data enrichments
}

{
symbol: 'TSLA',
AHI: 1.45,
reddit_comment_mentions: 12,
reddit_comment_sentiment: 0.94,
reddit_post_mentions: 32,
reddit_post_sentiment: 0.9,
tweet_mentions: 88,
//further data enrichments

},

{
symbol: 'GME',
AHI: 0.98,
reddit_comment_mentions: 45,
reddit_comment_sentiment: 0.88,
reddit_post_mentions: 1,
reddit_post_sentiment: 0.77,
tweet_mentions: 12,
//further data enrichments
}
]
All Data
Enterprise
An endpoint that returns an array of objects consisting of every stocks and all the data associated with each stock except historical data. This uses up the number of calls as stocks present.
https://api.sentimentinvestor.com/v4/all?
This returns data in the same format as the bulk endpoint but just extends the list to a larger number of stocks
Historical Data
Sandbox
Starter
Premium
Enterprise

The historical data parameter allows you to access current supported historical data for stocks. We continuously populate our database with historical data about stocks so if a stock is missing some data initially you can expect it to soon have historical data. We currently have Reddit, Twitter, and Yahoo Finance historical data and we are working with data providers to expand this offering.

Anyone with a Starter, Premium, or Enterprise app can access fully granular complete historical data. Sandbox API keys can access daily historical data limited to a year.

Your calls will be counted based on the number of datapoints that you request

https://api.sentimentinvestor.com/v4/historical?start=1614556869&end=1619654469&symbol=AAPL&metric=AHI
"symbol"
Set this parameter to the symbol you would like historical data for
"start"
A timestamp in epoch for when you would like to start retrieving historical data
"end"
A timestamp in epoch for when you would like to finish retrieving historical data
"metric"
Select the metric would you like to query historical data for
"key"
You can retrieve your API Key from the developer dashboard
"token"
You can retrieve your API Token from the developer dashboard
//expected output as a JSON object

{
success: true,
symbol: 'AAPL',
metric: 'reddit_comment_mentions',
results: [
{
data: 0.031675641431738996 ,
timestamp: 1618017002.3850255
},
{
data: 0.032552083333333336,
timestamp:1618146249.9471605
},
{
data: 0.032552083333333336,
timestamp: 1618146857.1892784
},
{
data:0.028793550244745177 ,
timestamp: 1618161775.28788
},

//the timeseries continues as an array of objects
]
Sort Data
Sandbox
Starter
Premium
Enterprise

You can use the sort data endpoint to access ordered rankings of stocks across our core metrics. This is useful for screeners and trading algorithms. The sort method can return up to 100 stocks.

Your calls will be calculated based on the number of stocks that you request data on.

https://api.sentimentinvestor.com/v4/sort?metric=AHI&limit=90
"metric"
Set this parameter to the metric you would like historical data for. The options are AHI, RHI, sentiment, SGP, tweet_mentions, tweet_sentiment, reddit_comment_mentions, reddit_comment_sentiment, reddit_post_mentions, reddit_post_sentiment, stocktwits_post_mentions, stocktwits_post_sentiment, yahoo_finance_comment_sentiment, yahoo_finance_comment_mentions
"limit"
The maximum number of stocks you want returned
"key"
You can retrieve your API Key from the developer dashboard
"token"
You can retrieve your API Token from the developer dashboard
//expected output as a JSON object (sort)

{
success: true,
symbol: 'AAPL',
results: {
AHI: 1.35,
RHI: 1.2,
sentiment: 0.49,
SGP: 0.89,
reddit_comment_mentions: 43,
reddit_comment_sentiment: 0.34,
reddit_post_mentions: 3,
reddit_post_sentiment: 3,
tweet_mentions: 88,
tweet_sentiment: 0.97,
stocktwits_post_mentions: 43,
stocktwits_post_sentiment: 43,
yahoo_finance_comment_mentions: 3,
yahoo_finance_comment_sentiment: 0.34,


//the following data enrichments are only accessible if the "enrich" parameter is set to true


subreddits: {
wallstreetbets_mentions: 46,
wallstreetbets_sentiment: 0.35,
pennystocks_mentions: 23,
pennystocks_sentiment: 0.98,
stocks_mentions: 23,
stocks_sentiment: 0.78,
//further subreddit data enrichments
}
engagement: {
tweet_likes: 46,
reddit_post_likes: 0.35,
reddit_comment_likes: 23,
stocktwits_post_likes: 0.98,
yahoo_finance_comment_likes: 23,
}
//further data enrichments
}
}
Other
We provide a few administrative endpoints that allow developers to access other types of metadata about the API like which stocks are maintained or raw data from our database. The latter can be found in our opensource section.
Supported Stocks
Sandbox
Starter
Premium
Enterprise
Our supported stock endpoints allows developers to establish if a stocks has data on it currently or not. This endpoint does not use a call. The only parameter is the name of the stock, and it returns a simple boolean along with a key and token.
https://api.sentimentinvestor.com/v4/supported?symbol=AAPL
All Stocks
Premium
Enterprise
This endpoint does not use up any calls. It simply returns a list of every stock that we gather data on. This is a dynamic list so please be aware of this before storing this data.
https://api.sentimentinvestor.com/v4/all-stocks?
System Diagnostics
Sandbox
Starter
Premium
Enterprise
This endpoint does not use up any calls. It returns a JSON object that has a parameter attached every part of the system. Each paramter is a boolean which contains true or false depending on whether the system is functional or not functioning.
https://api.sentimentinvestor.com/v4/diagnostic?