API reference

Pinterest Pin Search API

Search Pinterest pins by keyword: title, description, image and author. Paged by cursor.

Endpoint

GET/v1/pinterest/searchlive · proven2 credits
Try in Playground

Parameters

Query parameters

Useful optional inputs

  • fit — Use fit=goal with a task description to replace confidently irrelevant records with recall stubs and reduce agent context.

    No fit surcharge; full evidence is retained for 24 hours when stored, and the response size target is soft.

  • cursor — Continue the same source traversal with the complete returned cursor.

    Saved-result retrieval and a new source page can have different prices; quote the next call.

  • dry_run — Read a free estimate before fetching sources or scheduling paid work.

    Zero credits; cache status and availability are snapshots rather than guarantees.

NameRequiredDescriptionExample
queryyesSearch term.living room decor
cursornoOpaque cursor from the previous page.—
dry_runnoRead a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable.1
judgmentsnoAdd bounded AI labels to eligible returned records (default on). off preserves the original data shape. Unclassified records remain present; labels depend on evidence, time, capacity and the existing request budget. No label surcharge. Accepted values: on, off. Case, spaces, hyphens and underscores are interchangeable.on
labelnoSet none to disable labels; default enables the endpoint’s label set. Equivalent to judgments=off. Accepted values: default, none. Case, spaces, hyphens and underscores are interchangeable.none
label_evidencenoInclude exact supporting sentences and zero-based sentence indexes when a label has validated evidence. No extra charge or change to decisions. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable.1
excludenoOptionally remove confidently labelled engagement bait. Uncertain and unclassified records stay; removed IDs and an owner-bound recall reference are returned. Accepted values: engagement_bait. Case, spaces, hyphens and underscores are interchangeable.engagement_bait
fitnoUse goal to replace confidently irrelevant records with recall stubs. Keeps first, last, relevant and uncertain records; preserves order. Full evidence is stored for 24 hours when available. Accepted values: goal. Case, spaces, hyphens and underscores are interchangeable.goal
goalnoRequired with fit=goal: describe the task in at most 600 characters. Supplied text is task context, never permission to act on posts.Find concrete product complaints
tokensnoOptional soft response target for fit=goal, 256–32000. Safety and evidence retention take priority, so the returned result may exceed it.4000

Examples

Make the request

curl
curl "https://www.monocrawl.com/v1/pinterest/search?query=living%20room%20decor" \
  -H "x-api-key: mn_your_key_here"
TypeScript
typescript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/pinterest/search?query=living%20room%20decor",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);
Python
python
import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/pinterest/search?query=living%20room%20decor",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json
{
  "success": true,
  "platform": "pinterest",
  "endpoint": "/v1/pinterest/search",
  "data": {
    "cursor": null,
    "dropped": 0,
    "items": [
      {
        "alt_text": "example",
        "author": {
          "followers": 0,
          "handle": "example",
          "id": "example",
          "name": "example"
        },
        "board": "example",
        "created_at": "2026-09-01T12:00:00Z",
        "description": "example",
        "domain": "example",
        "id": "example",
        "image": "https://example.com/example",
        "is_promoted": false,
        "platform": "example",
        "title": "example",
        "url": "https://example.com/example"
      }
    ]
  },
  "credits_used": 2,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside dataTypeMeaning
cursorstring | nullOpaque next-page token; pass it back unchanged. Null does not prove complete history.
droppednumber | nullOptional dropped supplied by this operation. Null means unknown.
itemsarray | nullReturned records. Source coverage and completeness vary.
items[].alt_textstring | nullOptional alt text supplied by this operation. Null means unknown.
items[].authorobject | nullPublic author information supplied with this record.
items[].author.followersnumber | nullOptional followers supplied by this operation. Null means unknown.
items[].author.handlestring | nullOptional handle supplied by this operation. Null means unknown.
items[].author.idstring | nullSource identifier. Preserve the supplied type and exact value.
items[].author.namestring | nullOptional name supplied by this operation. Null means unknown.
items[].boardstring | nullOptional board supplied by this operation. Null means unknown.
items[].created_atstring | nullSource creation time, not the API retrieval time.
items[].descriptionstring | nullSource description; null or absent means not supplied.
items[].domainstring | nullOptional domain supplied by this operation. Null means unknown.
items[].idstring | nullSource identifier. Preserve the supplied type and exact value.
items[].imagestring | nullOptional image supplied by this operation. Null means unknown.
items[].is_promotedboolean | nullOptional is promoted supplied by this operation. Null means unknown.
items[].platformstring | nullOptional platform supplied by this operation. Null means unknown.
items[].titlestring | nullSource title when supplied.
items[].urlstring | nullOriginal source URL when supplied.

Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.

The example is invented and illustrates types only; zero and empty values are not claims about a real result.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

First call in under a minute

150 free credits and a ready-made key the moment you sign up. No card.