Pinterest Pins API examples for SocQ

Collect public Pinterest Pins from direct Pin URLs or pin.it links, returning content, creator details, media, timestamps, and visible metrics as normalized records.

Try Pinterest Pins API · Get an API key · Documentation · All SocQ examples

Use cases

• Selected Pin archiving: Preserve Pin IDs, source URLs, titles, text, creator fields, media references, and publication time for a defined URL list.
• Creative and topic review: Use media type, post_type, categories, hashtags, titles, and text to compare formats and themes across selected Pins.
• Collection-time signal comparison: Compare visible like and comment counts together with creator follower context, using collected_at to anchor each observation.
• Create source-linked Pin archives: Preserve Pin IDs, canonical URLs, public creator fields, media references, taxonomy, and collection-time metrics for selected Pins.

API behavior

• Submit one or more public Pinterest /pin/{id} URLs or supported pin.it links.
• The endpoint resolves only the submitted Pins and does not expand a creator profile into a feed.
• Media, categories, hashtags, publication time, and visible metrics are optional public fields.
• Visible engagement values are point-in-time observations captured at collected_at.

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 Pinterest Pin dataset with creator, media, taxonomy, 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/pinterest/pins
Authorization: Bearer <SOCQ_API_KEY>
Content-Type: application/json

{
  "urls": [
    "https://www.pinterest.com/pin/123456789/"
  ]
}

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 Pinterest profiles, Pins, search results, and fields supported by the selected endpoint.
• Do not use the examples to access private boards, restricted 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