Built for developers and automated workflowsA cross-platform public social data CLI.

Use one command line across public social platforms to discover the live API catalog, submit collections, complete asynchronous tasks, and deliver normalized results to shell scripts, CI, and data analysis workflows.

Get an API key Start in three steps

Node.js 20+Live Capability Registry12 platforms88 API endpoints

Quick start

Three steps to your first public social data collection

Install SocQ CLI, store your API key securely, then run an endpoint with the same definition used across SocQ docs, MCP, and REST.

Install SocQ CLI

Add the published @socq/cli package and make the socq command available in your terminal.

Configure your API key

Store the key in the system keyring or a protected local configuration.

Submit your first task

Run the YouTube comments endpoint and continue through the normalized result.

For CI, provide SOCQ_API_KEY through your secret manager so credentials stay protected across automated runs.

Read the complete CLI guide

What SocQ CLI can do

Choose the CLI command your task needs

Explore APIs, submit a collection, check an existing task, or export results. Each command works independently and can be combined in local terminals, shell scripts, and CI when your workflow requires it.

Independent command examples

$ socq tools youtube

Explore the current YouTube endpoints from the live Capability Registry.

Real command examples

Copy a command and start collecting public social data

These six examples use current SocQ endpoint IDs and accepted inputs. Each command is ready to copy and adapt to your workflow.

YouTube Comments API

Endpoint: youtube/comments

Collect publicly visible YouTube comments and wait for normalized results.

Twitter Search API

Endpoint: x/search

Build a focused public X post dataset from a search query.

TikTok Search API

Endpoint: tiktok/search

Search public TikTok videos and export normalized records.

Instagram Comments API

Endpoint: instagram/comments

Collect public comments from a known Instagram post URL.

Facebook Ad Library Search API

Endpoint: facebook-ad-library/search

Search public Facebook Ad Library creatives by keyword.

LinkedIn Jobs API

Endpoint: linkedin/jobs

Normalize a public LinkedIn job page into structured job fields.

How the CLI works

Submit once, keep going to complete results

SocQ CLI submits each collection as a background task and returns a task ID. Wait in the current command with --wait or save the task ID and resume later, then read normalized results or retrieve available files.

01
Submit a collection
Run a platform and resource command to create a background task.
02
Receive a task ID
The CLI returns the unique reference used to wait, resume, and read results.
03
Wait now or resume later
Use --wait now or continue the same task later with its task ID.
04
Read results or retrieve files
Export normalized results and inspect available files after the task succeeds.

01 / Submit a collection

Run the relevant platform and resource command. The CLI submits the collection as a background task.

task_id: TASK_ID

The CLI returns the unique task ID after submission.

Why SocQ CLI

One command model, from local collection to automated pipelines

SocQ CLI brings the live API catalog, asynchronous task control, and normalized results into your terminal. Validate a command locally, then use the same workflow in shell scripts and automated pipelines without maintaining separate collectors for every platform.

New API capabilities stay command-ready

Platforms, endpoints, input schemas, and billing guidance come from the live Capability Registry, so you do not maintain a second fixed command catalog.

LIVE REGISTRY → CURRENT COMMANDS

Move from local validation to automation

JSON, JSONL, CSV, and table output, file export, and meaningful exit codes make the same command model reliable in shell scripts and automated pipelines.

JSON · JSONL · CSV · EXIT CODES

Resume long-running tasks without starting over

Keep the task ID to resume after a timeout or interrupted process, then continue through paginated results and available files without resubmitting the collection.

SUBMIT → TASK_ID → RESUME → RESULTS

Choose an integration

Where should your workflow connect to SocQ?

MCP, CLI, and REST are execution paths. Agent Skill is a guidance layer. They share one API catalog and asynchronous task model, so you can choose the interface that fits your workflow.

Bring SocQ into terminals and automated pipelines

Use one command model to discover APIs, submit collections, resume asynchronous tasks, and export normalized results to files and automation.

Best for: Developers, shell scripts, and automated pipelines
How it works: socq commands + structured output
Next step: Install and run SocQ CLI

Use CLI

Optional enhancement · Agent Skill

Agent Skill

Add endpoint selection, cost control, pagination, and task recovery guidance. Pair it with MCP first, or execute through CLI or REST.

Explore Agent Skill

CLI FAQ

Frequently asked questions

What is SocQ CLI?

SocQ CLI is SocQ's command-line tool. Use it to discover and call SocQ APIs, submit public social data collections, wait for or resume asynchronous tasks, and export normalized results to files, scripts, and automated pipelines.

When should I use SocQ CLI?

Use CLI for terminal work, shell scripts, automated pipelines, batch collections, and file exports. Use MCP when an AI client should discover and call tools directly, or use the REST API for long-lived application integrations.

Does SocQ CLI cover the complete SocQ API catalog?

Yes. The CLI reads current platforms, endpoints, input schemas, and billing guidance from the live Capability Registry, so available commands follow the SocQ API catalog. Use socq platforms, socq tools, and socq describe to inspect current capabilities.

Do I need to install SocQ CLI globally?

Not necessarily. Install @socq/cli globally for regular use so the socq command is always available. Use npx @socq/cli for occasional commands or to explore the API catalog first.

Do I need an API key to use SocQ CLI?

You can browse the public Capability Registry without an API key. Collections, account queries, and task or file access require one. Use socq auth login for local work, and provide SOCQ_API_KEY through a secret manager in automated pipelines.

Is my collection canceled if waiting times out?

No. A local wait timeout does not cancel the server-side task. Keep the task ID and run socq task get or socq task wait again to continue the same task without resubmitting the collection.

Which output formats does SocQ CLI support?

SocQ CLI supports table, JSON, JSONL, and CSV. Read small results in the terminal, or use --output to write normalized results to a file for scripts, spreadsheets, or data analysis.

Which systems and runtimes does SocQ CLI support?

SocQ CLI requires Node.js 20 or later and runs on Windows, macOS, and Linux.

Start collecting public social data with one command

Create an API key