YouTube

YouTube Comments API

Beta

Returns the public top-level comments of a YouTube video, short or live replay, a page at a time: text, author handle and channel, posting time, likes, reply count, and whether the comment is pinned, hearted, edited or written by the creator. Sort newest first (the default, which also supports since and until) or by YouTube's Top ranking, and follow page.next_cursor for more. Accepts every YouTube URL form or a bare 11-character video ID.

GET /v1/youtube/comments

Try it

Example

cURL
curl -G 'https://staging.socialtap.dev/v1/youtube/comments' \
  --data-urlencode 'sort=newest' \
  --data-urlencode 'url=jNQXAC9IVRw' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
Node.js
const params = new URLSearchParams({
  sort: "newest",
  url: "jNQXAC9IVRw",
});
const res = await fetch(`https://staging.socialtap.dev/v1/youtube/comments?${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/comments",
    params={"sort": "newest", "url": "jNQXAC9IVRw"},
    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("sort", "newest")
	q.Set("url", "jNQXAC9IVRw")
	req, err := http.NewRequest("GET", "https://staging.socialtap.dev/v1/youtube/comments?"+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([
    'sort' => 'newest',
    'url' => 'jNQXAC9IVRw',
]);
$ch = curl_init('https://staging.socialtap.dev/v1/youtube/comments?' . $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/comments")
uri.query = URI.encode_www_form('sort' => 'newest', 'url' => 'jNQXAC9IVRw')
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 = "sort=" + encode("newest")
            + "&url=" + encode("jNQXAC9IVRw");
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://staging.socialtap.dev/v1/youtube/comments?" + 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("&",
    "sort=" + Uri.EscapeDataString("newest"),
    "url=" + Uri.EscapeDataString("jNQXAC9IVRw"));
var res = await http.GetAsync("https://staging.socialtap.dev/v1/youtube/comments?" + 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/comments")
        .query(&[("sort", "newest"), ("url", "jNQXAC9IVRw")])
        .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": [
        "published_at",
        "metrics.like_count",
        "metrics.reply_count"
      ],
      "author": {
        "avatar_url": "https://yt3.ggpht.com/i8RqA9tYqbbnOi4mlnYEY7IR3kXAoDqQbM_5Sfzw7OjTubiGsOaTdlrIZmj-I0q0Vup68eqs=s88-c-k-c0x00ffffff-no-rj",
        "display_name": null,
        "id": "UCC5NfQ6Mf0dq_eEwv4P_hWA",
        "is_verified": true,
        "url": "https://www.youtube.com/channel/UCC5NfQ6Mf0dq_eEwv4P_hWA",
        "username": "SanDiegoZoo"
      },
      "edited_at": null,
      "id": "UgzuC3zzpRZkjc5Qzsd4AaABAg",
      "is_by_post_author": false,
      "is_edited": false,
      "is_liked_by_author": true,
      "is_pinned": true,
      "metrics": {
        "like_count": 4800000,
        "reply_count": 1000
      },
      "parent_id": null,
      "platform": "youtube",
      "platform_specific": {},
      "post_id": "jNQXAC9IVRw",
      "published_at": "2020-10-26T18:59:19Z",
      "text": "We're so honored that the first ever YouTube video was filmed here!",
      "unknown_fields": [],
      "url": "https://www.youtube.com/watch?v=jNQXAC9IVRw&lc=UgzuC3zzpRZkjc5Qzsd4AaABAg"
    },
    {
      "approximate_fields": [
        "published_at"
      ],
      "author": {
        "avatar_url": "https://yt3.ggpht.com/U9zdJRwdpo6WwsenxMf6AyMyRMBTWoKsyAWCnJXdbPbNKh-YNEWP3AQRgFto91lckyGCBYENnaw=s88-c-k-c0x00ffffff-no-rj",
        "display_name": null,
        "id": "UCjoZE_5A9tO470CK3G6U7dg",
        "is_verified": false,
        "url": "https://www.youtube.com/channel/UCjoZE_5A9tO470CK3G6U7dg",
        "username": "CTwGary"
      },
      "edited_at": null,
      "id": "UgxHbErLhWMUy5GlFnp4AaABAg",
      "is_by_post_author": false,
      "is_edited": false,
      "is_liked_by_author": false,
      "is_pinned": false,
      "metrics": {
        "like_count": 0,
        "reply_count": 0
      },
      "parent_id": null,
      "platform": "youtube",
      "platform_specific": {},
      "post_id": "jNQXAC9IVRw",
      "published_at": "2026-10-26T18:58:19Z",
      "text": "I can’t believe it, but it’s 21 years old now",
      "unknown_fields": [],
      "url": "https://www.youtube.com/watch?v=jNQXAC9IVRw&lc=UgxHbErLhWMUy5GlFnp4AaABAg"
    },
    {
      "approximate_fields": [
        "published_at"
      ],
      "author": {
        "avatar_url": "https://yt3.ggpht.com/Ar50xvd1O4GCXVttK6DgX0Y0cuhBl2b_HUFQjh-gajKbmS-qjuNAHOT5fw_RX_DS5gzfphkcKAI=s88-c-k-c0x00ffffff-no-rj",
        "display_name": null,
        "id": "UCFgjcRO4y8XFQL7E8_TcLlg",
        "is_verified": false,
        "url": "https://www.youtube.com/channel/UCFgjcRO4y8XFQL7E8_TcLlg",
        "username": "Nihal-poke"
      },
      "edited_at": null,
      "id": "UgzLOxwwIAUe0jUI4RR4AaABAg",
      "is_by_post_author": false,
      "is_edited": false,
      "is_liked_by_author": false,
      "is_pinned": false,
      "metrics": {
        "like_count": 0,
        "reply_count": 0
      },
      "parent_id": null,
      "platform": "youtube",
      "platform_specific": {},
      "post_id": "jNQXAC9IVRw",
      "published_at": "2026-10-26T18:58:19Z",
      "text": "I watch this video many times 😭",
      "unknown_fields": [],
      "url": "https://www.youtube.com/watch?v=jNQXAC9IVRw&lc=UgzLOxwwIAUe0jUI4RR4AaABAg"
    }
  ],
  "page": {
    "has_more": true,
    "next_cursor": "c1.EXAMPLE_CURSOR",
    "next_cursor_expires_at": "2026-10-26T12:00:00Z",
    "end_reason": null
  },
  "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": "jNQXAC9IVRw",
      "url": "https://www.youtube.com/watch?v=jNQXAC9IVRw"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": [],
    "mode": "live"
  }
}

Long arrays and strings are shortened for display; real responses are complete.

x-api-keystringheaderrequired

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

NameTypeDescriptionExample
url requiredstring
max 2,048 chars
YouTube video URL (watch, youtu.be, shorts, live, embed, m./music. hosts) or an 11-character video ID.https://www.youtube.com/watch?v=jNQXAC9IVRw
sort optionalstringOrder of the results. newest (default): newest first. popular: YouTube's Top comments ranking. Either way the video's pinned comment comes first.
One of newest, popular
—
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. Compared with published_at, which YouTube only shows as a relative label ("2 days ago"): the walk stops at the first comment whose label is older, so comments up to one label unit older can be included.2026-10-01
until optionalstring
date-time
Only items before this time (exclusive): RFC 3339 or a date (midnight UTC).2026-10-08
limit optionalinteger
min 1
max 20
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.20
cursor optionalstringpage.next_cursor from the previous response. Send the same other parameters; omit to start from the first page.—
urlstringrequiredmax 2,048 chars

YouTube video URL (watch, youtu.be, shorts, live, embed, m./music. hosts) or an 11-character video ID.

Examplehttps://www.youtube.com/watch?v=jNQXAC9IVRw

sortstring

Order of the results. newest (default): newest first. popular: YouTube's Top comments ranking. Either way the video's pinned comment comes first.

One ofnewestpopular

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. Compared with published_at, which YouTube only shows as a relative label ("2 days ago"): the walk stops at the first comment whose label is older, so comments up to one label unit older can be included.

Example2026-10-01

untilstringdate-time

Only items before this time (exclusive): RFC 3339 or a date (midnight UTC).

Example2026-10-08

limitintegermin 1max 20

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.

Example20

cursorstring

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

url takes YouTube video 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 20 comment objects, newest first; page says how to get the next page; meta describes the request (meta). The fields are the shared comment schema, the same on every platform.

FieldTypeDescription
data[].platformstringPlatform ID (tiktok, youtube, …).
data[].idstringPlatform-native comment ID (string; Reddit without t1_).
data[].post_idstringID of the post commented on (equals post.id).
data[].parent_idstring or nullID of the comment this replies to; null for top-level comments.
data[].urlstring (uri) or nullPermalink, when the platform has one.
data[].textstringComment body as plain text.
data[].authorobjectThe commenting 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[].published_atstring (date-time) or nullWhen the comment was posted, RFC 3339 UTC. Where the platform shows only a relative time ("3 weeks ago"), the latest time that label allows (the fetch time minus the stated amount), listed in approximate_fields.
data[].edited_atstring (date-time) or nullWhen the comment was last edited, RFC 3339 UTC; null when never edited or when the platform marks edits without a time (see is_edited).
data[].is_editedboolean or nullThe comment was edited after posting (the platform's edited mark); null when the platform does not say.
data[].is_pinnedboolean or nullPinned by the post's author.
data[].is_liked_by_authorboolean or nullLiked or hearted by the post's author.
data[].is_by_post_authorboolean or nullWritten by the post's author (the creator's own comment, marked as such by the platform).
data[].metricsobjectCounts at fetch time; null = hidden or not exposed, 0 = zero.
data[].metrics.like_countinteger or nullLikes or upvotes; never negative.
data[].metrics.reply_countinteger or nullDirect replies.
data[].platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
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 comment ID (string; Reddit without t1_).

post_idstring

ID of the post commented on (equals post.id).

parent_idstringnullable

ID of the comment this replies to; null for top-level comments.

urlstring urinullable

Permalink, when the platform has one.

textstring

Comment body as plain text.

authorobject

The commenting 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.

published_atstring date-timenullable

When the comment was posted, RFC 3339 UTC. Where the platform shows only a relative time ("3 weeks ago"), the latest time that label allows (the fetch time minus the stated amount), listed in approximate_fields.

edited_atstring date-timenullable

When the comment was last edited, RFC 3339 UTC; null when never edited or when the platform marks edits without a time (see is_edited).

is_editedbooleannullable

The comment was edited after posting (the platform's edited mark); null when the platform does not say.

is_pinnedbooleannullable

Pinned by the post's author.

is_liked_by_authorbooleannullable

Liked or hearted by the post's author.

is_by_post_authorbooleannullable

Written by the post's author (the creator's own comment, marked as such by the platform).

metricsobject

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

ShowHide 2 child fields
like_countintegernullable

Likes or upvotes; never negative.

reply_countintegernullable

Direct replies.

platform_specificobject

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

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=popular: YouTube's Top comments ranking
Page size
Up to 20 comments (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/comments' \
  --data-urlencode 'sort=newest' \
  --data-urlencode 'url=jNQXAC9IVRw' \
  --data-urlencode 'cursor=c1.EXAMPLE_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 20 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.

SourcePrice per successful pagePer 1,000 pages
Platform API api1 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.

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.

12 recorded inputs and magic inputs
InputAnswer
HtVdAasjOgU
with sort=popular
200 OK
XqZsoesa55w
with sort=newest
403 private_or_unavailable
qUTSzYEtUG0
with sort=newest
200 OK
jNQXAC9IVRw
with sort=newest Default
200 OK
dQw4w9WgXcQ
with since=2026-10-01T00:00:00Z sort=newest
200 OK
kJQP7kiw5Fk
with sort=popular
200 OK
Q39EVAstoRM
with sort=newest
404 not_found
yZIXLfi8CZQ
with sort=newest
403 private_or_unavailable
3cWm9B_0_kI
with sort=newest
200 OK
jNQXAC9IVRw
with sort=popular
200 OK
dQw4w9WgXcQ
with sort=popular
200 OK
E_HgDSKu_50
with sort=newest
200 OK

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

ErrorValue
invalid_inputhttps://socialtap.dev/test/invalid_input
invalid_cursorhttps://socialtap.dev/test/invalid_cursor
insufficient_creditshttps://socialtap.dev/test/insufficient_credits
spend_limit_reachedhttps://socialtap.dev/test/spend_limit_reached
rate_limitedhttps://socialtap.dev/test/rate_limited
not_foundhttps://socialtap.dev/test/not_found
private_or_unavailablehttps://socialtap.dev/test/private_or_unavailable
upstream_blockedhttps://socialtap.dev/test/upstream_blocked
upstream_errorhttps://socialtap.dev/test/upstream_error
overloadedhttps://socialtap.dev/test/overloaded
internalhttps://socialtap.dev/test/internal

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

Last updated