Documentation
Documentation - Utradea is the social platform for investments and insights. Filter through the noise and get the information you need to discover and track quality investments.
Utradea's mission is to help you cut through the noise for your investment due diligence. Now, you can do it programmatically with our APIs.
Feeling like an eager beaver? Jump into the quick-start docs and get making your first request:
Utradea’s Social Sentiment data allows investors to identify, follow, and take advantage of trending stocks and cryptocurrencies across Twitter, StockTwits, and Reddit. The ‘Sentiment’ API contains data points such as posts, comments, likes, upvotes, and impressions for stocks and cryptocurrencies discussed on these popular social platforms. Data is sourced and presented in 15min, 30min, 1hr, 4hr, 12hr, and 24hr time intervals over a 24hr or 72hr period. The change in posts, comments, and impressions over the selected time period is allowed to provide, allow for quick identification of trending stocks or cryptocurrencies. A real-time feed and linking of Tweets, Reddit Posts, and StockTwits posts allows for further analysis and validation of social trends.
The ability to track real-time sentiment for stocks and cryptocurrency is a powerful data point in today’s investment landscape. The impact that social sentiment form retail investors in the markets is significant, and the social sentiment allows you to track this in real-time
Investment ideas are user generated content, A hybrid of an equity research reports combined with a social media post, all in one report. The investment ideas are provided through the ‘Idea’ API. These range from technical analysis to fundamental due diligence of an assets, and everything in between. Investment ideas are shared by users of the Utradea community and provide an analysis of a stock or cryptocurrency a write up of why the particular asset might be a good investment.
Investment ideas are tracked on the Utradea platform and provide a transparent view of the potential investment, through an entry price, price target, duration, and the analysis. These are standardized pieces of content geared towards self-directed investors, and spark engagement and interaction
Note: Investment ideas and the information contained within the investment ideas are not investment advice.
Utradea’s SEC fillings are enhanced and analyzed versions of standard SEC filings. With the use of natural Language Processing, the SEC Filings are displayed in an intuitive manner with exhibits, summaries, and keyword phrases parsed out to provide investors with relevant and digestible information. Filings are provided by tickers and the ‘SEC’ API provides the raw filing, as well as the enhanced analysis of the filing to include the summary, exhibits, and keywords.
Providing investors with relevant bite-sized information contained within and SEC filings enhances the analysis and provides a quick way to gather key insights.
Follow the steps below to setup, test, and make your first API request with Utradea APIs.
Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.
Must be a member of Utradea.
Must obtain your apiKey by following the GET API Key steps.
Have trouble obtaining an enterprise token?
Email us at: support@utradea.com
All members are subject to request rate limits based on their Utradea membership tier.
Repeated abuse of the API rate limit is subject to further review by the Utradea team, and can result in IP address blockage or revocation of enterprise rights.
Utradea Membership Tier
Rate Limit
Standard
5 Requests per minute
Premium
15 Requests per minute
Small Business
100 requests per minute
Enterprise
1000 Requests per minute
Our get started guides are written with sample requests & responses written in Node.js or Python. Please make sure you have the following pre-requisites installed.
Language
Version
Node.js
nodejs version 12 or higher
Python
python version 3.6 or higher
If you do not have an account with Utradea, go to https://utradea.com/ and click 'Register'.
Once you have successfully registered, go to the bottom left corner and click on the 'Settings' icon, which redirects you to the 'Settings' page.
Go to settings page
On the Settings page, look for the 'API' section. Click 'Generate API Key' to create an API secret key. A created timestamp record will display in the 'API' section after your key is successfully generated.
To generate a new key, simply click 'Generate API Key'. The previously generated key will be deleted, and a new created at timestamp record will display.
Click on the refresh icon to generate an api secret key.
To copy your key for usage, click on 'Copy'.
A timestamp will be displayed in this section to tell you when you last created the api secret key.
The Sentiment API returns social insights such as likes, impressions, sentiment, and user posted comments (mentions) on social media sources such as Reddit, Twitter, & Stocktwits.
All GET methods associated with retrieving Utradea's social insights by ticker(s).
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// GET SENTIMENT
const axios = require("axios")
const getSocial = async () => new Promise((resolve, reject) => {
var options = {
method: 'GET',
url: 'http://cloud.utradea.com/v1/get-social-feed?social=stocktwits&tickers=BTC-USD,PLTR',
headers: {'
'Content-Type': 'application/json',
'Authorization': {YOUR_ENTERPRISE_ACCESS_TOKEN}
}
}
axios.request(options)
.then(function (response) {
resolve(response.data);
}).catch(function (error) {
console.log('Error on Fetch: ' + error.message);
reject(error);
});
});You must pass the required headers with your enterprise access token.
Expand the below GET method table for details.
Search for tickers currently mentioned on Twitter, StockTwits, and Reddit. You can use these tickers to query the other social timestamp endpoints.
Field Name
Type
Description
Array
Tickers currently mentioned on Twitter. These tickers may either be stocks or cryptocurrencies depending on isCrypto query parameter. Note: cryptocurrencies will have -USD appended to ticker symbols.
Array
Tickers currently mentioned on Twitter. These tickers may either be stocks or cryptocurrencies depending on isCrypto query parameter. Note: cryptocurrencies will have -USD appended to ticker symbols.
stocktwits
Array
Tickers currently mentioned on Twitter. These tickers may either be stocks or cryptocurrencies depending on isCrypto query parameter. Note: cryptocurrencies will have -USD appended to ticker symbols.
Search for a ticker and capture the total posts, comments, likes, impressions over a specified timeframe. Each timeframe is grouped by time intervals specified below.
Field Name
Type
Description
symbol
String
The company or cryptocurrency symbol.
twitterComments
Integer
The number of likes made for a particular ticker at the recorded timestamp. The value is a summation at a point in time by social source.
twitterPosts
Integer
The number of posts made for a particular ticker at the recorded timestamp.The value is a summation at a point in time by social source.
twitterLikes
Integer
The total number of twitter likes for a particular ticker at the recorded timestamp. The value is a summation at a point in time by social source.
timestamp
String
The date and time associated with a recorded social insight. The timestamp is a string representation of a datetime object.
utc
String
The UTC date string associated with the recorded summations.
local
String
The date string formatted to local time.
Search for a ticker and capture the moving average of posts, comments, likes, and impressions within a specified timeframe. Each timeframe is grouped by time intervals specified below.
Field Name
Type
Description
movingAverageTimeframe
String
The company or cryptocurrency symbol.
ticker
Integer
This is the moving average value for a specific ticker aggregated at a point in time. For example {PLTR: 31.241071428571427} shows the ticker PLTR has a moving average of 31 posts,likes,comments and impressions.
utc
String
The UTC date string associated with the recorded moving average.
local
String
The date string formatted to local time.
Search the top 50 tickers trending on social media by posts, comments, likes, or impressions.
Field Name
Type
Description
ticker
String
The company or cryptocurrency symbol.
likes
Integer
The number of likes tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the current 24/72hr time horizon.
lastLikes
Integer
The number of likes tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the previous 24/72hr time horizon.
posts
Integer
The number of posts tallied on Twitter or Stocktwits mentioning a searched ticker in the current 24/72hr time horizon.
lastPosts
Integer
The number of posts tallied on Twitter or Stocktwits mentioning a searched ticker in the previous 24/72hr time horizon.
comments
Integer
The number of comments tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the current 24/72hr time horizon.
lastComments
Integer
The number of comments tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the previous 24/72hr time horizon.
impressions
Integer
The number of impressions tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the current 24/72hr time horizon.
lastImpressions
Integer
The number of impressions tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the previous 24/72hr time horizon.
retweets
Integer
The number of retweets tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the current 24/72hr time horizon.
lastRetweets
Integer
The number of retweets tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the previous 24/72hr time horizon.
timestamp
String
The date and time associated with a recorded social insight. The timestamp is a string representation of a datetime object.
rank
Integer
The rank of the top 50 trending ticker recorded in the current 24/72hr period by change in likes, comments, posts, impressions, and retweets (if Twitter) in descending order.
price
Number
The current stock price for the top 50 trending ticker.
change
Number
The current stock price change for the top 50 trending ticker.
changePercent
Number
The current stock price change % for the top 50 trending ticker.
volume
Number
The current stock trading volume for the top 50 trending ticker.
marketCap
Number
The current market capitlization for the top 50 trending ticker.
previousVolume
Number
The last recorded stock trading volume for the top 50 trending ticker in the past 24/72hr timeframe specified.
previousVolumeClose
Number
The last recorded end of day stock trading volume for the top 50 trending ticker.
Search the top 50 tickers trending on social media with the greatest change in likes, comments, posts, and impressions.
Field Name
Type
Description
ticker
String
The company or cryptocurrency symbol.
name
String
The associated company name to the stock ticker.
posts
Integer
The number of posts tallied on Twitter or Stocktwits mentioning a searched ticker in the current 24/72hr time horizon.
likes
Integer
The number of likes tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the current 24/72hr time horizon.
lastLikes
Integer
The number of likes tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the previous 24/72hr time horizon.
rank
Integer
The rank of the top 50 trending ticker recorded in the current 24/72hr period by change in likes, comments, posts, impressions, and retweets (if Twitter) in descending order.
lastPosts
Integer
The number of posts tallied on Twitter or Stocktwits mentioning a searched ticker in the previous 24/72hr time horizon.
retweets
Integer
The number of retweets tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the current 24/72hr time horizon.
lastRetweets
Integer
The number of retweets tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the previous 24/72hr time horizon.
impressions
Integer
The number of impressions tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the current 24/72hr time horizon.
lastImpressions
Integer
The number of impressions tallied on Twitter or Stocktwits from user posts mentioning a searched ticker in the previous 24/72hr time horizon.
timestamp
String
The date and time associated with a recorded social insight. The timestamp is a string representation of a datetime object.
postsChange
Number
The % change in mentions for a ticker on StockTwits/Twitter in the specified 24/72hr time horizon.
impressionsChange
Number
The % change in impressions for a ticker on StockTwits/Twitter in the specified 24/72hr time horizon.
price
Number
The current stock price for the top 50 trending ticker.
change
Number
The current stock price change for the top 50 trending ticker.
changePercent
Number
The current stock price change % for the top 50 trending ticker.
volume
Number
The current stock trading volume for the top 50 trending ticker.
marketCap
Number
The current market capitlization for the top 50 trending ticker.
previousVolume
Number
The last recorded stock trading volume for the top 50 trending ticker in the past 24/72hr timeframe specified.
previousVolumeClose
Number
The last recorded end of day stock trading volume for the top 50 trending ticker.
Search posts from Twitter or StockTwits that mention specified tickers. In the additional feeds provided, Utradea filters posts on your behalf based on our spam criteria and returns posts that reaches 10,000+ impressions.
Field Name
Type
Description
postId
String
The company or cryptocurrency symbol.
likes
Integer
The number of likes made for a particular ticker at the recorded timestamp. This value is aggregated based on the specific social source, and aggregated at a point in time.
comments
Integer
The number of comments made for a particular ticker at the recorded timestamp.This value is aggregated based on the specific social source, and aggregated at a point in time.
impressions
Integer
The number of impressions made for a particular ticker at the recorded timestamp.
timestamp
String
The date and time associated with a recorded social insight. The timestamp is a string representation of a datetime object.
content
String
The written text associated to the StockTwits/Twitter post.
postURL
String
The post URL that redirects to the original post on StockTwits/Twitter.
isCrypto
Boolean
An indicator to determine if the post is related to a stock or cryptocurrency.
stocktwitsName
String
Name of the StockTwits user.
stocktwitsPhotoURL
String
The StockTwits user's profile Photo.
stocktwitsUserid
String
The unique identifier for the StockTwits user.
stocktwitsUsername
String
The StockTwits username for the user who posted this StockTwits post.
updatedAt
String
The date for which this post was last updatd in string format.
userJoinedAt
String
The date when the StockTwits user joinedd StockTwits in string format.
Search for top 50 trending bullish/bearish stocks/crypto symbols on Twitter/StockTwits.
Search for top 50 trending stocks or crypto symbols on social media with the greatest change in bullish or bearish sentiment on Twitter/StockTwits.
Field Name
Type
Description
ticker
String
The company or cryptocurrency symbol.
sentiment
Integer
The current sentiment score for a particular ticker.
lastSentiment
Integer
The previous sentiment score for a particular ticker.
rank
Integer
The rank of the trending ticker by change in bullish/bearish sentiment.
name
String
The associated company name to the stock ticker.
price
Number
The current stock price for ticker.
change
Number
The current stock price change for the ticker.
changePercent
Number
The current stock price change % for the ticker.
volume
Number
The current stock trading volume for the ticker.
marketCap
Number
The current market capitlization for the ticker.
previousVolume
Number
The last recorded stock trading volume for the ticker in the past 24/72hr timeframe specified.
previousVolumeClose
Number
The last recorded end of day stock trading volume for the ticker.
Search for a stock or cryptocurrency's sentiment statistics from posts generated on Twitter or Stocktwits by user post category (influencers,spam,bot).
Field Name
Type
Description
ticker
String
The company or cryptocurrency symbol.
rank
Integer
The ticker rank by change in bullish/bearish sentiment in descending order.
averageFollowingPerPost
Number
The average number of users who follow posts from identified influencers on StockTwits/Twitter
price
Number
The current stock price for ticker.
change
Number
The current stock price change for the ticker.
changePercent
Number
The current stock price change % for the ticker.
volume
Number
The current stock trading volume for the ticker.
marketCap
Number
The current market capitlization for the ticker.
Search for notifications that identify changes in social media activity for a given stock or cryptocurrency on Twitter, StockTwits, and Reddit.
Field Name
Type
Description
ticker
String
The company or cryptocurrency symbol.
actionType
String', 'The main social metric captured for a given social notification, and from which social media platform, such as 'social-spike-likes-twitter'.
subActionType
String
The supporting timeframe regarding a social notification, notably detailing the timebucket assigned for the social notification, such as '5 min'.
createdAt
String
The creation date of the social notification.
date
String
The posted date for a given social notification.
baseline-date
String
TBD
social
String
The social media platform that a social notification is created from.
baselineAverage
Number
TBD
scaleFactor
Number
TBD
changePercent
Number
TBD
currentValue
Number
TBD
timeframe
String
The timeframe in which the social notification was captured under, for example `5 min`
type
String
The type of social notification created. Social notification types include: impressions,likes,posts,tenThousandFollowers, hundredThousandFollowers, & fiveHundredThousandFollowers.
sentiment
Number
The sentiment score, between 0 and 1, measuring how bullish or bearish this notification in relation to the social notification.
sentimentAvg
Number
The average sentiment score, between 0 and 1, measuring how bullish or bearish the average sentiment is for a given stock/cryptocurrency on the social media platform.
sentimentChange
Number
The change in sentiment score for a given stock/cryptocurrency.
Search for alert notifications that identify changes in trading (price & volume), financial, & company news/announcement activities for a given stock or cryptocurrency.
Field Name
Type
Description
_id
String
TBD
title
String
The headline of the alert notification.
content
String
The alert description and analysis.
readTime
String
The average read time for a given alert.
updatedAt
String
The updated at date for a given alert.
createdAt
String
The created at date for a given alert.
ticker
String
The stock or cryptocurrency associated to the alert.
actionType
String
The type of alert that was generated. The possible action types include: 'all-time-record', 'dividends', 'earnings', 'fund-portfolio-change', 'insider-trade', 'new-price-target', 'price-volatility', 'social-spike', 'stock-grade', 'volume-volatility'
subActionType
String
TBD
useDocument
Object
The additional details captured for a given alert. This typically includes the type of alert metric, detailed breakdown of metric values captured, ticker mentioned, and available price performance statistics in available timeframes.
prices
Number
The current market price of the stock/cryptocurrency captured in relation to stock/cryptocurrency captured in the alert notification.
url
String
The shareable link for the alert notification generated by Utradea.
Search for the latest Utradea generated articles that cover analysis, commentary, & due dilligence for a given stock or cryptocurrency.
Field Name
Type
Description
catalysts
Array
*For Utradea position articles only*. Catalysts are key factors that were considered when creating an investment idea. Catalysts include: 'beta', 'bollingerBand', 'dividend', 'earningPerShare', 'earningsRelease', 'financials', 'management', 'movingAverage', 'news', 'otherCatalyst', 'priceToEarningsRatio', 'rsi', 'secFiling', 'sentiment', 'volume'
pageHit
Integer
The number of times this article was clicked on.
returnValue
Number
*For Utradea position articles only*. The rate of return for a mentioned stock/cryptocurrency in the Utradea investment idea, relative to the entry price.
userid
Integer
The userid of the author of a given Utradea article.
ticker
String
The stock or cryptocurrency symbol mentioned in the Utradea article.
entryPrice
Number
*For Utradea position articles only*. The entry price for a given stock/cryptocurrency mentioned in the Utradea investment/position article.
slug
String
The keyword string appended to the article link.
positionStatus
String
*For Utradea position articles only*.
targetPrice
Number
*For Utradea position articles only*.
sentiment
String
The sentiment label associated to the article, either 'bullish' or 'bearish'.
confidence
Number
*For Utradea position articles only*.
durationIndex
Number
*For Utradea position articles only*.
content
String
The story captured in the article, with html tags enclosing the text so it can be rendered on websites.
contentText
String
The story text captured in the artcle.
coverPhotoURL
String
The cover photo for the article.
imageCredit
String
The image credit tagged to the article.
createdAt
String
The article creation date.
updatedAt
String
The article updated at date, if the article underwent changes after it was initially created.
title
String
The title of the article
exitPrice
Number
*For Utradea position articles only*. If the Utradea article is a position article, and the mentioned investment position has hit its target price, then an exit price would be captured in the article details.
exitedAt
Number
*For Utradea position articles only*. If the Utradea article is a position article, and the mentioned investment position has hit its target price, then an exit at date would be assigned in the article details.
type
String
The type of Utradea article generated. Possible article types include: 'positions' or 'blogs'. Positions are articles that discuss analysis & investment theses for a stock/cryptocurrency, while blogs capture a broader selection of analysis, commentary, or due dilligence on multiple stocks/cryptocurrencies.
commentsCount
Number
The number of comments associated to an Utradea article.
upvotedownvoteCount
Number
The number of upvotes AND downvotes associated to an Utradea article.
upvotes
Number
The number of upvotes for a given Utradea article.
downvotes
Number
The number of downvotes for a given Utradea article.
tags
Array
The associated keyword tags associated to the Utradea article published.
Here is a list of common response errors. Wording will vary depending on the endpoint that you send and their required parameters.
In partnership with FMP - for full market data please visit:
