/v1/pinterest/pin

GET

Get Pinterest pin

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	Use a cached response this old or newer for 0 credits. If none is available, fetch live at the endpoint’s normal price.
Pagination	No explicit pagination metadata in the published contract. Consult the parameters and response fields below.

Parameters

Name	Location / required	Schema
`url` Pinterest pin URL	query / required	`string`
`trim` Set true for a trimmed response.	query / optional	`boolean`
`cache_max_age` Use a cached response this old or newer for 0 credits. If none is available, fetch live at the endpoint’s normal price.	query / optional	`string` Allowed values `["1d","3d","7d","14d","30d"]`

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/pin?url=YOUR_URL' \
  --header 'x-api-key: YOUR_API_KEY'

JavaScript

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

altTextoptional

null

autoAltTextoptional

string

closeupUnifiedDescriptionoptional

string

descriptionrequired

string

descriptionHtmloptional

string

dominantColoroptional

string

originPinnerrequired

object

entityIdrequired

string

idrequired

string

usernamerequired

string

imageMediumUrlrequired

string

blockedByMerequired

boolean

explicitlyFollowedByMerequired

boolean

followerCountrequired

integer

fullNamerequired

string

imageLargeUrlrequired

string

imageSmallUrlrequired

string

isVerifiedMerchantrequired

boolean

verifiedIdentityrequired

object

verifiedrequired

null

embedoptional

null

gridTitleoptional

string

imageSignatureoptional

string

isGoLinklessoptional

boolean

digitalMediaSourceTypeoptional

null

linkoptional

string

mobileLinkoptional

null

pinnerrequired

object

blockedByMerequired

boolean

idrequired

string

entityIdrequired

string

__typenamerequired

string

fullNamerequired

string

imageSmallUrlrequired

string

imageLargeUrlrequired

string

isVerifiedMerchantrequired

boolean

verifiedIdentityrequired

object

verifiedrequired

null

usernamerequired

string

imageMediumUrlrequired

string

explicitlyFollowedByMerequired

boolean

firstNamerequired

string

followerCountrequired

integer

pinJoinoptional

object

visualAnnotationrequired

array

Array items

string

shoppingKlpUrlsrequired

array

Array items

string

annotationsWithLinksArrayrequired

array

Array items

object

namerequired

string

urlrequired

string

seoCanonicalDomainrequired

string

seoCanonicalUrlrequired

string

titleoptional

string

trackedLinkoptional

string

trackingParamsoptional

string

isViewedByOwnerOrEmployeeOrPartnerOfBusinessoptional

null

videosoptional

null

imageSpec_236xoptional

object

heightrequired

integer

widthrequired

integer

urlrequired

string

imageSpec_136x136optional

object

heightrequired

integer

widthrequired

integer

urlrequired

string

imageSpec_60x60optional

object

urlrequired

string

imageSpec_170xoptional

object

urlrequired

string

imageSpec_474xoptional

object

urlrequired

string

heightrequired

integer

widthrequired

integer

imageSpec_564xoptional

object

urlrequired

string

heightrequired

integer

widthrequired

integer

imageSpec_736xoptional

object

urlrequired

string

heightrequired

integer

widthrequired

integer

imageSpec_600x315optional

object

urlrequired

string

imageSpec_origrequired

object

urlrequired

string

heightoptional

integer

widthoptional

integer

entityIdrequired

string

isDownstreamPromotionoptional

boolean

categoryoptional

string

domainoptional

string

isPromotedoptional

boolean

linkDomainoptional

object

officialUserrequired

object

imageMediumUrlrequired

string

idrequired

string

entityIdrequired

string

fullNamerequired

string

imageSmallUrlrequired

string

isPrimaryWebsiteVerifiedrequired

boolean

usernamerequired

string

blockedByMerequired

boolean

explicitlyFollowedByMerequired

boolean

followerCountrequired

integer

imageLargeUrlrequired

string

isVerifiedMerchantrequired

boolean

verifiedIdentityrequired

object

verifiedrequired

null

idrequired

string

promoteroptional

null

isEligibleForPdpoptional

boolean

isOosProductoptional

boolean

isStaleProductoptional

boolean

shoppingFlagsoptional

array

aggregatedPinDataoptional

object

entityIdrequired

string

idrequired

string

aggregatedStatsrequired

object

savesrequired

integer

commentCountrequired

integer

didItDatarequired

object

imagesCountrequired

integer

isEligibleForAggregatedCommentsoptional

boolean

richMetadataoptional

object

reciperequired

object

namerequired

string

fromAggregatedDatarequired

boolean

categorizedIngredientsrequired

array

Array items

object

__typenamerequired

string

categoryrequired

string

ingredientsrequired

array

Array items

object

amtrequired

string

namerequired

string

displayCookTimerequired

integer

servingsSummaryrequired

object

__typenamerequired

string

servesrequired

string

summaryrequired

string

aggregateRatingrequired

null

dietsrequired

array

Array items

string

cookTimesrequired

object

totalrequired

object

hrequired

integer

mrequired

integer

cookrequired

object

hrequired

integer

mrequired

integer

preprequired

object

hrequired

null

mrequired

integer

articlerequired

object

__typenamerequired

string

datePublishedrequired

string

descriptionrequired

string

titlerequired

string

productsrequired

null

aggregateRatingrequired

null

tutorialrequired

null

siteNamerequired

string

urlrequired

string

totalReactionCountrequired

integer

boardoptional

object

privacyrequired

string

urlrequired

string

namerequired

string

idrequired

string

entityIdrequired

string

pinCountrequired

integer

sectionCountrequired

integer

boardOrderModifiedAtrequired

string

coverImageSpec_222xrequired

object

urlrequired

string

coverImageSpec_400x300required

object

urlrequired

string

coverImageSpec_216x146required

object

urlrequired

string

imageCoverHdUrlrequired

string

imageCoverUrlrequired

string

imageThumbnailUrlrequired

string

collaboratedByMerequired

boolean

isCollaborativerequired

boolean

ownerrequired

object

entityIdrequired

string

idrequired

string

richSummaryoptional

object

displayNamerequired

string

productsrequired

array

storyPinDataIdoptional

null

storyPinDataoptional

null

nativeCreatorrequired

object

isVerifiedMerchantrequired

boolean

verifiedIdentityrequired

object

verifiedrequired

null

idrequired

string

entityIdrequired

string

fullNamerequired

string

imageMediumUrlrequired

string

imageSmallUrlrequired

string

usernamerequired

string

blockedByMerequired

boolean

explicitlyFollowedByMerequired

boolean

followerCountrequired

integer

imageLargeUrlrequired

string

profileUrlrequired

string

shareCountrequired

integer

reactionCountsDataoptional

array

Array items

object

reactionCountrequired

integer

reactionTyperequired

integer

sponsorshipoptional

null

closeupDescriptionoptional

string

genAiTopicsoptional

null

recommendationReasonoptional

null

seeMoreUserFeedbackoptional

null

adDataoptional

null

adMatchReasonoptional

integer

sourceInterestoptional

null

adTargetingAttributionoptional

null

promotedPartnershipAdvertiserNameoptional

null

promotedPartnershipAttributionNameoptional

null

isEligibleForPromotedPartnershipoptional

boolean

isThirdPartyAdoptional

boolean

commentsDisabledoptional

boolean

doneByMeoptional

boolean

closeupAttributionoptional

object

entityIdrequired

string

usernamerequired

string

idrequired

string

__typenamerequired

string

imageMediumUrlrequired

string

followerCountrequired

integer

followedByMerequired

boolean

isAdsOnlyProfilerequired

boolean

adsOnlyProfileSiterequired

null

verifiedIdentityrequired

object

verifiedrequired

null

isVerifiedMerchantrequired

boolean

fullNamerequired

string

isHiddenoptional

boolean

isUnsafeoptional

boolean

carouselDataoptional

null

image236xoptional

object

heightrequired

integer

urlrequired

string

widthrequired

integer

image474xoptional

object

heightrequired

integer

urlrequired

string

widthrequired

integer

image564xoptional

object

heightrequired

integer

urlrequired

string

widthrequired

integer

image736xoptional

object

heightrequired

integer

urlrequired

string

widthrequired

integer

visualObjectsoptional

array

Array items

object

isStelarequired

boolean

hrequired

number

wrequired

integer

xrequired

integer

yrequired

number

labelrequired

string

affiliateLinkoptional

null

shipsToUserCountryoptional

boolean

relatedArticleoptional

object

_idrequired

null

mainImageUrlrequired

null

titlerequired

null

urlPathrequired

null

isRepinoptional

boolean

favoriteUserCountoptional

integer

favoritedByMeoptional

boolean

createdAtrequired

string

attributionoptional

null

mediaAttributionoptional

null

seoDescriptionoptional

string

seoNoindexReasonoptional

null

seoTitleoptional

string

repinCountrequired

integer

seoUrloptional

string

priceCurrencyoptional

string

idoptional

string

seoAltTextoptional

string

cachedoptional

boolean

cached_atoptional

string

{
  "format": "date-time"
}

401Invalid or missing x-api-key

402No credits remaining

403Upstream denied (age gate, audience controls)

404Resource or endpoint not found

429Rate limited