SocQ API examples

Backend-safe, copy-paste examples for collecting public social media data with SocQ. The examples cover the shared task workflow and the current Instagram, TikTok, YouTube, and Facebook endpoints.

Start in five minutes

1. Create an API key.
2. Copy .env.example to .env.
3. Set SOCQ_API_KEY.
4. Run a cURL, Node.js, or Python example.
5. Store the returned task_id, then poll GET /v1/tasks/{task_id} until the task succeeds or fails.

cp .env.example .env
export SOCQ_API_KEY="your-api-key"

Never put a SocQ API key in browser code, mobile apps, public repositories, screenshots, fixtures, or logs.

Focused API repositories

Every current submit endpoint has a focused repository with cURL, Node.js, and Python examples, endpoint-specific behavior, production guidance, responsible use notes, and synthetic fixtures.

Instagram	Facebook	YouTube	TikTok	X
Posts	Pages	Channels	Profiles	Profiles
Comments	Posts	Videos	Videos	Posts
Followers Count	Comments	Channel Videos	Comments	User Posts
Reels		Comments	Search	Search
Search		Shorts	Hashtags
		Search
		Transcripts

LinkedIn

Profiles	Companies	Posts	Jobs
LinkedIn Profiles API	LinkedIn Companies API	LinkedIn Posts API	LinkedIn Jobs API

Reddit

Posts	Comments	Subreddit Posts	Search
Reddit Posts API	Reddit Comments API	Reddit Subreddit Posts API	Reddit Search API

Pinterest

Profiles	Pins	User Pins	Search
Pinterest Profiles API	Pinterest Pins API	Pinterest User Pins API	Pinterest Search API

Threads

Profiles	Posts	User Posts
Threads Profiles API	Threads Posts API	Threads User Posts API

Facebook Marketplace

Location Search	Listing Search	Item Details
Facebook Marketplace Location Search API	Facebook Marketplace Search API	Facebook Marketplace Item API

Facebook Ad Library

Ad Search	Ad Details	Company Ads	Company Search
Facebook Ad Library Search API	Facebook Ad Library Ad API	Facebook Ad Library Company Ads API	Facebook Ad Library Company Search API

TikTok Shop

Search	Store Products	Product Details	Product Reviews	User Showcase
TikTok Shop Search API	TikTok Shop Products API	TikTok Shop Product API	TikTok Shop Product Reviews API	TikTok Shop User Showcase API

The machine-readable inventory in catalog/endpoints.json maps all 51 public endpoint contracts to their focused repositories.

Shared workflow

submit public-data task
        |
        v
store task_id
        |
        v
poll task status  <---- callback is a notification, not a result payload
        |
        v
read data.results.items
        |
        v
follow data.results.next_cursor when data.results.has_more is true

Task states are queued, running, succeeded, and failed. Callback delivery is best-effort, so production systems should keep polling as a fallback.

Repository layout

catalog/       Public endpoint manifest and focused-repository metadata
curl/          Copy-paste HTTP requests
node/          Runnable Node.js examples
python/        Runnable Python examples
shared/        Reusable task clients
fixtures/      Synthetic response shapes used by checks and documentation
docs/          Production integration guidance
scripts/       Local and CI validation

Public-data scope

SocQ is built for public social data workflows. It is not an official API of Instagram, TikTok, YouTube, or Facebook and does not provide access to private account data.

Support

• API documentation
• API catalog
• Example issues
• Private account or billing support: support@socq.ai

The MIT license covers the example code in this repository. It does not grant rights to SocQ's hosted service, third-party platform data, trademarks, or private product source code.