# SocialTap

> Public social media data through one API key and one JSON schema.

SocialTap returns public social media data (transcripts today; profiles, posts and comments next) from every major platform through one API key, one credit balance and one response schema per resource.

Base URL: https://staging.socialtap.dev. Authenticate with the `x-api-key` header. Responses are JSON `{data, meta}`; errors are `{error: {code, message, request_id}}`.

## Docs

- [Quickstart](https://staging.socialtap.dev/docs/): Make your first request in a minute: one API key, one HTTP call, one JSON shape for every platform.
- [Authentication](https://staging.socialtap.dev/docs/authentication/): Authenticate every request with your API key in a header. One key works for every endpoint and platform.
- [Credits and caching](https://staging.socialtap.dev/docs/credits/): How requests are priced, reserved and charged, how to read what you paid, and how to get free cache hits.
- [Errors](https://staging.socialtap.dev/docs/errors/): Every error code, its HTTP status, whether a later retry can succeed, and what to do about it.
- [Pagination](https://staging.socialtap.dev/docs/pagination/): How list endpoints return items in pages, how to fetch the next page with a cursor, and how pages are priced.
- [API reference](https://staging.socialtap.dev/docs/reference/): interactive OpenAPI reference
- [Pricing](https://staging.socialtap.dev/pricing/): credit packs and the price of every endpoint

## Facebook

- [Facebook Video Transcript API](https://staging.socialtap.dev/apis/facebook/transcript/): Facebook video transcript. `GET /v1/facebook/transcript`; params: url (string, required), max_age (integer); price: 1 credit (captions), 2 credits + 2 per started minute of media (asr)

## Instagram

- [Instagram Reels Transcript API](https://staging.socialtap.dev/apis/instagram/transcript/): Instagram reel / video transcript. `GET /v1/instagram/transcript`; params: url (string, required), max_age (integer); price: 1 credit (captions), 2 credits + 2 per started minute of media (asr)

## TikTok

- [TikTok Transcript API](https://staging.socialtap.dev/apis/tiktok/transcript/): TikTok video transcript. `GET /v1/tiktok/transcript`; params: url (string, required), lang (string), max_age (integer); price: 1 credit (captions), 2 credits + 2 per started minute of media (asr)

## YouTube

- [YouTube Transcript API](https://staging.socialtap.dev/apis/youtube/transcript/): YouTube video transcript. `GET /v1/youtube/transcript`; params: url (string, required), lang (string), max_age (integer); price: 1 credit (captions), 2 credits + 2 per started minute of media (asr)

## Upcoming schemas

Draft schemas with no endpoint yet: not available, and they may change before the first endpoint ships.

- [Ad (draft)](https://staging.socialtap.dev/resources/ad/): A public ad library entry: advertiser, creatives, run dates, placements and, where disclosed, reach and spend ranges.
- [Comment (draft)](https://staging.socialtap.dev/resources/comment/): A public comment or reply on a post, with its author, thread position and like/reply counts.
- [Post (draft)](https://staging.socialtap.dev/resources/post/): A public post (video, reel, short, photo, carousel, tweet or text) with its author, media and engagement metrics.
- [Profile (draft)](https://staging.socialtap.dev/resources/profile/): A public account (creator, channel, page, company or community) with its bio, links and follower metrics.

## Optional

- [OpenAPI](https://staging.socialtap.dev/openapi.json): OpenAPI 3.1 document
- [Catalog](https://staging.socialtap.dev/catalog.json): machine-readable list of endpoints, params, prices and errors
- [Status](https://staging.socialtap.dev/status/): live endpoint health and measured latency and success rates