# Social

All **GET methods** are associated with retrieving Utradea's social insights by ticker(s)

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

{% hint style="info" %}
You must **pass the required headers** with your enterprise access token.

Expand the below GET method table for details.
{% endhint %}

### Endpoints

## /get-social

<mark style="color:blue;">`GET`</mark> `URL:https://cloud.utradea.com/v1/get-social`

#### Query Parameters

| Name                                      | Type   | Description                                                                                                                                                                                                                                                                                                                                             |
| ----------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| tickers<mark style="color:red;">\*</mark> | String | <p>ticker representing either a company or crypto currency.</p><p></p><p><strong>Accepted Values:</strong></p><p><code>?ticker=PLTR</code></p><p><code>?ticker=PLTR,GOOGL</code></p>                                                                                                                                                                    |
| social<mark style="color:red;">\*</mark>  | String | <p>Indicator to include tickers that are trending as captured in the Social Dashboard.</p><p></p><p><strong>Accepted Values:</strong></p><p><code>?social=reddit</code></p><p><code>?social=stocktwits</code></p><p><code>?social=twitter</code></p><p><code>?social=reddit,stocktwits,twitter</code></p>                                               |
| charts<mark style="color:red;">\*</mark>  | String | <p>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.</p><p></p><p><strong>Accepted Values:</strong></p><p><code>?charts=posts</code>,</p><p><code>?charts=comments</code>,</p><p><code>?charts=likes</code>,</p><p><code>?charts=impressions</code></p> |

#### Headers

| Name                                            | Type   | Description      |
| ----------------------------------------------- | ------ | ---------------- |
| Content-Type<mark style="color:red;">\*</mark>  | String | application/json |
| Authorization<mark style="color:red;">\*</mark> | String | ${YOUR\_APIKEY}  |

{% tabs %}
{% tab title="200: OK Successful requests will return the following response." %}

```javascript
{ 
  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"
      }
  ]
}
```

{% endtab %}

{% tab title="400: Bad Request The following error message is triggered if you do not pass the proper query parameters." %}

```javascript
{
    statusCode: 400,
    errorMessage: "Invalid Chart Type Error."
}
```

{% endtab %}

{% tab title="403: Forbidden The following error message is triggered if you do not have the proper authentication." %}

```javascript
{
    statusCode: 403,
    errorMessage: "Invalid Chart Type Error."
}
```

{% endtab %}

{% tab title="500: Internal Server Error The following error message is triggered if there is an issue with Utradea's server." %}

```javascript
{
    statusCode: 500,
    errorMessage: "Internal Server Error."
}
```

{% endtab %}

{% tab title="429: Too Many Requests The following error message is triggered when the number of requests exceed the rate limit specified for your membership tier." %}

```javascript
{
    statusCode: 429,
    errorMessage: "You have exceeded your rate limit of 5 requests in 15 minutes!"
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Node.js" %}

```javascript
// 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);
        });
});
```

{% endtab %}

{% tab title="Sample Response " %}

```javascript
[
  {
    "stocktwitsPosts": 98,
    "twitterPosts": 429,
    "redditPosts": 1,
    "stocktwitsComments": 161,
    "twitterComments": 17318,
    "redditComments": 21,
    "stocktwitsLikes": 554,
    "twitterLikes": 86789,
    "redditLikes": 18,
    "stocktwitsImpressions": 11897,
    "twitterImpressions": 526226,
    "redditImpressions": 0,
    "symbol": "AMC",
    "timestamp": "2021-11-14T21:00:00.000Z"
  },
  {
    "stocktwitsPosts": 96,
    "twitterPosts": 281,
    "redditPosts": 1,
    "stocktwitsComments": 197,
    "twitterComments": 32279,
    "redditComments": 0,
    "stocktwitsLikes": 781,
    "twitterLikes": 160733,
    "redditLikes": 0,
    "stocktwitsImpressions": 10257,
    "twitterImpressions": 541867,
    "redditImpressions": 0,
    "symbol": "AMC",
    "timestamp": "2021-11-14T22:00:00.000Z"
  },
  {
    "stocktwitsPosts": 105,
    "twitterPosts": 312,
    "redditPosts": 0,
    "stocktwitsComments": 127,
    "twitterComments": 27503,
    "redditComments": 0,
    "stocktwitsLikes": 766,
    "twitterLikes": 152436,
    "redditLikes": 0,
    "stocktwitsImpressions": 50234,
    "twitterImpressions": 416098,
    "redditImpressions": 0,
    "symbol": "AMC",
    "timestamp": "2021-11-14T23:00:00.000Z"
  },
  {
    "stocktwitsPosts": 0,
    "twitterPosts": 0,
    "redditPosts": 0,
    "stocktwitsComments": 77,
    "twitterComments": 14986,
    "redditComments": 0,
    "stocktwitsLikes": 487,
    "twitterLikes": 80375,
    "redditLikes": 0,
    "stocktwitsImpressions": 0,
    "twitterImpressions": 0,
    "redditImpressions": 0,
    "symbol": "AMC",
    "timestamp": "2021-11-15T00:00:00.000Z"
  }
]
```

{% endtab %}
{% endtabs %}

### Field Mappings

<table><thead><tr><th width="171.8059071729958">Field Name</th><th width="150">Type</th><th width="261">Description</th></tr></thead><tbody><tr><td>symbol</td><td>String</td><td>The company or cryptocurrency symbol.</td></tr><tr><td>likes</td><td>Integer</td><td>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.</td></tr><tr><td>posts</td><td>Boolean</td><td>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.</td></tr><tr><td>comments</td><td>Integer</td><td>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.</td></tr><tr><td>impressions</td><td>Integer</td><td>The number of impressions made for a particular ticker at the recorded timestamp.</td></tr><tr><td>timestamp</td><td>String</td><td>The date and time associated with a recorded social insight. The timestamp is a string representation of a datetime object.</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.utradea.com/utradea-api-power-your-investment-insights/social.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.