Skip to content

README.md

Latest commit

 

History

History
125 lines (93 loc) · 5.73 KB

README.md

File metadata and controls

125 lines (93 loc) · 5.73 KB
Raw

Threads Posts API examples for SocQ

Threads Posts API API documentation License: MIT Check examples

Collect public Threads posts from supported post URLs, returning text, author identity, media, publication time, and visible engagement in normalized records.

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

Use cases

  • Enrich a selected post list: Convert known post URLs into records with IDs, text, author fields, media, timestamps, and source links for a defined dataset.
  • Review public content and attribution: Use text, media references, author identity, and the original URL to examine selected publications while retaining their public source.
  • Compare engagement snapshots: Pair likes_count, comments_count, reposts_count, and shares_count with collected_at to compare observations captured at different times.
  • Create source-linked post archives: Retain canonical URLs, text, author context, public media, timestamps, and collection-time metrics for selected posts.

API behavior

  • Submit public threads.com or threads.net post URLs using the /@username/post/{post_id} path.
  • This endpoint resolves selected posts and does not support results_limit, profile-feed expansion, or reply expansion.
  • Text, author details, media, publication time, and engagement fields can be absent when not publicly available.
  • Visible likes, comments, reposts, and shares are point-in-time observations and do not include individual reply records.

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 Threads post dataset with author, media, and engagement snapshots 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/threads/posts
Authorization: Bearer <SOCQ_API_KEY>
Content-Type: application/json
{
  "urls": [
    "https://www.threads.com/@example/post/POST_ID"
  ]
}

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 Threads profiles, posts, profile feeds, and fields supported by the selected endpoint.
  • Do not use the examples to access private accounts, restricted content, deleted posts, 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