API Documentation

Social Intel API

Download datasets, access samples, and integrate social data into your workflow.

Quickstart API Reference

Base URLhttps://api.socialintel.io

Quickstart

Start downloading data in under 2 minutes.

Register & get your API key

Create a free account at socialintel.io/register. Your API key is shown in your dashboard.

bash

export SOCIALINTEL_API_KEY="your_api_key_here"

Download a free sample

No auth needed for samples — try before you buy.

bash

curl "https://api.socialintel.io/api/datasets/sample/reddit-discussions?format=csv" \
  -o reddit-discussions-sample.csv

Download a full dataset (requires purchase)

bash

curl "https://api.socialintel.io/api/datasets/download/reddit-discussions?format=csv" \
  -H "X-API-Key: $SOCIALINTEL_API_KEY" \
  -o reddit-discussions.csv

Python example

python

import requests

API_KEY = "your_api_key_here"
BASE_URL = "https://api.socialintel.io"

headers = {"X-API-Key": API_KEY}

# List all available datasets
catalog = requests.get(f"{BASE_URL}/api/datasets/catalog").json()
for dataset in catalog:
    print(dataset["name"], "-", dataset["record_count"], "records")

# Download a dataset you've purchased
response = requests.get(
    f"{BASE_URL}/api/datasets/download/reddit-discussions",
    headers=headers,
    params={"format": "csv"},
)

with open("reddit-discussions.csv", "wb") as f:
    f.write(response.content)

print("Downloaded successfully")

Authentication

Pass your API key in the X-API-Key header on all authenticated requests. Sample endpoints are public and require no authentication.

bash

# Authenticated request
curl -H "X-API-Key: your_api_key_here" \
  "https://api.socialintel.io/api/datasets/download/tiktok-trending?format=csv"

# Public request (no auth needed)
curl "https://api.socialintel.io/api/datasets/sample/tiktok-trending?format=csv"

API Endpoints

GET/api/datasets/catalog

Returns all available datasets with metadata.

Response

json

[
  {
    "id": 1,
    "slug": "reddit-discussions",
    "name": "Reddit Discussions Dataset",
    "platform": "reddit",
    "description": "Posts and comments across communities",
    "record_count": 3600,
    "price_monthly": 9,
    "update_frequency": "daily",
    "formats": ["csv", "json"],
    "status": "active"
  },
  ...
]

GET/api/datasets/sample/{slug}

Download a 100-row sample of any dataset. No authentication required.

Parameters

slugpathrequiredDataset slug (e.g. reddit-discussions)

formatquerycsv or json (default: csv)

Response

json

# Returns file download (CSV or JSON)

GET/api/datasets/download/{slug} Auth required

Download the full dataset. Requires a valid API key and prior purchase (or Pro plan).

Parameters

slugpathrequiredDataset slug

formatquerycsv or json (default: csv)

Response

json

# Returns file download (CSV or JSON)
# 401 if API key missing or invalid
# 403 if dataset not purchased

GET/api/auth/me Auth required

Returns the authenticated user's profile and plan.

Response

json

{
  "id": "usr_abc123",
  "email": "you@example.com",
  "full_name": "Your Name",
  "plan": "free",
  "created_at": "2026-01-15T10:00:00Z"
}

POST/api/auth/register

Create a new account.

Parameters

emailbodyrequiredEmail address

passwordbodyrequiredPassword (min 8 chars)

full_namebodyDisplay name

Response

json

{
  "api_key": "sk_live_...",
  "user": { "id": "...", "email": "...", "plan": "free" }
}

POST/api/auth/login

Parameters

emailbodyrequiredEmail address

passwordbodyrequiredPassword

Response

json

{
  "api_key": "sk_live_...",
  "user": { "id": "...", "email": "...", "plan": "free" }
}

POST/api/payments/checkout Auth required

Initiate a PayHere payment for a dataset or Pro plan.

Parameters

dataset_slugbodySlug of dataset to purchase (omit for Pro plan)

planbody"pro" for Pro subscription

Response

json

{
  "payment_url": "https://sandbox.payhere.lk/pay/checkout?...",
  "order_id": "SI-1234567890"
}

Available Datasets

Use these slugs in API requests.

Slug	Platform	Records	Updates	Price
`financial-sentiment`	Reddit	1,000	Daily	$9
`tiktok-trending`	TikTok	529	Daily	$9
`job-market-intelligence`	Reddit	1,000	Daily	$9
`ai-training-qa`	Reddit	1,000	Weekly	$9
`brand-mention-monitoring`	Reddit	1,000	Daily	$9
`reddit-discussions`	Reddit	3,600	Daily	$9
`youtube-channels`	YouTube	2,100	Weekly	$9

Error Codes

All errors return JSON with a detail field.

Status	Meaning
`200`	OK — request succeeded
`400`	Bad Request — invalid parameters
`401`	Unauthorized — missing or invalid API key
`403`	Forbidden — dataset not purchased
`404`	Not Found — dataset slug does not exist
`422`	Unprocessable — validation error (see detail)
`429`	Rate Limited — slow down requests
`500`	Server Error — contact support

Need Help?

Questions about the API or your integration? We respond within 24 hours.

Contact Support Browse Datasets