YouTube

YouTube Channel Videos API

Beta

Returns the public uploads of a YouTube channel a page at a time: its videos, shorts or live streams, each with its link, title, thumbnail, length, views and upload time, newest, oldest or most popular first. The newest uploads also carry exact times, view and like counts and descriptions. Accepts a handle, any channel link or a channel ID.

GET /v1/youtube/posts

Try it

Example

cURL
curl -G 'https://staging.socialtap.dev/v1/youtube/posts' \
  --data-urlencode 'handle=@jawed' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
Node.js
const params = new URLSearchParams({
  handle: "@jawed",
});
const res = await fetch(`https://staging.socialtap.dev/v1/youtube/posts?${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, page, meta } = body;
console.log(data, meta.credits_charged);
Python
import os

import requests

res = requests.get(
    "https://staging.socialtap.dev/v1/youtube/posts",
    params={"handle": "@jawed"},
    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, page, meta = body["data"], body["page"], body["meta"]
print(data, meta["credits_charged"])
Go
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("handle", "@jawed")
	req, err := http.NewRequest("GET", "https://staging.socialtap.dev/v1/youtube/posts?"+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"`
		Page  json.RawMessage `json:"page"`
		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"])
}
PHP
<?php

$query = http_build_query([
    'handle' => '@jawed',
]);
$ch = curl_init('https://staging.socialtap.dev/v1/youtube/posts?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('SOCIALTAP_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
    throw new RuntimeException($body['error']['code'] . ': ' . $body['error']['message']);
}
print_r($body['data']);
echo $body['meta']['credits_charged'], PHP_EOL;
Ruby
require "json"
require "net/http"

uri = URI("https://staging.socialtap.dev/v1/youtube/posts")
uri.query = URI.encode_www_form('handle' => '@jawed')
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = ENV.fetch("SOCIALTAP_API_KEY")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(req) }
body = JSON.parse(res.body)
raise "#{body["error"]["code"]}: #{body["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
pp body["data"]
puts body["meta"]["credits_charged"]
Java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;

public class Main {
    public static void main(String[] args) throws Exception {
        String query = "handle=" + encode("@jawed");
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://staging.socialtap.dev/v1/youtube/posts?" + query))
            .header("x-api-key", System.getenv("SOCIALTAP_API_KEY"))
            .GET()
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        // An error is {"error": {"code", "message", ...}}; success is {data, meta}, meta.credits_charged its price.
        if (response.statusCode() >= 400) throw new RuntimeException(response.body());
        System.out.println(response.body());
    }

    static String encode(String value) {
        return URLEncoder.encode(value, StandardCharsets.UTF_8);
    }
}
.NET
using System.Text.Json;

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));

var query = string.Join("&",
    "handle=" + Uri.EscapeDataString("@jawed"));
var res = await http.GetAsync("https://staging.socialtap.dev/v1/youtube/posts?" + query);
using var body = JsonDocument.Parse(await res.Content.ReadAsStringAsync());
if (!res.IsSuccessStatusCode)
{
    var error = body.RootElement.GetProperty("error");
    throw new Exception($"{error.GetProperty("code")}: {error.GetProperty("message")}");
}
Console.WriteLine(body.RootElement.GetProperty("data"));
Console.WriteLine(body.RootElement.GetProperty("meta").GetProperty("credits_charged"));
Rust
// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use std::env;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let res = reqwest::blocking::Client::new()
        .get("https://staging.socialtap.dev/v1/youtube/posts")
        .query(&[("handle", "@jawed")])
        .header("x-api-key", env::var("SOCIALTAP_API_KEY")?)
        .send()?;
    let ok = res.status().is_success();
    let body: serde_json::Value = res.json()?;
    if !ok {
        return Err(format!("{}: {}", body["error"]["code"], body["error"]["message"]).into());
    }
    println!("{} {}", body["data"], body["meta"]["credits_charged"]);
    Ok(())
}
200 OK
{
  "data": [
    {
      "approximate_fields": [],
      "author": {
        "avatar_url": "https://yt3.googleusercontent.com/uI3VE4PVqvCy0xnWLqMJnEzyBUm3T8VHOCp4ee-1RxdHqKXCdUE_qXYQnpf9AfuEoIPactVyDhM=s900-c-k-c0x00ffffff-no-rj",
        "display_name": "jawed",
        "id": "UC4QobU6STFB0P71PMvOGN5A",
        "is_verified": null,
        "url": "https://www.youtube.com/channel/UC4QobU6STFB0P71PMvOGN5A",
        "username": "jawed"
      },
      "coauthors": [],
      "duration_ms": 19000,
      "hashtags": [],
      "id": "jNQXAC9IVRw",
      "is_nsfw": null,
      "is_pinned": null,
      "is_sponsored": null,
      "language": null,
      "media": [
        {
          "alt_text": null,
          "duration_ms": 19000,
          "expires_at": null,
          "height": 360,
          "thumbnail_url": "https://i.ytimg.com/vi/jNQXAC9IVRw/hqdefault.jpg",
          "type": "video",
          "url": null,
          "width": 480
        }
      ],
      "mentions": [],
      "metrics": {
        "comment_count": null,
        "like_count": 20117813,
        "quote_count": null,
        "repost_count": null,
        "save_count": null,
        "share_count": null,
        "view_count": 446865949
      },
      "platform": "youtube",
      "platform_specific": {
        "youtube": {
          "author_subscriber_count": null,
          "category": null,
          "chapters": [],
          "description_links": [
            "https://www.youtube.com/watch?v=0PT5c1z3LL8",
            "https://www.youtube.com/watch?v=RRBN_4L09Mg"
          ],
          "is_age_restricted": null,
          "is_live_now": null,
          "is_paywalled": null,
          "is_unlisted": null,
          "keywords": [],
          "live_ended_at": null,
          "live_started_at": null,
          "scheduled_start_at": null
        }
      },
      "platform_type": "video",
      "published_at": "2005-04-24T03:31:52Z",
      "text": "Microplastics are accumulating in human brains at an alarming rate\nhttps://www.youtube.com/watch?v=0PT5c1z3LL8\n\n“Nanoplastics and Human Health” with Matthew J Campen, PhD, MSPH\nhttps://www.youtube.com/watch?v=RRBN_4L09Mg\n\n00:00 Intro\n00:05 The cool thing\n00:17 End",
      "thumbnail_url": "https://i.ytimg.com/vi/jNQXAC9IVRw/hqdefault.jpg",
      "title": "Me at the zoo",
      "type": "video",
      "unknown_fields": [
        "coauthors",
        "platform_specific.youtube.keywords",
        "platform_specific.youtube.chapters"
      ],
      "url": "https://www.youtube.com/watch?v=jNQXAC9IVRw"
    }
  ],
  "page": {
    "has_more": false,
    "next_cursor": null,
    "next_cursor_expires_at": null,
    "end_reason": "end"
  },
  "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": "profile",
      "id": "UC4QobU6STFB0P71PMvOGN5A",
      "url": "https://www.youtube.com/@jawed"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": [],
    "mode": "live"
  }
}
x-api-keystringheaderrequired

Your API key. Keys starting with st_test_ are test keys: recorded responses, free. Authentication

NameTypeDescriptionExample
handle requiredstring
max 2,048 chars
YouTube channel: a handle with or without the @, any channel link (@handle, /channel/UC…, legacy /c/, /user/ and root vanity links, any tab, m. and music. hosts), a bare UC… channel ID, or c/<name>, user/<name>, vanity/<name>.@MrBeast
tab optionalstringThe channel tab to list: videos (default), shorts or live (upcoming, live and past streams).
One of videos, shorts, live
shorts
sort optionalstringOrder of the results. newest (default), popular (most viewed first) or oldest.
One of newest, popular, oldest
—
since optionalstring
date-time
Only items at or after this time: RFC 3339 (2026-10-01T12:00:00Z) or a date (2026-10-01, midnight UTC). On newest-first lists, paging stops when it is reached, so later pages are not fetched or charged. Beyond the newest uploads published_at is approximate ("3 weeks ago"): uploads up to one label unit older may be included. Not with tab=shorts.2026-10-01
until optionalstring
date-time
Only items before this time (exclusive): RFC 3339 or a date (midnight UTC). Not with tab=shorts.2026-10-08
limit optionalinteger
min 1
max 48
Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for.48
cursor optionalstringpage.next_cursor from the previous response. Send the same other parameters; omit to start from the first page.—
handlestringrequiredmax 2,048 chars

YouTube channel: a handle with or without the @, any channel link (@handle, /channel/UC…, legacy /c/, /user/ and root vanity links, any tab, m. and music. hosts), a bare UC… channel ID, or c/<name>, user/<name>, vanity/<name>.

Example@MrBeast

tabstring

The channel tab to list: videos (default), shorts or live (upcoming, live and past streams).

One ofvideosshortslive

Exampleshorts

sortstring

Order of the results. newest (default), popular (most viewed first) or oldest.

One ofnewestpopularoldest

sincestringdate-time

Only items at or after this time: RFC 3339 (2026-10-01T12:00:00Z) or a date (2026-10-01, midnight UTC). On newest-first lists, paging stops when it is reached, so later pages are not fetched or charged. Beyond the newest uploads published_at is approximate ("3 weeks ago"): uploads up to one label unit older may be included. Not with tab=shorts.

Example2026-10-01

untilstringdate-time

Only items before this time (exclusive): RFC 3339 or a date (midnight UTC). Not with tab=shorts.

Example2026-10-08

limitintegermin 1max 48

Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for.

Example48

cursorstring

page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page.

handle takes YouTube profile links; another kind of link, or another platform's, fails free with invalid_input. Unknown parameters are rejected with a suggestion, never ignored (Requests). limit and cursor page through the list: see Pagination.

Parameters every endpoint accepts
NameTypeDescriptionExample
max_age optionalinteger
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 optionalstringReturn 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.—
max_ageintegermin 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.

fieldsstring

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

application/json

200

{data, page, meta}. data is an array of up to 48 post objects, newest first; page says how to get the next page; meta describes the request (meta). Fields only YouTube has are under platform_specific.youtube.

FieldTypeDescription
data[].platformstringPlatform ID (tiktok, youtube, …).
data[].idstringPlatform-native post ID (string; Instagram shortcode, Reddit without t3_).
data[].urlstring (uri)Canonical post URL.
data[].typestringNormalized content shape. New values may be added; treat unknown values as other.
One of video, image, carousel, text, link, audio
data[].platform_typestring or nullThe platform's own product label, lowercase (reel, short, story, live, tweet, …).
data[].titlestring or nullHeadline (YouTube title, Reddit title); null on caption-only platforms.
data[].textstring or nullCaption, description or body as plain text.
data[].languagestring or nullBCP-47 language of text, when the platform states it.
data[].published_atstring (date-time) or nullWhen the post went public, RFC 3339 UTC.
data[].authorobjectThe posting account.
data[].author.idstring or nullPlatform-native account ID; null when only the handle is known.
data[].author.usernamestring or nullHandle without the @; null when the account has none.
data[].author.display_namestring or nullDisplay name shown on the profile.
data[].author.urlstring (uri) or nullCanonical profile URL.
data[].author.avatar_urlstring (uri) or nullProfile picture URL. Platform CDN URLs can expire within hours.
data[].author.is_verifiedboolean or nullPlatform verification badge; null where the platform has no badge.
data[].coauthorsobject[]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[].idstring or nullPlatform-native account ID; null when only the handle is known.
data[].coauthors[].usernamestring or nullHandle without the @; null when the account has none.
data[].coauthors[].display_namestring or nullDisplay name shown on the profile.
data[].coauthors[].urlstring (uri) or nullCanonical profile URL.
data[].coauthors[].avatar_urlstring (uri) or nullProfile picture URL. Platform CDN URLs can expire within hours.
data[].coauthors[].is_verifiedboolean or nullPlatform verification badge; null where the platform has no badge.
data[].duration_msinteger or nullLength of the primary video or audio in milliseconds; null for other posts.
data[].thumbnail_urlstring (uri) or nullCover or poster image URL.
data[].mediaobject[]Attachments in display order (carousel items); [] for text posts.
data[].media[].typestringKind of file. New values may be added; treat unknown values as other.
One of image, video, audio, gif
data[].media[].urlstring (uri) or nullDirect 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_atstring (date-time) or nullWhen 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_urlstring (uri) or nullPoster or preview image URL.
data[].media[].widthinteger or nullWidth in pixels.
data[].media[].heightinteger or nullHeight in pixels.
data[].media[].duration_msinteger or nullDuration in milliseconds (video and audio only).
data[].media[].alt_textstring or nullAccessibility text provided by the author or platform.
data[].hashtagsstring[]Hashtags without #, case kept; [] if none.
data[].mentionsstring[]Mentioned or tagged usernames without @; [] if none.
data[].is_pinnedboolean or nullPinned to the author's profile.
data[].is_sponsoredboolean or nullLabeled as a paid partnership or branded content.
data[].is_nsfwboolean or nullMarked adult or sensitive by the platform.
data[].metricsobjectCounts at fetch time; null = hidden or not exposed, 0 = zero.
data[].metrics.view_countinteger or nullViews or plays.
data[].metrics.like_countinteger or nullLikes, hearts, total reactions or upvotes; never negative. Null when hidden by the owner.
data[].metrics.comment_countinteger or nullComments and replies.
data[].metrics.share_countinteger or nullShares or sends (not reposts).
data[].metrics.repost_countinteger or nullReposts, retweets or reshares.
data[].metrics.quote_countinteger or nullQuote posts.
data[].metrics.save_countinteger or nullSaves, bookmarks or favorites.
data[].platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
data[].platform_specific.youtubeobject or nullA YouTube video's own fields.
data[].platform_specific.youtube.categorystring or nullYouTube category (Music, Gaming, …), in English.
data[].platform_specific.youtube.keywordsstring[]The uploader's tags; [] when none.
data[].platform_specific.youtube.chaptersobject[]Chapters in playback order; [] when none.
data[].platform_specific.youtube.chapters[].titlestring or nullChapter title.
data[].platform_specific.youtube.chapters[].start_msinteger or nullStart, in ms from the beginning.
data[].platform_specific.youtube.description_linksstring[]Links in the description, in order, deduplicated; [] when none.
data[].platform_specific.youtube.is_unlistedboolean or nullUnlisted: watchable by link, not listed on the channel or in search.
data[].platform_specific.youtube.is_age_restrictedboolean or nullViewers must sign in to confirm their age; null when the answer does not tell.
data[].platform_specific.youtube.is_paywalledboolean or nullMust be bought or rented (movies, paid content).
data[].platform_specific.youtube.is_live_nowboolean or nullA live stream on air now.
data[].platform_specific.youtube.live_started_atstring (date-time) or nullWhen a live stream or premiere went on air; null if never live.
data[].platform_specific.youtube.live_ended_atstring (date-time) or nullWhen a live stream or premiere ended; null while live or if never live.
data[].platform_specific.youtube.scheduled_start_atstring (date-time) or nullWhen a scheduled stream or premiere is due to start; null otherwise.
data[].platform_specific.youtube.author_subscriber_countinteger or nullThe channel's subscriber count, rounded by YouTube (in approximate_fields); null when hidden.
data[].approximate_fieldsstring[]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_fieldsstring[]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.
platformstring

Platform ID (tiktok, youtube, …).

idstring

Platform-native post ID (string; Instagram shortcode, Reddit without t3_).

urlstring uri

Canonical post URL.

typestring

Normalized content shape. New values may be added; treat unknown values as other.

One ofvideoimagecarouseltextlinkaudio

platform_typestringnullable

The platform's own product label, lowercase (reel, short, story, live, tweet, …).

titlestringnullable

Headline (YouTube title, Reddit title); null on caption-only platforms.

textstringnullable

Caption, description or body as plain text.

languagestringnullable

BCP-47 language of text, when the platform states it.

published_atstring date-timenullable

When the post went public, RFC 3339 UTC.

authorobject

The posting account.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

coauthorsobject[]

Other accounts credited as co-authors of the post (Instagram and Facebook collabs, YouTube collaborations), in the platform's order, author excluded; [] if none.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

duration_msintegernullable

Length of the primary video or audio in milliseconds; null for other posts.

thumbnail_urlstring urinullable

Cover or poster image URL.

mediaobject[]

Attachments in display order (carousel items); [] for text posts.

ShowHide 8 child fields
typestring

Kind of file. New values may be added; treat unknown values as other.

One ofimagevideoaudiogif

urlstring urinullable

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.

expires_atstring date-timenullable

When url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire.

thumbnail_urlstring urinullable

Poster or preview image URL.

widthintegernullable

Width in pixels.

heightintegernullable

Height in pixels.

duration_msintegernullable

Duration in milliseconds (video and audio only).

alt_textstringnullable

Accessibility text provided by the author or platform.

hashtagsstring[]

Hashtags without #, case kept; [] if none.

mentionsstring[]

Mentioned or tagged usernames without @; [] if none.

is_pinnedbooleannullable

Pinned to the author's profile.

is_sponsoredbooleannullable

Labeled as a paid partnership or branded content.

is_nsfwbooleannullable

Marked adult or sensitive by the platform.

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 7 child fields
view_countintegernullable

Views or plays.

like_countintegernullable

Likes, hearts, total reactions or upvotes; never negative. Null when hidden by the owner.

comment_countintegernullable

Comments and replies.

share_countintegernullable

Shares or sends (not reposts).

repost_countintegernullable

Reposts, retweets or reshares.

quote_countintegernullable

Quote posts.

save_countintegernullable

Saves, bookmarks or favorites.

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 1 child field
youtubeobjectnullable

A YouTube video's own fields.

ShowHide 12 child fields
categorystringnullable

YouTube category (Music, Gaming, …), in English.

keywordsstring[]

The uploader's tags; [] when none.

chaptersobject[]

Chapters in playback order; [] when none.

ShowHide 2 child fields
titlestringnullable

Chapter title.

start_msintegernullable

Start, in ms from the beginning.

description_linksstring[]

Links in the description, in order, deduplicated; [] when none.

is_unlistedbooleannullable

Unlisted: watchable by link, not listed on the channel or in search.

is_age_restrictedbooleannullable

Viewers must sign in to confirm their age; null when the answer does not tell.

is_paywalledbooleannullable

Must be bought or rented (movies, paid content).

is_live_nowbooleannullable

A live stream on air now.

live_started_atstring date-timenullable

When a live stream or premiere went on air; null if never live.

live_ended_atstring date-timenullable

When a live stream or premiere ended; null while live or if never live.

scheduled_start_atstring date-timenullable

When a scheduled stream or premiere is due to start; null otherwise.

author_subscriber_countintegernullable

The channel's subscriber count, rounded by YouTube (in approximate_fields); null when hidden.

approximate_fieldsstring[]

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.

unknown_fieldsstring[]

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: 2 error codes. Free: errors cost nothing.

CodeHTTPRetryMeaningWhat to do
invalid_input400NoThe 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.
invalid_cursor400NoThe cursor is malformed, expired, belongs to another endpoint, or the other parameters differ from the request that issued it.Repeat the original request without cursor to start the list again.

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.

The cursor is malformed, expired, belongs to another endpoint, or the other parameters differ from the request that issued it.

Repeat the original request without cursor to start the list again.

401

401 Unauthorized: 1 error code. Free: errors cost nothing.

CodeHTTPRetryMeaningWhat to do
unauthorized401NoThe 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).
unauthorizedNo retry

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.

CodeHTTPRetryMeaningWhat to do
insufficient_credits402NoThe 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_reached402NoThe 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.

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.

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.

CodeHTTPRetryMeaningWhat to do
forbidden403NoThe 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; 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_unavailable403NoThe 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.
forbiddenNo retry

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; 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.

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.

CodeHTTPRetryMeaningWhat to do
not_found404NoThe item does not exist or was deleted.Check the URL or ID; do not retry.
not_foundNo retry

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.

CodeHTTPRetryMeaningWhat to do
rate_limited429Yes, laterThe 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 to raise the ceiling if your sustained traffic needs more (calls without an API key: use one).
rate_limitedYes, 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 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.

CodeHTTPRetryMeaningWhat to do
internal500Yes, laterUnexpected SocialTap error.Retry with backoff; contact support with the request_id if it persists.
internalYes, later

Unexpected SocialTap error.

Retry with backoff; contact support with the request_id if it persists.

502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

CodeHTTPRetryMeaningWhat to do
upstream_error502Yes, laterThe platform failed or returned something unexpected.Retry with backoff; failed requests are free.
upstream_errorYes, 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.

CodeHTTPRetryMeaningWhat to do
upstream_blocked503Yes, laterThe platform refused every attempt.Retry later with backoff; failed requests are free.
overloaded503Yes, laterSocialTap 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.

The platform refused every attempt.

Retry later with backoff; failed requests are free.

overloadedYes, 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.

Items come in pages, newest first. To get the next page, send the same request plus cursor set to page.next_cursor from the previous response. Keep every other parameter the same (limit, max_age and fields may change); anything else that differs is rejected. When page.has_more is false the walk is over, and page.end_reason says why: only end means you have every item (the others say the platform or a page cap stopped the walk early).

Order
sort=newest (the default): newest first; sort=oldest: oldest first; sort=popular: YouTube's Popular order (most viewed first)
Page size
Up to 48 posts (the default; limit lowers it)
Cursor lifetime
1 hour; don't store cursors
Price
Per page, 1 credit

The page object

FieldTypeDescription
page.has_morebooleanTrue when another page exists; then next_cursor is set. An empty page with has_more true is not the end.
page.next_cursorstring or nullPass as cursor, with the same other parameters, to get the next page; null at the end.
page.next_cursor_expires_atstring (date-time) or nullWhen next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.
page.end_reasonstring or nullWhy there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.
One of end, platform_limit, max_pages
has_moreboolean

True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.

next_cursorstringnullable

Pass as cursor, with the same other parameters, to get the next page; null at the end.

next_cursor_expires_atstring date-timenullable

When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

end_reasonstringnullable

Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.

One ofendplatform_limitmax_pages

Next page

cURL: next page
curl -G 'https://staging.socialtap.dev/v1/youtube/posts' \
  --data-urlencode 'handle=@jawed' \
  --data-urlencode 'cursor=NEXT_CURSOR' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
  • The price is per page: each successful page costs the same, whatever limit is and however many items it has. Empty pages are charged too (an empty page with has_more: true is not the end).
  • A limit below 48 doesn't save credits: the next request serves the rest of the same platform page, which is fetched again and charged as a page each time, and items can shift between those requests if the platform changes the list. Omitting limit is the cheapest way to walk the list.
  • Errors are free, including a rejected cursor.
  • Pages served from the cache are free.
  • An expired or altered cursor, or one sent with different parameters, fails with invalid_cursor (HTTP 400): Repeat the original request without cursor to start the list again.

Pagination guide

From 1 credit per page. Charged per successful page, whatever its number of items. 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.

SourcePrice per successful pagePer 1,000 pages
Any source1 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 (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

meta.sourceSourceWhat it means
apiPlatform APIThe platform's public, logged-out API.
pagePublic pageData embedded in the platform's public web page.

meta.credits_charged and the x-credits-charged header show what you paid. How credits work · Packs

A key starting with st_test_ gets recorded responses, free and the same every time (test mode). The recorded inputs return their recording; any other input returns the example above.

16 recorded inputs and magic inputs
InputAnswer
UCOpNcN46UbXVtpKMrmU4Abg
with sort=newest tab=videos
200 OK
rickastleyvevo
with sort=newest tab=videos
200 OK
mrbeast
with sort=newest tab=videos
200 OK
UCLA_DiR1FfKNvjuUpBHmylQ
with sort=newest tab=live
200 OK
UCzucOGEnILK5cAdUUVCIefg
with sort=newest tab=videos
200 OK
mrbeast
with sort=newest tab=live
200 OK
hikakintv
with sort=newest tab=videos
200 OK
jawed
with sort=newest tab=videos Default
200 OK
mrbeast
with sort=newest tab=shorts
200 OK
mrbeast
with sort=newest tab=shorts
200 OK
mrbeast
with sort=popular tab=shorts
200 OK
UCX6OQ3DkcsbYNE6H8uQQuVB
with sort=newest tab=videos
404 not_found
mrbeast
with sort=newest tab=videos
200 OK
rickastleyyt
with sort=oldest tab=videos
200 OK
nasa
with sort=popular tab=videos
200 OK
nasa
with sort=popular tab=videos
200 OK

Magic inputs: send one of these as handle to get that error.

ErrorValue
invalid_inputsocialtap_test_invalid_input
invalid_cursorsocialtap_test_invalid_cursor
insufficient_creditssocialtap_test_insufficient_credits
spend_limit_reachedsocialtap_test_spend_limit_reached
rate_limitedsocialtap_test_rate_limited
not_foundsocialtap_test_not_found
private_or_unavailablesocialtap_test_private_or_unavailable
upstream_blockedsocialtap_test_upstream_blocked
upstream_errorsocialtap_test_upstream_error
overloadedsocialtap_test_overloaded
internalsocialtap_test_internal

Endpoint ID youtube.posts · operationId youtube.posts.list · Product overview

Last updated