/v1/pinterest/search

GET

Search

Search Pinterest

Credit cost	Default: 1 credit How charges are determined Cost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns. A call that fails costs 0 credits. A result served from cache costs 0 credits. `default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins. A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true). A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute.
Cache support	Not specified in the published contract.
Pagination	No explicit pagination metadata in the published contract. Consult the parameters and response fields below.

Parameters

Name	Location / required	Schema
`query` Search query	query / required	`string`
`trim` Set true for a trimmed response.	query / optional	`boolean`
`cursor` Cursor	query / optional	`string`

Request examples

Replace placeholder values and supply your own API key. For operations with a request body, populate the body using the schema above.

cURL

curl --request GET 'https://api.fetchproof.com/v1/pinterest/search?query=YOUR_QUERY' \
  --header 'x-api-key: YOUR_API_KEY'

JavaScript

const response = await fetch("https://api.fetchproof.com/v1/pinterest/search?query=YOUR_QUERY", {
  method: 'GET',
  headers: { 'x-api-key': process.env.FETCHPROOF_API_KEY }
});
console.log(await response.text());

Python

import os
import requests

response = requests.get("https://api.fetchproof.com/v1/pinterest/search?query=YOUR_QUERY",
    headers={"x-api-key": os.environ["FETCHPROOF_API_KEY"]})
print(response.text)

Responses

200Success. Envelope: success / credits_remaining / credits_charged.

application/json

object

successrequired

boolean

credits_remainingrequired

integer

credits_chargedrequired

integer

pinsrequired

array

Array items

object

node_idoptional

string

urlrequired

string

auto_alt_textoptional

string

idrequired

string

is_promotedoptional

boolean

descriptionrequired

string

titleoptional

string

imagesrequired

object

origrequired

object

widthrequired

integer

heightrequired

integer

urlrequired

string

170xoptional

object

widthrequired

integer

heightrequired

integer

urlrequired

string

236xoptional

object

widthrequired

integer

heightrequired

integer

urlrequired

string

474xoptional

object

widthrequired

integer

heightrequired

integer

urlrequired

string

736xoptional

object

widthrequired

integer

heightrequired

integer

urlrequired

string

linkoptional

string

domainoptional

string

seo_alt_textoptional

string

boardoptional

object

node_idrequired

string

namerequired

string

cover_imagesrequired

object

222xoptional

object

urlrequired

string

widthrequired

integer

heightrequired

null

236xoptional

object

urlrequired

string

widthrequired

integer

ownerrequired

object

node_idrequired

string

verified_identityrequired

object

follower_countrequired

integer

full_namerequired

string

image_large_urlrequired

string

is_ads_only_profilerequired

boolean

idrequired

string

image_small_urlrequired

string

image_medium_urlrequired

string

ads_only_profile_siteoptional

string

is_primary_website_verifiedoptional

boolean

is_verified_merchantrequired

boolean

usernamerequired

string

idrequired

string

urlrequired

string

collaborating_usersrequired

array

imagesrequired

object

170xoptional

array

Array items

object

urlrequired

string

widthrequired

integer

heightrequired

integer

dominant_colorrequired

string

236xoptional

array

Array items

object

urlrequired

string

widthrequired

integer

heightrequired

integer

dominant_colorrequired

string

pin_countrequired

integer

is_collaborativerequired

boolean

section_countrequired

integer

board_order_modified_atrequired

string

typerequired

string

collaborator_countrequired

integer

image_cover_urloptional

string

pin_thumbnail_urlsoptional

array

Array items

string

image_cover_hd_urloptional

string

grid_titleoptional

string

native_creatoroptional

null

created_atrequired

string

pinnerrequired

object

node_idrequired

string

verified_identityrequired

object

follower_countrequired

integer

full_namerequired

string

image_large_urlrequired

string

is_ads_only_profilerequired

boolean

idrequired

string

image_small_urlrequired

string

image_medium_urlrequired

string

ads_only_profile_siteoptional

string

is_primary_website_verifiedoptional

boolean

is_verified_merchantrequired

boolean

usernamerequired

string

videosoptional

object

node_idrequired

string

video_listrequired

object

V_HLSV4required

object

urlrequired

string

widthrequired

integer

heightrequired

integer

durationrequired

integer

thumbnailrequired

string

V_HLSV3_MOBILErequired

object

urlrequired

string

widthrequired

integer

heightrequired

integer

durationrequired

integer

thumbnailrequired

string

idrequired

string

story_pin_dataoptional

object

node_idrequired

string

typerequired

string

page_countrequired

integer

total_video_durationrequired

integer

metadatarequired

object

compatible_versionrequired

string

is_compatiblerequired

boolean

pin_titlerequired

string

pin_image_signaturerequired

string

is_promotablerequired

boolean

canvas_aspect_ratiorequired

number

is_editablerequired

boolean

versionrequired

string

root_user_idrequired

string

root_pin_idrequired

string

idrequired

string

has_affiliate_productsrequired

boolean

pagesrequired

array

Array items

object

should_muterequired

boolean

typerequired

string

blocksrequired

array

Array items

object

block_typerequired

integer

typerequired

string

tracking_idrequired

string

block_stylerequired

object

widthrequired

integer

x_coordrequired

integer

rotationrequired

integer

y_coordrequired

integer

heightrequired

integer

corner_radiusrequired

integer

image_signaturerequired

string

textrequired

string

image_signature_adjustedrequired

string

idrequired

string

layoutrequired

integer

styleoptional

object

background_colorrequired

string

music_attributionsrequired

array

image_signaturerequired

string

static_page_countrequired

integer

has_product_pinsrequired

boolean

cursorrequired

string

401Invalid or missing x-api-key

402No credits remaining

403Upstream denied (age gate, audience controls)

404Resource or endpoint not found

429Rate limited