Reddit

Reddit Comments API

Returns the comments on a public Reddit post with their replies, in thread order and a page at a time, from the post's link or ID. Each has its text, author, posting and edit time, score (upvotes), depth and parent, awards, and whether it is by the post's author, pinned, a moderator's, collapsed or deleted. Sort by Reddit's own order, New, Old, Top, Controversial or Q&A. A comment's permalink returns that comment and its replies.

GET /v1/reddit/comments

Try it

Example

cURL
curl -G 'https://socialtap.dev/v1/reddit/comments' \
  --data-urlencode 'sort=relevance' \
  --data-urlencode 'url=https://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
TypeScript SDK
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.reddit.comments.list({ url: "https://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/", sort: "relevance" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
Node.js (fetch)
const params = new URLSearchParams({
  sort: "relevance",
  url: "https://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/",
});
const res = await fetch(`https://socialtap.dev/v1/reddit/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 (requests)
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/reddit/comments",
    params={"sort": "relevance", "url": "https://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/"},
    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 (net/http)
package main

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

func main() {
	q := url.Values{}
	q.Set("sort", "relevance")
	q.Set("url", "https://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/reddit/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' => 'relevance',
    'url' => 'https://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/',
]);
$ch = curl_init('https://socialtap.dev/v1/reddit/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://socialtap.dev/v1/reddit/comments")
uri.query = URI.encode_www_form('sort' => 'relevance', 'url' => 'https://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/')
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("relevance")
            + "&url=" + encode("https://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/");
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://socialtap.dev/v1/reddit/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("relevance"),
    "url=" + Uri.EscapeDataString("https://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/"));
var res = await http.GetAsync("https://socialtap.dev/v1/reddit/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://socialtap.dev/v1/reddit/comments")
        .query(&[("sort", "relevance"), ("url", "https://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/")])
        .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://www.redditstatic.com/avatars/defaults/v2/avatar_default_3.png",
        "display_name": null,
        "id": "t2_60d4r",
        "is_verified": null,
        "url": "https://www.reddit.com/user/gobearss/",
        "username": "gobearss"
      },
      "edited_at": null,
      "id": "t1_c60mmaf",
      "is_by_post_author": false,
      "is_edited": false,
      "is_liked_by_author": null,
      "is_pinned": false,
      "metrics": {
        "like_count": 1556,
        "reply_count": null
      },
      "parent_id": null,
      "platform": "reddit",
      "platform_specific": {
        "reddit": {
          "award_count": null,
          "depth": 0,
          "distinguished": null,
          "is_collapsed": false,
          "is_deleted": false,
          "more_replies_count": 8,
          "post": null,
          "reply_to_author": null,
          "score": 1556,
          "subreddit": {
            "id": "t5_2qzb6",
            "name": "IAmA",
            "url": "https://www.reddit.com/r/IAmA/"
          }
        }
      },
      "post_id": "t3_z1c9z",
      "published_at": "2012-08-29T20:05:19Z",
      "text": "How do you balance family life and hobbies with, well, being the POTUS?",
      "unknown_fields": [],
      "url": "https://www.reddit.com/r/IAmA/comments/z1c9z/comment/c60mmaf/"
    },
    {
      "approximate_fields": [],
      "author": {
        "avatar_url": "https://www.redditstatic.com/avatars/defaults/v2/avatar_default_2.png",
        "display_name": null,
        "id": "t2_8t1cq",
        "is_verified": null,
        "url": "https://www.reddit.com/user/PresidentObama/",
        "username": "PresidentObama"
      },
      "edited_at": null,
      "id": "t1_c60nmtc",
      "is_by_post_author": true,
      "is_edited": false,
      "is_liked_by_author": null,
      "is_pinned": false,
      "metrics": {
        "like_count": 2951,
        "reply_count": null
      },
      "parent_id": "t1_c60mmaf",
      "platform": "reddit",
      "platform_specific": {
        "reddit": {
          "award_count": null,
          "depth": 1,
          "distinguished": null,
          "is_collapsed": false,
          "is_deleted": false,
          "more_replies_count": 285,
          "post": null,
          "reply_to_author": null,
          "score": 2951,
          "subreddit": {
            "id": "t5_2qzb6",
            "name": "IAmA",
            "url": "https://www.reddit.com/r/IAmA/"
          }
        }
      },
      "post_id": "t3_z1c9z",
      "published_at": "2012-08-29T21:04:58Z",
      "text": "It's hard - truthfully the main thing other than work is just making sure that I'm spending enough time with michelle and the girls. The big advantage I have is that I live above the store - so I have no commute! So we make sure that when I'm in DC I never miss dinner with them a…",
      "unknown_fields": [],
      "url": "https://www.reddit.com/r/IAmA/comments/z1c9z/comment/c60nmtc/"
    },
    {
      "approximate_fields": [],
      "author": {
        "avatar_url": null,
        "display_name": "[deleted]",
        "id": null,
        "is_verified": null,
        "url": null,
        "username": null
      },
      "edited_at": null,
      "id": "t1_c60npsu",
      "is_by_post_author": null,
      "is_edited": null,
      "is_liked_by_author": null,
      "is_pinned": false,
      "metrics": {
        "like_count": null,
        "reply_count": null
      },
      "parent_id": "t1_c60nmtc",
      "platform": "reddit",
      "platform_specific": {
        "reddit": {
          "award_count": null,
          "depth": 2,
          "distinguished": null,
          "is_collapsed": false,
          "is_deleted": true,
          "more_replies_count": 33,
          "post": null,
          "reply_to_author": null,
          "score": null,
          "subreddit": {
            "id": "t5_2qzb6",
            "name": "IAmA",
            "url": "https://www.reddit.com/r/IAmA/"
          }
        }
      },
      "post_id": "t3_z1c9z",
      "published_at": "2012-08-29T21:11:23Z",
      "text": "",
      "unknown_fields": [],
      "url": "https://www.reddit.com/comments/z1c9z/comment/c60npsu/"
    }
  ],
  "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": "reddit",
    "source": "page",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 667,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "post",
      "id": "t3_z1c9z",
      "url": "https://www.reddit.com/comments/z1c9z/"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}

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

x-api-keystringheaderrequired

Your API key. Authentication

urlstringrequiredmax 2,048 chars

Reddit post URL: a post's page on any reddit.com host (www, old, new, np, m, sh), with or without its subreddit or slug, a /gallery/ link, a redd.it short link, an app share link (/r/<subreddit>/s/<code>), a v.redd.it video link, or the post's ID (t3_ prefix optional). A comment's permalink (/comments/<id>/comment/<comment id>/) lists that comment and its replies instead of the whole post.

Examplehttps://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/

sortstring

Order of the results. relevance (default): Reddit's own order for the post, Best unless its moderators suggest another (many AMAs use Q&A). newest: New. oldest: Old. popular: Top. controversial: Controversial (the most evenly divided votes first). qa: Q&A (the comments the post's author answered first, with the answers). Each comment is followed by the replies Reddit shows under it.

One ofrelevancenewestoldestpopularcontroversialqa

repliesstring

all (default): a walk returns the whole tree, every reply Reddit left behind a "more replies" link included (on the pages after the one that shows its parent). shown: only the post's comments with the replies Reddit shows under them; each comment's platform_specific.reddit.more_replies_count counts the rest and its url lists them. A permalink's walk follows the same rule under its comment.

One ofallshown

Exampleshown

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. Comments come in thread order, not by time: since and until filter the comments of each page, and the walk goes on past them.

Example2026-10-01

untilstringdate-time

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

Example2026-10-08

limitintegermin 1max 200

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.

Example200

cursorstring

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

url takes Reddit post 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
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 200 comment objects, Reddit's own order for the post (Best, or the order its moderators suggest), each comment followed by the replies Reddit shows; page says how to get the next page; meta describes the request (meta). Fields only Reddit has are under platform_specific.reddit.

platformstring

Platform ID (tiktok, youtube, …).

idstring

Platform-native comment ID (string; Reddit with its t1_ prefix).

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. An account the platform no longer names (a deleted account) has a null id and username and the platform's label as display_name (Reddit: [deleted]).

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_countintegernullableReddit: upvotes (score)

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.

ShowHide 1 child field
redditobjectnullable

Reddit's own comment fields.

ShowHide 10 child fields
subredditobjectnullable

The subreddit of the post the comment is on; for a post on a user's profile, the profile's own subreddit (u_<username>).

ShowHide 3 child fields
idstringnullable

Reddit's subreddit ID (t5_…).

namestringnullable

The subreddit's name without r/.

urlstring urinullable

The subreddit's URL.

scoreintegernullable

Net score as Reddit shows it: upvotes minus downvotes, fuzzed by Reddit; negative for a comment most votes are against. Null when Reddit hides it (a subreddit that hides recent comments' scores, a deleted comment).

depthintegernullable

How deep in the post's thread the comment is: 0 for a comment on the post, 1 for a reply to one, and so on.

award_countintegernullable

Awards the comment received.

distinguishedstringnullable

The role the author spoke in, when they marked the comment with it: moderator or admin; null for an ordinary comment.

is_collapsedbooleannullable

Reddit shows the comment collapsed (a low score, a moderator's or crowd-control setting, or a subreddit's rule).

is_deletedbooleannullable

The comment's body was deleted by its author or removed by a moderator or Reddit; text is then empty. Reddit keeps such a comment in the thread when it has replies.

more_replies_countintegernullable

Replies under this comment (with their own replies) that the page leaves out, as Reddit counts them in its "N more replies" link: request the comment's url to page through them. 0 when every reply Reddit has is included.

reply_to_authorobjectnullable

The author of the comment this one replies to, where the list names them (a user's comments: Reddit's "replied to u/…"); null where Reddit does not name them (a comment on the post, a deleted parent account) and where parent_id places the comment in its thread.

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.

postobjectnullable

The post the comment is on, as Reddit shows it beside the comment (search results); null where the endpoint does not show it.

ShowHide 7 child fields
titlestringnullable

The post's title.

urlstring urinullable

The post's permalink.

scoreintegernullable

The post's net score as Reddit shows it (floored at 0 on display).

comment_countintegernullable

Comments on the post.

published_atstring date-timenullable

When the post was submitted, RFC 3339 UTC.

is_nsfwbooleannullable

The post is marked NSFW (18+).

is_spoilerbooleannullable

The post is marked as a spoiler.

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.

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

The cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it.

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

401

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

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

402

402 Payment Required: 2 error codes. Free: errors cost nothing.

The account does not have enough credits for this request.

Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically.

The API key reached its spend limit for this 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.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too 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, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.

Only public items can be fetched. Do not retry.

404

404 Not Found: 1 error code. Free: errors cost nothing.

not_foundNo retry

The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).

Check the link or ID. Do not retry.

429

429 Too Many Requests: 1 error code. Free: errors cost nothing.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

500

500 Internal Error: 1 error code. Free: errors cost nothing.

internalYes, later

An unexpected error on SocialTap's side.

Retry with backoff. If it keeps happening, contact support with the request_id.

502

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

upstream_errorYes, later

The platform failed, or answered with something we could not read.

Retry with backoff. Failed requests are free.

503

503 Unavailable: 2 error codes. Free: errors cost nothing.

The platform refused every attempt, our own retries included.

Retry later with backoff. Failed requests are free.

overloadedYes, later

SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged.

Retry after the seconds in the retry-after header. Failed requests are free.

Items come in pages, Reddit's own order for the post (Best, or the order its moderators suggest), each comment followed by the replies Reddit shows. 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=relevance (the default): Reddit's own order for the post (Best, or the order its moderators suggest), each comment followed by the replies Reddit shows; sort=controversial: Reddit's Controversial order of comments (most evenly divided votes first), each followed by the replies Reddit shows; sort=newest: Reddit's New order of comments (newest first), each followed by the replies Reddit shows; sort=oldest: Reddit's Old order of comments (oldest first), each followed by the replies Reddit shows; sort=popular: Reddit's Top order of comments (highest score first), each followed by the replies Reddit shows; sort=qa: Reddit's Q&A order (the comments the post's author answered first), each followed by the replies Reddit shows
Page size
Up to 200 post comments and replies (the default; limit lowers it)
Cursor lifetime
24 hours; don't store cursors
Price
Per page, 1 credit

The page object

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://socialtap.dev/v1/reddit/comments' \
  --data-urlencode 'sort=relevance' \
  --data-urlencode 'url=https://www.reddit.com/r/IAmA/comments/z1c9z/i_am_barack_obama_president_of_the_united_states/' \
  --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 200 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
Public page page1 credit$0.75–$1.97
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
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

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

Last updated