/v1/pinterest/board

GET

Board

Get pins from a Pinterest board. With trim=true, native save counts and keyword labels are retained when available.

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
`url` The URL of the board to get	query / required	`string`
`trim` Set true for a trimmed response.	query / optional	`boolean`
`cursor` The cursor to get the next page of results	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/board?url=YOUR_URL' \
  --header 'x-api-key: YOUR_API_KEY'

JavaScript

const response = await fetch("https://api.fetchproof.com/v1/pinterest/board?url=YOUR_URL", {
  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/board?url=YOUR_URL",
    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

is_stale_productoptional

boolean

image_signatureoptional

string

is_eligible_for_related_productsoptional

boolean

descriptionrequired

string

imagesoptional

object

origrequired

object

widthrequired

integer

heightrequired

integer

urlrequired

string

promoted_is_removableoptional

boolean

is_promotedoptional

boolean

promoteroptional

null

idrequired

string

pin_joinoptional

object

shopping_klp_urlsrequired

null

canonical_pinrequired

object

idrequired

string

visual_annotationrequired

array

Array items

string

annotations_with_linksrequired

object

Easter Brunch Outfitrequired

object

urlrequired

string

namerequired

string

favorited_by_meoptional

boolean

is_repinoptional

boolean

boardrequired

object

node_idrequired

string

typerequired

string

ownerrequired

object

node_idrequired

string

is_primary_website_verifiedrequired

boolean

verified_identityrequired

object

image_small_urlrequired

string

image_medium_urlrequired

string

usernamerequired

string

full_namerequired

string

idrequired

string

is_verified_merchantrequired

boolean

collaborated_by_merequired

boolean

privacyrequired

string

is_collaborativerequired

boolean

urlrequired

string

idrequired

string

followed_by_merequired

boolean

layoutrequired

string

namerequired

string

shopping_flagsoptional

array

creator_analyticsoptional

null

titlerequired

string

call_to_action_textoptional

null

grid_titleoptional

string

rich_summaryrequired

object

actionsrequired

array

productsrequired

array

apple_touch_icon_linkrequired

null

type_namerequired

string

typerequired

string

idrequired

string

favicon_linkrequired

string

urlrequired

string

display_namerequired

string

favicon_imagesrequired

object

origrequired

string

display_descriptionrequired

string

apple_touch_icon_imagesrequired

null

site_namerequired

string

image_cropoptional

object

min_yrequired

integer

max_yrequired

integer

typeoptional

string

sponsorshipoptional

null

story_pin_data_idoptional

null

insertion_idoptional

null

collection_pinoptional

null

should_open_in_streamoptional

boolean

campaign_idoptional

null

accessoptional

array

debug_info_htmloptional

null

utm_linkoptional

null

reaction_countsrequired

object

embedoptional

null

unified_user_noterequired

string

auto_alt_textoptional

null

product_pin_dataoptional

null

videosoptional

null

aggregated_pin_dataoptional

object

node_idrequired

string

is_shop_the_lookrequired

boolean

has_xy_tagsrequired

boolean

aggregated_statsrequired

object

savesrequired

integer

donerequired

integer

idrequired

string

did_it_datarequired

object

typerequired

string

videos_countrequired

integer

user_countrequired

integer

recommend_scoresrequired

array

Array items

object

scorerequired

schema

anyOf

schema

anyOf

integer

anyOf

number

anyOf

integer

countrequired

integer

tagsrequired

array

images_countrequired

integer

responses_countrequired

integer

ratingrequired

integer

details_countrequired

integer

recommended_countrequired

integer

creator_analyticsrequired

null

link_domainoptional

null

is_go_linklessoptional

boolean

categoryoptional

string

tracking_paramsoptional

string

product_metadataoptional

null

is_downstream_promotionoptional

boolean

seo_alt_textoptional

string

video_status_messageoptional

null

is_eligible_for_pdpoptional

boolean

story_pin_dataoptional

null

promoted_lead_formoptional

null

native_creatoroptional

object

node_idrequired

string

is_primary_website_verifiedrequired

boolean

verified_identityrequired

object

image_small_urlrequired

string

image_medium_urlrequired

string

usernamerequired

string

full_namerequired

string

idrequired

string

is_verified_merchantrequired

boolean

is_oos_productoptional

boolean

alt_textrequired

string

promoted_is_lead_adoptional

boolean

is_nativeoptional

boolean

link_utm_applicable_and_replacedoptional

integer

domainrequired

string

digital_media_source_typeoptional

null

carousel_dataoptional

null

repin_countoptional

integer

done_by_meoptional

boolean

pinnerrequired

object

node_idrequired

string

is_primary_website_verifiedrequired

boolean

verified_identityrequired

object

image_small_urlrequired

string

image_medium_urlrequired

string

usernamerequired

string

full_namerequired

string

idrequired

string

is_verified_merchantrequired

boolean

video_statusoptional

null

is_quick_promotableoptional

boolean

favorite_user_countoptional

integer

is_shoppableoptional

boolean

linkrequired

string

dominant_coloroptional

string

attributionoptional

null

has_required_attribution_provideroptional

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