Skip to content
Examples

Get Results

Retrieve scraped data from Pinterest Scraper

The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
GEThttps://api.lobstr.io/v1/results

Retrieve scraped data from your Pinterest Scraper runs.

Headers

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY.

Query Parameters

squidstringqueryrequired

Hash of the squid to get results from.

pageintegerquery

Page number (default: 1).

Result Fields

Export Pins

pin_idstring

Pinterest's unique identifier for the pin. Numeric for most pins, but some pins carry an encoded id such as e1_AfqPShzqO1C7_LEkrAbtoIWUe2MoGdDTj5vU32Lr9gXn25qs1FpIvg, so store it as text. Example: 37858453110553201

pin_urlstring

Direct link to the pin on Pinterest. Example: https://www.pinterest.com/pin/37858453110553201/

titlestring

Title of the pin. Frequently empty: most Pinterest pins carry only a description. Example: Bright Living Room with Windows and Window Sill

descriptiontext

Plain-text description (caption) of the pin.

description_htmltext

Description with Pinterest's own HTML markup (hashtag and mention links). Served on profile inputs, and on any pin when Full Pin Details is on.

alt_texttext

Alternative text of the pin image. Uses the text written by the pinner when there is one, otherwise the text Pinterest generated automatically.

created_atdatetime

Date and time (UTC) the pin was created. Not served by Pinterest on board inputs unless Full Pin Details is on. Example: 2023-06-07 12:38:53+00:00

is_videoboolean

True when the pin carries a video. Left blank (not False) on keyword-search rows: that surface only proves videos, it never says a pin has none — turn on Full Pin Details for a definitive answer on those rows.

video_urlstring

Playable video stream of the pin (HLS playlist, MP4 when Pinterest serves no playlist). Empty on image pins.

is_promotedboolean

True when the pin is a paid Pinterest ad.

is_repinboolean

True when the pin was saved from another pin rather than uploaded. Served on board and profile inputs, and on any pin when Full Pin Details is on.

domainstring

Domain the pin links to, or Uploaded by user for a direct upload. Example: potterybarn.com

destination_urlstring

Outbound link the pin points to.

save_countinteger

Number of times the underlying image was saved on Pinterest (the "saves" figure shown in the UI). Example: 3920

repin_countinteger

Number of times this exact pin was re-pinned. A different counter from save_count, which aggregates every copy of the image.

comment_countinteger

Number of comments on the pin. Served on profile inputs, and on any pin when Full Pin Details is on.

favorite_countinteger

Number of users who favourited the pin. Served on board inputs, and on any pin when Full Pin Details is on.

reaction_countinteger

Total number of reactions on the pin. Pinterest currently ships a single reaction type.

dominant_colorstring

Dominant colour of the pin image, as computed by Pinterest. Example: #8e4a2c

image_urlstring

Full resolution image of the pin.

image_widthinteger

Width in pixels of the full resolution image.

image_heightinteger

Height in pixels of the full resolution image.

image_sizesjson

Every image size Pinterest serves for the pin, keyed by size label, with url, width and height.

price_valuefloat

Price attached to the pin when it is a product pin. Served on profile inputs, and on any pin when Full Pin Details is on.

price_currencystring

Currency of price_value.

pin_privacystring

Visibility of the pin itself, e.g. public. Served on profile inputs, and on any pin when Full Pin Details is on.

pinner_idstring

Pinterest identifier of the account that owns the pin.

pinner_usernamestring

Handle of the account that owns the pin. Example: potterybarn

pinner_full_namestring

Display name of the account that owns the pin. Example: Pottery Barn

pinner_urlstring

Link to the profile of the account that owns the pin.

pinner_follower_countinteger

Follower count of the account that owns the pin. Pinterest only ships it on some surfaces; filled from the profile header on a profile input.

pinner_avatar_urlstring

Profile picture of the account that owns the pin.

pinner_is_verified_merchantboolean

True when the account that owns the pin is a Pinterest verified merchant.

board_idstring

Pinterest identifier of the board the pin is saved on.

board_namestring

Name of the board the pin is saved on. Example: Instagram Inspiration

board_urlstring

Link to the board the pin is saved on.

board_privacystring

Visibility of the board, e.g. public. Pinterest omits it from the keyword search payload.

visual_annotationsjson

Topic labels Pinterest attaches to the pin, e.g. Flex Room Design Ideas. Free on keyword searches; on board and profile pins Pinterest only serves them with Full Pin Details.

carousel_imagesjson

Every slide of a carousel pin, in order, with its own image url, width, height, outbound link and video url when the slide is a video. Empty for single-image pins. Free on board and profile pins; keyword searches only carry it with Full Pin Details.

Full Pin Details

share_countinteger

Number of times the pin was shared. Only Pinterest's pin page carries it, so it needs Full Pin Details.

dominant_intereststring

Interest label Pinterest attaches to the pin, e.g. Room Decor. Only Pinterest's pin page carries it, so it needs Full Pin Details.

visual_objectsjson

Objects Pinterest detected inside the pin image. Only Pinterest's pin page carries it, so it needs Full Pin Details. Frequently an empty list.

Code Examples

curl -G https://api.lobstr.io/v1/results \
  -H "Authorization: Token YOUR_API_KEY" \
  -d "squid=YOUR_SQUID_HASH" \
  -d "page=1"

Response

200
{"total_results": 1, "data": [{"pin_id": "37858453110553201", "pin_url": "https://www.pinterest.com/pin/37858453110553201/", "title": "Bright Living Room with Windows and Window Sill", "description": "This deserves another spot on the grid.", "domain": "potterybarn.com", "destination_url": "https://www.potterybarn.com/products/printers-writing-large-desk/", "save_count": 3920, "image_url": "https://i.pinimg.com/originals/c3/df/7f/c3df7f6f591485da278cb5a44aeff0be.jpg", "pinner_username": "potterybarn", "board_name": "Instagram Inspiration"}]}