Pinterest Search
Search Pinterest pins by keyword and get titles, images, pinner and destination links, with cursor pagination.
- Price per call
- 2 credits
- per successful call
- Price ceiling
- 36 credits
- if a call is retried elsewhere
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ pinterest. searchAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/pinterest.search with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/pinterest.search" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"home decor","limit":10}'const res = await fetch('https://api.primaryapi.com/v1/run/pinterest.search', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
query: 'home decor',
limit: 10,
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/pinterest.search",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"query": "home decor",
"limit": 10,
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "pinterest.search",
"input": {
"query": "home decor",
"limit": 10
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/pinterest.search" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"home decor","limit":10}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
querystringrequired- Keyword, topic or brand to search Pinterest for (e.g. "mid-century living room").max 500 chars
typeenumdefault"all-pins"- Result type. Only "all-pins" is served today (videos, boards and profiles have no reliable source yet).one of: all-pins
limitintegerdefault20- Pins per page (1-20, default 20). A page cut short by limit continues exactly via nextCursor.1–20
cursorstring- Opaque pagination cursor: pass the previous response's nextCursor.
Output
When output.found is true, output.data has these fields (a list under items, billed per item returned).
itemsobject[]items[].idstring- Pin id
items[].titlestring | nullitems[].descriptionstring | nullitems[].imagestring | null- Largest image URL available
items[].urlstring | null- Pin URL
items[].videoUrlstring | null- Video URL for video pins (only some sources expose it)
items[].authorstring | null- Pinner username
items[].authorNamestring | null- Pinner display name
items[].linkstring | null- Outbound destination link of the pin
items[].createdAtstring | null- ISO-8601 creation time
nextCursorstring | null
TypeScript type
/** output.data when output.found is true */
type PinterestSearch = {
items: {
/** Pin id */
id: string;
title: string | null;
description: string | null;
/** Largest image URL available */
image: string | null;
/** Pin URL */
url: string | null;
/** Video URL for video pins (only some sources expose it) */
videoUrl: string | null;
/** Pinner username */
author: string | null;
/** Pinner display name */
authorName: string | null;
/** Outbound destination link of the pin */
link: string | null;
/** ISO-8601 creation time */
createdAt: string | null;
}[];
nextCursor: string | null;
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Pagination. Pass the previous response’s nextCursor as cursor to get the next page. nextCursor: null means there is nothing more. See Pagination.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"items": [
{
"id": "string",
"title": "string",
"description": "string",
"image": "string",
"url": "https://example.com",
"videoUrl": "https://example.com",
"author": "string",
"authorName": "string",
"link": "string",
"createdAt": "string"
}
],
"nextCursor": null
}
},
"provider": "PrimaryAPI",
"credits": 2,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
"nextCursor": null
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
Notes
Cursors are pinned to the source that issued them. Pin images are third-party content: URLs only.
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/pinterest.search.