😀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 are associated with retrieving Utradea's social insights by ticker(s)

// GET SENTIMENT
https://cloud.utradea.com/v1/get-social

You must pass the required headers with your enterprise access token.

Expand the below GET method table for details.

Endpoints

/get-social

GET URL:https://cloud.utradea.com/v1/get-social

Query Parameters

Name	Type	Description
tickers*	String	ticker representing either a company or crypto currency. Accepted Values: ?ticker=PLTR ?ticker=PLTR,GOOGL
social*	String	Indicator to include tickers that are trending as captured in the Social Dashboard. Accepted Values: ?social=reddit ?social=stocktwits ?social=twitter ?social=reddit,stocktwits,twitter
charts*	String	The charts parameter defines the type of social insight that can be returned in this query. You can specify one type of chart or multiple charts. Accepted Values: ?charts=posts, ?charts=comments, ?charts=likes, ?charts=impressions

Headers

Name	Type	Description
Content-Type*	String	application/json
Authorization*	String	${YOUR_APIKEY}

200: OK Successful requests will return the following response.

{ 
  statusCode: 200, 
  output: 
    [
      {
        "stocktwitsPosts": 1,
        "stocktwitsComments": 15,
        "stocktwitsLikes": 72,
        "stocktwitsImpressions": 3,
        "symbol": "PLTR",
        "timestamp": "2021-11-07T22:00:00.000Z"
      },
      {
        "stocktwitsPosts": 2,
        "stocktwitsComments": 0,
        "stocktwitsLikes": 0,
        "stocktwitsImpressions": 378,
        "symbol": "PLTR",
        "timestamp": "2021-11-07T22:15:00.000Z"
      },
      {
        "stocktwitsPosts": 2,
        "stocktwitsComments": 0,
        "stocktwitsLikes": 0,
        "stocktwitsImpressions": 166,
        "symbol": "PLTR",
        "timestamp": "2021-11-07T22:30:00.000Z"
      }
  ]
}

400: Bad Request The following error message is triggered if you do not pass the proper query parameters.

403: Forbidden The following error message is triggered if you do not have the proper authentication.

500: Internal Server Error The following error message is triggered if there is an issue with Utradea's server.

429: Too Many Requests The following error message is triggered when the number of requests exceed the rate limit specified for your membership tier.

Node.js

// Some code
const axios = require("axios")

const getIdeas = async () => new Promise((resolve, reject) => {
    var options = {
        method: 'GET',
        url: 'https://api.utradea.com/v1/get-social?ticker=PLTR',
        headers: {'
            'Content-Type': 'application/json',
            'Authorization': ${YOUR_APIKEY}
        
        }
    }
    axios.request(options)
        .then(function (response) {
            resolve(response.data);
        }).catch(function (error) {
            console.log('Error on Fetch: ' + error.message);
            reject(error);
        });
});

Sample Response

Field Mappings

Field Name	Type	Description
symbol	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.
posts	Boolean	The number of posts 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.