Everything you need to integrate SocialHeat data into your applications. RESTful API with JSON responses, webhooks, and comprehensive SDK support.
Sign up and generate your API key from the dashboard
Add your API key to the Authorization header
Call endpoints and receive JSON responses
All API requests require a Bearer token in the Authorization header.
Authorization: Bearer YOUR_API_KEY Content-Type: application/json X-API-Version: 2
/v2/fanpage/insights
Retrieve engagement metrics, follower demographics, and content performance for a specific fanpage.
| Param | Type | Required | Description |
|---|---|---|---|
page_id | string | Yes | Facebook page ID or URL |
metrics | array | No | Specific metrics to return |
date_range | string | No | last_7_days, last_30_days, custom |
/v2/listening/mentions
Retrieve social mentions matching your tracked keywords, with sentiment and source metadata.
| Param | Type | Required | Description |
|---|---|---|---|
keyword_id | string | Yes | Tracked keyword identifier |
sentiment | string | No | Filter: positive, negative, neutral |
limit | integer | No | Results per page (max 100) |
/v2/sentiment/analyze
Analyze sentiment of custom text input. Returns sentiment classification, confidence score, and detected topics.
| Param | Type | Required | Description |
|---|---|---|---|
text | string | Yes | Text to analyze (max 5000 chars) |
language | string | No | ISO 639-1 code (auto-detected) |
/v2/webhooks
Register a webhook to receive real-time notifications for mention spikes, sentiment shifts, or new data.
| Param | Type | Required | Description |
|---|---|---|---|
url | string | Yes | Your webhook endpoint URL |
events | array | Yes | Events to subscribe to |
secret | string | No | Signing secret for verification |
| Plan | Requests/minute | Requests/day | Concurrent |
|---|---|---|---|
| Agency | 60 | 5,000 | 5 |
| Business | 120 | 10,000 | 10 |
| Enterprise | Custom | Unlimited | Custom |
Official client libraries to get you started faster.
pip install socialheat
Full-featured Python client with async support.
npm install @socialheat/sdk
TypeScript-first client for Node.js applications.
Direct HTTP integration with any language. Comprehensive OpenAPI spec available.
API access is available on Business and Enterprise plans. Talk to our team to get started.