# YouTube Video API YouTube Beta Returns a public YouTube video, short or live stream: title, description with its hashtags and links, the exact publish time, duration, thumbnail, the channel and any collaborating channels, exact view, like and comment counts, and YouTube's category, tags, chapters and live stream times. Accepts every YouTube video URL form or a bare video ID. GET `/v1/youtube/post` ## Example cURL: ```shell curl -G 'https://staging.socialtap.dev/v1/youtube/post' \ --data-urlencode 'url=https://youtube.com/shorts/3cWm9B_0_kI?feature=share' \ -H "x-api-key: $SOCIALTAP_API_KEY" ``` Node.js: ```javascript const params = new URLSearchParams({ url: "https://youtube.com/shorts/3cWm9B_0_kI?feature=share", }); const res = await fetch(`https://staging.socialtap.dev/v1/youtube/post?${params}`, { headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" }, }); const body = await res.json(); if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`); const { data, meta } = body; console.log(data, meta.credits_charged); ``` Python: ```python import os import requests res = requests.get( "https://staging.socialtap.dev/v1/youtube/post", params={"url": "https://youtube.com/shorts/3cWm9B_0_kI?feature=share"}, headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]}, ) body = res.json() if not res.ok: raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}") data, meta = body["data"], body["meta"] print(data, meta["credits_charged"]) ``` Go: ```go package main import ( "encoding/json" "fmt" "log" "net/http" "net/url" "os" ) func main() { q := url.Values{} q.Set("url", "https://youtube.com/shorts/3cWm9B_0_kI?feature=share") req, err := http.NewRequest("GET", "https://staging.socialtap.dev/v1/youtube/post?"+q.Encode(), nil) if err != nil { log.Fatal(err) } req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY")) res, err := http.DefaultClient.Do(req) if err != nil { log.Fatal(err) } defer res.Body.Close() var body struct { Data json.RawMessage `json:"data"` Meta map[string]any `json:"meta"` Error *struct { Code string `json:"code"` Message string `json:"message"` } `json:"error"` } if err := json.NewDecoder(res.Body).Decode(&body); err != nil { log.Fatal(err) } if body.Error != nil { log.Fatalf("%s: %s", body.Error.Code, body.Error.Message) } fmt.Println(string(body.Data), body.Meta["credits_charged"]) } ``` 200 OK: ```json { "data": { "approximate_fields": [ "platform_specific.youtube.author_subscriber_count" ], "author": { "avatar_url": "https://yt3.ggpht.com/nxYrc_1_2f77DoBadyxMTmv7ZpRZapHR5jbuYe7PlPd5cIRJxtNNEYyOC0ZsxaDyJJzXrnJiuDE=s176-c-k-c0x00ffffff-no-rj", "display_name": "MrBeast", "id": "UCX6OQ3DkcsbYNE6H8uQQuVA", "is_verified": true, "url": "https://www.youtube.com/@MrBeast", "username": "MrBeast" }, "coauthors": [], "duration_ms": 20000, "hashtags": [], "id": "3cWm9B_0_kI", "is_nsfw": false, "is_pinned": null, "is_sponsored": null, "language": null, "media": [ { "alt_text": null, "duration_ms": 20000, "expires_at": null, "height": null, "thumbnail_url": "https://i.ytimg.com/vi/3cWm9B_0_kI/maxresdefault.jpg?sqp=-oaymwEoCIAKENAF8quKqQMcGADwAQH4AbYIgAKAD4oCDAgAEAEYRiBlKA8wDw==&rs=AOn4CLD2HeSN5ZikYi7hBi3SC7913d9CWQ", "type": "video", "url": null, "width": null } ], "mentions": [], "metrics": { "comment_count": 37974, "like_count": 13520602, "quote_count": null, "repost_count": null, "save_count": null, "share_count": null, "view_count": 731918538 }, "platform": "youtube", "platform_specific": { "youtube": { "author_subscriber_count": 524000000, "category": "Entertainment", "chapters": [], "description_links": [], "is_age_restricted": false, "is_live_now": false, "is_paywalled": false, "is_unlisted": false, "keywords": [], "live_ended_at": null, "live_started_at": null, "scheduled_start_at": null } }, "platform_type": "short", "published_at": "2024-12-27T19:00:00Z", "text": null, "thumbnail_url": "https://i.ytimg.com/vi/3cWm9B_0_kI/maxresdefault.jpg?sqp=-oaymwEoCIAKENAF8quKqQMcGADwAQH4AbYIgAKAD4oCDAgAEAEYRiBlKA8wDw==&rs=AOn4CLD2HeSN5ZikYi7hBi3SC7913d9CWQ", "title": "How Many People To Stop Ronaldo?", "type": "video", "unknown_fields": [], "url": "https://www.youtube.com/shorts/3cWm9B_0_kI" }, "meta": { "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f", "platform": "youtube", "source": "api", "is_cached": false, "credits_charged": 1, "latency_ms": 0, "fetched_at": "2026-10-25T12:00:00Z", "input": { "kind": "video", "id": "3cWm9B_0_kI", "url": "https://www.youtube.com/shorts/3cWm9B_0_kI" }, "credits_remaining": 9999, "client_request_id": null, "warnings": [], "mode": "live" } } ``` > [!NOTE] > > **Good to know** > > - platform_type is short, live (streams and premieres) or video. > - Age-restricted and paid videos are returned with their public details. > - media\[0\].url is null: YouTube's stream links only work from the IP that requested them. ## Authorizations `x-api-key`stringheaderrequired Your API key. Keys starting with `st_test_` are [test keys](https://staging.socialtap.dev/docs/test-mode/index.md): recorded responses, free. [Authentication](https://staging.socialtap.dev/docs/authentication/index.md) ## Query parameters | Name | Type | Description | Example | | --- | --- | --- | --- | | `url` required | `string`
max 2,048 chars | YouTube video, short or live stream URL (watch, youtu.be, shorts, live, embed; m. and music. hosts) or an 11-character video ID. | `https://www.youtube.com/watch?v=dQw4w9WgXcQ` | `url` takes YouTube video links; another kind of link, or another platform's, fails free with [`invalid_input`](https://staging.socialtap.dev/docs/errors/index.md#invalid_input). Unknown parameters are rejected with a suggestion, never ignored ([Requests](https://staging.socialtap.dev/docs/requests/index.md)). **Parameters every endpoint accepts** | Name | Type | Description | Example | | --- | --- | --- | --- | | `max_age` optional | `integer`
min 0 | Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. | — | | `fields` optional | `string` | Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments\[\].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole. | — | ## Response ### 200 `{data, meta}`. `data` is a [post](https://staging.socialtap.dev/resources/post/index.md) object; `meta` describes the request ([meta](https://staging.socialtap.dev/docs/reference/index.md#meta)). Fields only YouTube has are under `platform_specific.youtube`. | Field | Type | Description | | --- | --- | --- | | `data.platform` | `string` | Platform ID (tiktok, youtube, …). | | `data.id` | `string` | Platform-native post ID (string; Instagram shortcode, Reddit without t3_). | | `data.url` | `string` (uri) | Canonical post URL. | | `data.type` | `string` | Normalized content shape. New values may be added; treat unknown values as other.
One of `video`, `image`, `carousel`, `text`, `link`, `audio` | | `data.platform_type` | `string` or `null` | The platform's own product label, lowercase (reel, short, story, live, tweet, …). | | `data.title` | `string` or `null` | Headline (YouTube title, Reddit title); null on caption-only platforms. | | `data.text` | `string` or `null` | Caption, description or body as plain text. | | `data.language` | `string` or `null` | BCP-47 language of text, when the platform states it. | | `data.published_at` | `string` (date-time) or `null` | When the post went public, RFC 3339 UTC. | | `data.author` | `object` | The posting account. | | `data.author.id` | `string` or `null` | Platform-native account ID; null when only the handle is known. | | `data.author.username` | `string` or `null` | Handle without the @; null when the account has none. | | `data.author.display_name` | `string` or `null` | Display name shown on the profile. | | `data.author.url` | `string` (uri) or `null` | Canonical profile URL. | | `data.author.avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. | | `data.author.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. | | `data.coauthors` | `object[]` | Other accounts credited as co-authors of the post (Instagram and Facebook collabs, YouTube collaborations), in the platform's order, author excluded; \[\] if none. | | `data.coauthors[].id` | `string` or `null` | Platform-native account ID; null when only the handle is known. | | `data.coauthors[].username` | `string` or `null` | Handle without the @; null when the account has none. | | `data.coauthors[].display_name` | `string` or `null` | Display name shown on the profile. | | `data.coauthors[].url` | `string` (uri) or `null` | Canonical profile URL. | | `data.coauthors[].avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. | | `data.coauthors[].is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. | | `data.duration_ms` | `integer` or `null` | Length of the primary video or audio in milliseconds; null for other posts. | | `data.thumbnail_url` | `string` (uri) or `null` | Cover or poster image URL. | | `data.media` | `object[]` | Attachments in display order (carousel items); \[\] for text posts. | | `data.media[].type` | `string` | Kind of file. New values may be added; treat unknown values as other.
One of `image`, `video`, `audio`, `gif` | | `data.media[].url` | `string` (uri) or `null` | Direct file URL; null when the platform withholds it, or when the link would only work from SocialTap's network or with a login. Often signed and expiring: see expires_at. | | `data.media[].expires_at` | `string` (date-time) or `null` | When url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire. | | `data.media[].thumbnail_url` | `string` (uri) or `null` | Poster or preview image URL. | | `data.media[].width` | `integer` or `null` | Width in pixels. | | `data.media[].height` | `integer` or `null` | Height in pixels. | | `data.media[].duration_ms` | `integer` or `null` | Duration in milliseconds (video and audio only). | | `data.media[].alt_text` | `string` or `null` | Accessibility text provided by the author or platform. | | `data.hashtags` | `string[]` | Hashtags without #, case kept; \[\] if none. | | `data.mentions` | `string[]` | Mentioned or tagged usernames without @; \[\] if none. | | `data.is_pinned` | `boolean` or `null` | Pinned to the author's profile. | | `data.is_sponsored` | `boolean` or `null` | Labeled as a paid partnership or branded content. | | `data.is_nsfw` | `boolean` or `null` | Marked adult or sensitive by the platform. | | `data.metrics` | `object` | Counts at fetch time; null = hidden or not exposed, 0 = zero. | | `data.metrics.view_count` | `integer` or `null` | Views or plays. | | `data.metrics.like_count` | `integer` or `null` | Likes, hearts, total reactions or upvotes; never negative. Null when hidden by the owner. | | `data.metrics.comment_count` | `integer` or `null` | Comments and replies. | | `data.metrics.share_count` | `integer` or `null` | Shares or sends (not reposts). | | `data.metrics.repost_count` | `integer` or `null` | Reposts, retweets or reshares. | | `data.metrics.quote_count` | `integer` or `null` | Quote posts. | | `data.metrics.save_count` | `integer` or `null` | Saves, bookmarks or favorites. | | `data.platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\); each null when unknown. | | `data.platform_specific.youtube` | `object` or `null` | A YouTube video's own fields. | | `data.platform_specific.youtube.category` | `string` or `null` | YouTube category (Music, Gaming, …), in English. | | `data.platform_specific.youtube.keywords` | `string[]` | The uploader's tags; \[\] when none. | | `data.platform_specific.youtube.chapters` | `object[]` | Chapters in playback order; \[\] when none. | | `data.platform_specific.youtube.chapters[].title` | `string` or `null` | Chapter title. | | `data.platform_specific.youtube.chapters[].start_ms` | `integer` or `null` | Start, in ms from the beginning. | | `data.platform_specific.youtube.description_links` | `string[]` | Links in the description, in order, deduplicated; \[\] when none. | | `data.platform_specific.youtube.is_unlisted` | `boolean` or `null` | Unlisted: watchable by link, not listed on the channel or in search. | | `data.platform_specific.youtube.is_age_restricted` | `boolean` or `null` | Viewers must sign in to confirm their age; null when the answer does not tell. | | `data.platform_specific.youtube.is_paywalled` | `boolean` or `null` | Must be bought or rented (movies, paid content). | | `data.platform_specific.youtube.is_live_now` | `boolean` or `null` | A live stream on air now. | | `data.platform_specific.youtube.live_started_at` | `string` (date-time) or `null` | When a live stream or premiere went on air; null if never live. | | `data.platform_specific.youtube.live_ended_at` | `string` (date-time) or `null` | When a live stream or premiere ended; null while live or if never live. | | `data.platform_specific.youtube.scheduled_start_at` | `string` (date-time) or `null` | When a scheduled stream or premiere is due to start; null otherwise. | | `data.platform_specific.youtube.author_subscriber_count` | `integer` or `null` | The channel's subscriber count, rounded by YouTube (in approximate_fields); null when hidden. | | `data.approximate_fields` | `string[]` | JSON paths of values rounded by the platform or parsed from display text. A list path (external_links) means the list may be incomplete. \[\] when all exact. | | `data.unknown_fields` | `string[]` | JSON paths of lists whose \[\] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. \[\] when every list is known. | not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned. ### 400 400 Bad Request: 1 error code. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `invalid_input` | 400 | No | The request parameters are missing or malformed, or the URL is not a supported link for this endpoint. | Fix the parameter named in param (the message says how); for a link of the wrong kind, call the endpoint the message names. | ### 401 401 Unauthorized: 1 error code. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `unauthorized` | 401 | No | The x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired). | Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url). | ### 402 402 Payment Required: 2 error codes. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `insufficient_credits` | 402 | No | The account does not have enough credits for this request. | Buy credits (a human pays: details.purchase_url, or details.checkout makes a checkout link), then repeat the request; do not retry automatically. | | `spend_limit_reached` | 402 | No | The API key reached its spend limit for the current period; the account may still have credits. | Wait until details.resets_at or raise the key's spend limit (PATCH /v1/api_keys/{id}); do not retry automatically. | ### 403 403 Forbidden: 2 error codes. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `forbidden` | 403 | No | The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include. A running job stops the same way when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item (a private item is private_or_unavailable, also 403): branch on the code. | Do what details.reason says: if suspended, contact [support](https://staging.socialtap.dev/docs/index.md); otherwise use a key whose scopes cover the route (details.required_scope), have the owner confirm the emailed link, create a new key, or call from an allowed IP. | | `private_or_unavailable` | 403 | No | The item exists but is private, age- or region-gated, or requires a login to view. It shares 403 with forbidden (which is about the key): branch on the code. | Only public items can be fetched; do not retry. | ### 404 404 Not Found: 1 error code. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `not_found` | 404 | No | The item does not exist or was deleted. | Check the URL or ID; do not retry. | ### 429 429 Too Many Requests: 1 error code. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `rate_limited` | 429 | Yes, later | The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead. | Wait for the number of seconds in the retry-after header, then retry; ask [support](https://staging.socialtap.dev/docs/index.md) to raise the ceiling if your sustained traffic needs more (calls without an API key: use one). | ### 500 500 Internal Error: 1 error code. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `internal` | 500 | Yes, later | Unexpected SocialTap error. | Retry with backoff; contact [support](https://staging.socialtap.dev/docs/index.md) with the request_id if it persists. | ### 502 502 Bad Gateway: 1 error code. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `upstream_error` | 502 | Yes, later | The platform failed or returned something unexpected. | Retry with backoff; failed requests are free. | ### 503 503 Unavailable: 2 error codes. Free: errors cost nothing. | Code | HTTP | Retry | Meaning | What to do | | --- | --- | --- | --- | --- | | `upstream_blocked` | 503 | Yes, later | The platform refused every attempt. | Retry later with backoff; failed requests are free. | | `overloaded` | 503 | Yes, later | SocialTap was momentarily at capacity and did not start the request: nothing was fetched or charged. | Retry after the number of seconds in the retry-after header; failed requests are free. | ## Pricing From **1 credit** per request. Charged only for successful requests. Errors are free. The price depends on the source that produced the result, reported as `meta.source`; sources are tried cheapest first: Platform API → Public page. | Source | Price per successful request | Per 1,000 requests | | --- | --- | --- | | Platform API `api` | 1 credit | $0.75–$1.45 | | Public page `page` | 1 credit | $0.75–$1.45 | **Balance, sources and what you were charged** Your balance must be at least **1 credit** to start a request; with less, it is refused with [`insufficient_credits`](https://staging.socialtap.dev/docs/errors/index.md#insufficient_credits) (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts. | meta.source | Source | What it means | | --- | --- | --- | | `api` | Platform API | The platform's public, logged-out API. | | `page` | Public page | Data embedded in the platform's public web page. | `meta.credits_charged` and the `x-credits-charged` header show what you paid. [How credits work](https://staging.socialtap.dev/docs/credits/index.md) · [Packs](https://staging.socialtap.dev/pricing/index.md) ## Test mode A key starting with `st_test_` gets recorded responses, free and the same every time ([test mode](https://staging.socialtap.dev/docs/test-mode/index.md)). The recorded inputs return their recording; any other input returns the example above. **16 recorded inputs and magic inputs** | Input | Answer | | --- | --- | | `HtVdAasjOgU` | 200 OK | | `kCc8FmEb1nY` | 200 OK | | `a-iReT6fwVI` | 200 OK | | `XqZsoesa55w` | 200 OK | | `RRBN_4L09Mg` | 200 OK | | `jNQXAC9IVRw` | 200 OK | | `qVv6vCqciTM` | 200 OK | | `jfKfPfyJRdk` | 200 OK | | `9bZkp7q19f0` | 200 OK | | `Q39EVAstoRM` | 404 [`not_found`](https://staging.socialtap.dev/docs/errors/index.md#not_found) | | `yYr8q0y5Jfg` | 200 OK | | `yZIXLfi8CZQ` | 403 [`private_or_unavailable`](https://staging.socialtap.dev/docs/errors/index.md#private_or_unavailable) | | `3cWm9B_0_kI` Default | 200 OK | | `dQw4w9WgXcQ` | 200 OK | | `mjxtSnNyHEk` | 200 OK | | `SuaDQWjAbjg` | 200 OK | Magic inputs: send one of these as `url` to get that error. | Error | Value | | --- | --- | | [`invalid_input`](https://staging.socialtap.dev/docs/errors/index.md#invalid_input) | `https://socialtap.dev/test/invalid_input` | | [`insufficient_credits`](https://staging.socialtap.dev/docs/errors/index.md#insufficient_credits) | `https://socialtap.dev/test/insufficient_credits` | | [`spend_limit_reached`](https://staging.socialtap.dev/docs/errors/index.md#spend_limit_reached) | `https://socialtap.dev/test/spend_limit_reached` | | [`rate_limited`](https://staging.socialtap.dev/docs/errors/index.md#rate_limited) | `https://socialtap.dev/test/rate_limited` | | [`not_found`](https://staging.socialtap.dev/docs/errors/index.md#not_found) | `https://socialtap.dev/test/not_found` | | [`private_or_unavailable`](https://staging.socialtap.dev/docs/errors/index.md#private_or_unavailable) | `https://socialtap.dev/test/private_or_unavailable` | | [`upstream_blocked`](https://staging.socialtap.dev/docs/errors/index.md#upstream_blocked) | `https://socialtap.dev/test/upstream_blocked` | | [`upstream_error`](https://staging.socialtap.dev/docs/errors/index.md#upstream_error) | `https://socialtap.dev/test/upstream_error` | | [`overloaded`](https://staging.socialtap.dev/docs/errors/index.md#overloaded) | `https://socialtap.dev/test/overloaded` | | [`internal`](https://staging.socialtap.dev/docs/errors/index.md#internal) | `https://socialtap.dev/test/internal` | Endpoint ID `youtube.post` · operationId `youtube.post.get` · [Product overview](https://staging.socialtap.dev/apis/youtube/post/index.md) --- [HTML version](https://staging.socialtap.dev/docs/reference/youtube/post/) · [Docs index for AI agents](https://staging.socialtap.dev/llms.txt) · [All docs in one file](https://staging.socialtap.dev/llms-full.txt)