Reddit Posts API examples for SocQ

Collect public Reddit posts from supported post URLs, returning titles, text, authors, community context, media, timestamps, and visible engagement in normalized records.

Try Reddit Posts API · Get an API key · Documentation · All SocQ examples

Use cases

• Source-backed post review: Retain post IDs, URLs, titles, body text, and author fields so reviewers can revisit the exact public submissions included in an analysis.
• Cross-community topic comparison: Group titles and body text by community_name and tag to examine how a defined topic is framed across selected subreddits.
• Time-stamped engagement tracking: Store upvotes_count, comments_count, and upvote_ratio with collected_at to compare repeated snapshots without treating the values as permanent.
• Create source-linked content archives: Preserve canonical post URLs, community context, author fields, media, timestamps, and collection-time metrics for selected public submissions.

API behavior

• Submit public Reddit post URLs using /r/{subreddit}/comments/{post_id} paths or supported redd.it short links.
• The endpoint resolves only submitted post URLs and does not discover subreddit or search results.
• It does not accept results_limit, and post records do not include individual comment text.
• Author, media, flair, community, timestamp, and engagement fields are optional public values.

All requests use the shared asynchronous flow:

submit -> task_id -> poll task -> read every cursor page -> save results

Quick start

cp .env.example .env
export SOCQ_API_KEY="your-api-key"

Run the complete Node.js workflow:

cd node
npm start

Run the complete Python workflow:

python3 -m pip install -r python/requirements.txt
python3 python/main.py

Both examples load payload.example.json, retry transient API responses, wait for task completion, read every cursor page, and save an enriched public Reddit post dataset with community and engagement context to output/results.json.

Never expose SOCQ_API_KEY in browser code, mobile apps, public repositories, screenshots, fixtures, or logs.

Request

POST https://api.socq.ai/v1/reddit/posts
Authorization: Bearer <SOCQ_API_KEY>
Content-Type: application/json

{
  "urls": [
    "https://www.reddit.com/r/example/comments/abc123/example_post/"
  ]
}

The submit response contains data.task_id. Poll the task endpoint until data.status becomes succeeded or failed, then continue with data.results.next_cursor while data.results.has_more is true.

Complete workflow example

The Node.js and Python programs implement the production-shaped happy path:

1. Load and validate configuration.
2. Submit the endpoint-specific payload.
3. Retry rate-pressure and transient server responses with bounded backoff.
4. Poll the asynchronous task with a ten-minute application timeout.
5. Stop cleanly on a failed task and surface the public error message.
6. Read all cursor pages instead of silently returning only the first page.
7. Write a stable JSON artifact containing task metadata and normalized records.

Use the synthetic files in fixtures/ for tests and documentation. They do not contain customer, account, or production data.

Production notes

See docs/production-notes.md for validation, retry, timeout, pagination, deduplication, logging, and endpoint-specific guidance.

Responsible use and platform scope

• Use only publicly accessible Reddit posts, comments, subreddits, search results, and fields supported by the selected endpoint.
• Do not use the examples to access private communities, restricted content, deleted content, login-only surfaces, or authentication controls.
• SocQ is not an official API of the represented social platform and is not affiliated with or endorsed by that platform.
• Before production use, assess the laws, platform terms, privacy obligations, and retention requirements that apply to your organization and use case.
• Collect only the fields needed for a defined purpose, restrict access, set retention periods, and support correction or deletion workflows where required.
• Platform names and trademarks belong to their respective owners.

This section describes the public-data boundary; it is not legal advice or a guarantee that every use case is permitted in every jurisdiction.

Repository contents

Path	Purpose
curl/request.md	Copy-paste submit, poll, and pagination requests
node/index.mjs	Complete Node.js workflow
python/main.py	Complete Python workflow
payload.example.json	Safe endpoint-specific request body
fixtures/	Synthetic submit and task response shapes
docs/production-notes.md	Production integration guidance