> ## Documentation Index
> Fetch the complete documentation index at: https://docs.b3os.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Social Sentiment

Fetch social media sentiment for a stock symbol from Finnhub (Reddit, X/Twitter mentions). Returns hourly buckets with mention counts and sentiment scores (-1..1), plus aggregated totalMentions and mention-weighted averageScore. Ideal for: sentiment-based trading signals, social buzz alerts, monitoring retail interest in a stock.

Catalog action Blockchain Data

Fetch social media sentiment for a stock symbol from Finnhub (Reddit, X/Twitter mentions). Returns hourly buckets with mention counts and sentiment scores (-1..1), plus aggregated totalMentions and mention-weighted averageScore. Ideal for: sentiment-based trading signals, social buzz alerts, monitoring retail interest in a stock.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `finnhub-get-social-sentiment` |
| Category | Blockchain Data |
| Connector | Not required |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `finnhub`, `stock`, `sentiment`, `social`, `analysis`, `read` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `symbol` | `string` | Yes | Stock symbol to get social sentiment for, e.g. 'AAPL', 'TSLA'. |
| `from` | `string` | No | Start date in YYYY-MM-DD format. Default: API default range \(most recent data\). |
| `to` | `string` | No | End date in YYYY-MM-DD format. Default: API default range. |

## Result Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `symbol` | `string` | Yes | The symbol sentiment is for |
| `data` | `array` | Yes | Hourly sentiment buckets, most recent first |
| `totalMentions` | `number` | Yes | Sum of mentions across all returned buckets |
| `averageScore` | `number \| null` | No | Mention-weighted average sentiment score \(-1..1\) across buckets; null when no data |

## Examples

**Workflow node**

```json
{
  "type": "finnhub-get-social-sentiment",
  "payload": {
    "symbol": "ETH"
  },
  "children": []
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/finnhub-get-social-sentiment/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "symbol": "ETH"
  }
}'
```

**Use expressions for dynamic values**

Payload fields can use workflow expressions such as `{{$trigger.body.amount}}`, `{{$nodes.fetch.result.price}}`, and `{{$props.asset}}` when the value should come from a trigger, prior node, or reusable workflow prop.