page loading

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 API Hub

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.

Get Started Now

Feeling like an eager beaver? Jump into the quick-start docs and get making your first request:

API Offerings:

Social Sentiment

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 - COMING SOON!

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.

SEC Analysis - COMING SOON!

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.

Quickstart Guide

Follow the steps below to setup, test, and make your first API request with Utradea APIs.

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

To obtain your API Key, you must :

Rate Limit Guidelines

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

Language Support

Language

Version

Node.js

nodejs version 12 or higher

Python

python version 3.6 or higher

Authentication Steps

Step 1 - Sign Up For Your Utradea Account (Free)

If you do not have an account with Utradea, go to https://utradea.com/ and click 'Register'.

Step 2 - Click on the 'Settings' icon on Utradea feed page.

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

Go to settings page

Step 3 - Click Generate API Key in 'API' Section

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.

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.

A timestamp will be displayed in this section to tell you when you last created the api secret key.

Social

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).

Implementation Example

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); }); });

Social Tickers

Search for tickers currently mentioned on Twitter, StockTwits, and Reddit. You can use these tickers to query the other social timestamp endpoints.

Response Fields

Field Name

Type

Description

twitter

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.

reddit

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.

Social Timestamps

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.

15 Minutes

30 Minutes

1 Hour

4 Hours

1 Day

Response Fields

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.

Social Moving Averages

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.

72 Hour Avg

1 Week Avg

2 Week Avg

1 Month Avg

Response Fields

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.

by Mentions

by Comments

by Likes

by Impressions

Response Fields

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.

Most Changed Tickers

Search the top 50 tickers trending on social media with the greatest change in likes, comments, posts, and impressions.

by Mentions

by Impressions

Response Fields

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.

Live Feeds

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.

Direct Feed

Filtered Feed

Response Fields

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.

Top Tickers by Sentiment

Search for top 50 trending bullish/bearish stocks/crypto symbols on Twitter/StockTwits.

Most Bullish

Most Bearish

Change in Bullish/Bearish

Search for top 50 trending stocks or crypto symbols on social media with the greatest change in bullish or bearish sentiment on Twitter/StockTwits.

Most Gained Bullish

Most Gained Bearish

Response Fields

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.

Social Statistics

Search for a stock or cryptocurrency's sentiment statistics from posts generated on Twitter or Stocktwits by user post category (influencers,spam,bot).

High Bot Volume

High Spam Volume

High Influencer Volume

Response Fields

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.

Error Codes

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:

fmp-banner