Pinterest User Pins API examples for SocQ

Discover public Pinterest Pins from one or more profile URLs, returning Pin identity, text, author details, media, visible engagement, and source context as normalized records.

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

Use cases

• Public profile Pin archiving: Preserve Pin IDs, source URLs, titles, text, author fields, media references, timestamps, and discovery_input for defined profile URLs.
• Visual and taxonomy research: Use media type, post_type, categories, hashtags, titles, and text to examine recurring formats and themes within selected public profiles.
• Cross-profile signal comparison: Compare visible like and comment counts with creator follower context across profile collections, using collected_at to anchor each observation.
• Maintain recurring profile snapshots: Run the same profile URLs over time, deduplicate by Pin ID, and compare public content and visible metrics at each collection time.

API behavior

• Submit one or more public Pinterest profile URLs with exactly one non-reserved path segment.
• results_limit defaults to 100, accepts integers from 1 through 2,000, and applies separately to each profile URL.
• Results are public Pins discovered from the profile URL; they are not profile records and do not provide a stable created-versus-saved classification.
• Board URLs and board filters are not supported by this endpoint.

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 a paginated public Pinterest Pin dataset discovered from selected profile URLs 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/user-pins
Authorization: Bearer <SOCQ_API_KEY>
Content-Type: application/json

{
  "urls": [
    "https://www.pinterest.com/example/"
  ],
  "results_limit": 100
}

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