# SocialRouter

> SocialRouter is a unified API for extracting data from social networks. One endpoint, normalized responses.

## Documentation

### Getting started

- [Introduction](https://docs.socialrouter.io/introduction): SocialRouter is a unified API for extracting data from social networks. One endpoint, normalized responses.
- [Quickstart](https://docs.socialrouter.io/quickstart): Make your first social data extraction in under 2 minutes.
- [Authentication](https://docs.socialrouter.io/authentication): How to authenticate with the SocialRouter API using Bearer tokens.

### Concepts

- [Providers](https://docs.socialrouter.io/concepts/providers): How SocialRouter routes requests across multiple data providers.
- [Extraction types](https://docs.socialrouter.io/concepts/extraction-types): All the data types you can extract from each social platform.
- [Credits & pricing](https://docs.socialrouter.io/concepts/credits): How credits work, pricing model, and cost tracking.

### Best practices

- [Latency and performance](https://docs.socialrouter.io/guides/latency-and-performance): Understanding SocialRouter's performance characteristics and how to minimize extraction times.
- [Failover](https://docs.socialrouter.io/guides/failover): How SocialRouter retries on the next compatible provider when one returns an error or rate-limits you.

## API reference

### Extraction

- [Extract](https://docs.socialrouter.io/api-reference/extract): Submit a social data extraction request.
- [Search](https://docs.socialrouter.io/api-reference/search): Run a query-driven search (companion to /v1/extract).
- [Get extraction](https://docs.socialrouter.io/api-reference/get-extraction): Retrieve the status and results of an extraction or search by ID.

### Providers

- [List providers](https://docs.socialrouter.io/api-reference/list-providers): List all available providers with their status and pricing. No authentication required.
- [Get provider](https://docs.socialrouter.io/api-reference/get-provider): Get details for a specific provider. No authentication required.

### Account

- [Get balance](https://docs.socialrouter.io/api-reference/get-balance): Get the current credit balance for the authenticated user.
- [Get usage](https://docs.socialrouter.io/api-reference/get-usage): Get usage summary for the authenticated user over a given period.

## SDK

### Getting started

- [SDK overview](https://docs.socialrouter.io/sdk/introduction): Official Node.js/TypeScript client library for SocialRouter.

### Reference

- [Client reference](https://docs.socialrouter.io/sdk/client): Full reference for the SocialRouter client class.
- [Error handling](https://docs.socialrouter.io/sdk/errors): How to handle errors from the SocialRouter SDK.

## CLI

### Getting started

- [CLI overview](https://docs.socialrouter.io/cli/introduction): Extract social data from the terminal with the SocialRouter CLI.

### Commands

- [extract](https://docs.socialrouter.io/cli/extract): Extract data from one or more social media URLs.
- [search](https://docs.socialrouter.io/cli/search): Run a query-driven search (e.g. Google Maps place search).
- [get](https://docs.socialrouter.io/cli/get): Retrieve a previous extraction or search by ID.
- [providers](https://docs.socialrouter.io/cli/providers): List available providers.
- [balance & usage](https://docs.socialrouter.io/cli/account): Check your credit balance and usage stats.

## MCP

- [MCP overview](https://docs.socialrouter.io/mcp/introduction): Expose SocialRouter to LLM agents via the Model Context Protocol.

## Skills

### Getting started

- [Skills overview](https://docs.socialrouter.io/skills/introduction): Portable agent skills that let coding assistants (Claude Code, Cursor, OpenCode, Windsurf, Aider, ...) look up social media data via SocialRouter.

### Available skills

- [social-profile](https://docs.socialrouter.io/skills/social-profile): Fetch normalized profile data (name, bio, follower count, location, company) from any supported social network through SocialRouter.