API reference
Pinterest Pin Search API
Search Pinterest pins by keyword: title, description, image and author. Paged by cursor.
Endpoint
/v1/pinterest/searchlive · proven2 creditsParameters
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.
| Name | Required | Description | Example |
|---|---|---|---|
query | yes | Search term. | living room decor |
cursor | no | Opaque cursor from the previous page. | — |
dry_run | no | Read 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 |
judgments | no | Add 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 |
label | no | Set 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_evidence | no | Include 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 |
exclude | no | Optionally 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 |
fit | no | Use 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 |
goal | no | Required 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 |
tokens | no | Optional 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 "https://www.monocrawl.com/v1/pinterest/search?query=living%20room%20decor" \ -H "x-api-key: mn_your_key_here"
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
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.
{
"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 data | Type | Meaning |
|---|---|---|
cursor | string | null | Opaque next-page token; pass it back unchanged. Null does not prove complete history. |
dropped | number | null | Optional dropped supplied by this operation. Null means unknown. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].alt_text | string | null | Optional alt text supplied by this operation. Null means unknown. |
items[].author | object | null | Public author information supplied with this record. |
items[].author.followers | number | null | Optional followers supplied by this operation. Null means unknown. |
items[].author.handle | string | null | Optional handle supplied by this operation. Null means unknown. |
items[].author.id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].author.name | string | null | Optional name supplied by this operation. Null means unknown. |
items[].board | string | null | Optional board supplied by this operation. Null means unknown. |
items[].created_at | string | null | Source creation time, not the API retrieval time. |
items[].description | string | null | Source description; null or absent means not supplied. |
items[].domain | string | null | Optional domain supplied by this operation. Null means unknown. |
items[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].image | string | null | Optional image supplied by this operation. Null means unknown. |
items[].is_promoted | boolean | null | Optional is promoted supplied by this operation. Null means unknown. |
items[].platform | string | null | Optional platform supplied by this operation. Null means unknown. |
items[].title | string | null | Source title when supplied. |
items[].url | string | null | Original 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