Skip to main content
GET
/
v1
/
scrape
/
pinterest
/
board
Board
curl --request GET \
  --url https://api.sociavault.com/v1/scrape/pinterest/board \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "pins": {
    "0": {
      "node_id": "UGluOjYzODk0ODg4NDcxNzM5Njk0",
      "call_to_action_text": null,
      "story_pin_data_id": null,
      "description": " ",
      "favorite_user_count": 0,
      "debug_info_html": null,
      "id": "63894888471739694",
      "link": null,
      "has_required_attribution_provider": false,
      "should_open_in_stream": false,
      "campaign_id": null,
      "type": "pin",
      "insertion_id": null,
      "is_eligible_for_related_products": false,
      "board": {
        "node_id": "Qm9hcmQ6NjM4OTQ5NTcxNTI3MTg1MTk=",
        "privacy": "public",
        "url": "/lizmrodgers/moms-night/",
        "name": "Moms night",
        "layout": "default",
        "followed_by_me": false,
        "owner": {
          "node_id": "VXNlcjo2Mzg5NTAyNTg3MTc0OTM3NA==",
          "image_medium_url": "https://i.pinimg.com/75x75_RS/c2/0e/62/c20e628451b24267c68924d01e42c997.jpg",
          "full_name": "Liz Rodgers - DIY | Home Decor",
          "is_verified_merchant": false,
          "is_primary_website_verified": false,
          "username": "lizmrodgers",
          "verified_identity": {},
          "image_small_url": "https://i.pinimg.com/30x30_RS/c2/0e/62/c20e628451b24267c68924d01e42c997.jpg",
          "id": "63895025871749374"
        },
        "type": "board",
        "id": "63894957152718519",
        "collaborated_by_me": false,
        "is_collaborative": false
      },
      "is_promoted": false,
      "seo_alt_text": "Europe Outfits, Italy Outfits, Mode Inspo, Looks Chic, Outfit Casual, Summer Fashion Outfits, Mode Inspiration, Lookbook Outfits, Spring Summer Outfits",
      "product_pin_data": null,
      "shopping_flags": {},
      "rich_summary": null,
      "done_by_me": true,
      "repin_count": 0,
      "aggregated_pin_data": {
        "node_id": "QWdncmVnYXRlZFBpbkRhdGE6NTM2NzAxNzU3MTA3Nzg5NDI0OA==",
        "has_xy_tags": false,
        "creator_analytics": null,
        "is_shop_the_look": false,
        "did_it_data": {
          "tags": {},
          "details_count": 0,
          "recommended_count": 0,
          "user_count": 0,
          "recommend_scores": {
            "0": {
              "score": 1,
              "count": 0
            },
            "1": {
              "score": 0.5,
              "count": 0
            },
            "2": {
              "score": 0,
              "count": 0
            }
          },
          "images_count": 0,
          "type": "aggregateddiditdata",
          "videos_count": 0,
          "rating": -1,
          "responses_count": 0
        },
        "aggregated_stats": {
          "saves": 10301,
          "done": 0
        },
        "id": "5367017571077894248"
      },
      "unified_user_note": null,
      "product_metadata": null,
      "reaction_counts": {
        "1": 98
      },
      "is_eligible_for_pre_loved_goods_label": false,
      "videos": null,
      "is_oos_product": false,
      "title": "",
      "is_eligible_for_pdp": false,
      "grid_attribution": null,
      "utm_link": null,
      "video_status": null,
      "favorited_by_me": false,
      "seo_url": "/pin/63894888471739694/",
      "is_stale_product": false,
      "domain": "Uploaded by user",
      "is_native": false,
      "story_pin_data": null,
      "image_crop": {
        "min_y": 0,
        "max_y": 1
      },
      "category": "",
      "unauth_on_page_description": "",
      "pinner": {
        "node_id": "VXNlcjo2Mzg5NTAyNTg3MTc0OTM3NA==",
        "image_medium_url": "https://i.pinimg.com/75x75_RS/c2/0e/62/c20e628451b24267c68924d01e42c997.jpg",
        "full_name": "Liz Rodgers - DIY | Home Decor",
        "is_verified_merchant": false,
        "is_primary_website_verified": false,
        "username": "lizmrodgers",
        "verified_identity": {},
        "image_small_url": "https://i.pinimg.com/30x30_RS/c2/0e/62/c20e628451b24267c68924d01e42c997.jpg",
        "id": "63895025871749374"
      },
      "is_quick_promotable": false,
      "is_repin": true,
      "video_status_message": null,
      "grid_title": "",
      "link_domain": null,
      "images": {
        "170x": {
          "width": 236,
          "height": 419,
          "url": "https://i.pinimg.com/236x/a4/4f/b7/a44fb7852e2a4dc3347618c1a73c48ac.jpg"
        },
        "136x136": {
          "width": 136,
          "height": 136,
          "url": "https://i.pinimg.com/136x136/a4/4f/b7/a44fb7852e2a4dc3347618c1a73c48ac.jpg"
        },
        "236x": {
          "width": 236,
          "height": 419,
          "url": "https://i.pinimg.com/236x/a4/4f/b7/a44fb7852e2a4dc3347618c1a73c48ac.jpg"
        },
        "474x": {
          "width": 474,
          "height": 842,
          "url": "https://i.pinimg.com/474x/a4/4f/b7/a44fb7852e2a4dc3347618c1a73c48ac.jpg"
        },
        "736x": {
          "width": 736,
          "height": 1308,
          "url": "https://i.pinimg.com/736x/a4/4f/b7/a44fb7852e2a4dc3347618c1a73c48ac.jpg"
        },
        "orig": {
          "width": 1080,
          "height": 1920,
          "url": "https://i.pinimg.com/originals/a4/4f/b7/a44fb7852e2a4dc3347618c1a73c48ac.jpg"
        }
      },
      "is_downstream_promotion": false,
      "native_creator": null,
      "auto_alt_text": null,
      "alt_text": null,
      "link_utm_applicable_and_replaced": 0,
      "promoted_lead_form": null,
      "attribution": null,
      "promoted_is_lead_ad": false,
      "image_signature": "a44fb7852e2a4dc3347618c1a73c48ac",
      "access": {},
      "sponsorship": null,
      "carousel_data": null,
      "pin_join": {
        "shopping_klp_urls": null,
        "visual_annotation": {
          "0": "Europe Outfits",
          "1": "Italy Outfits",
          "2": "Mode Inspo",
          "3": "Looks Chic",
          "4": "Outfit Casual",
          "5": "Summer Fashion Outfits",
          "6": "Mode Inspiration",
          "7": "Lookbook Outfits",
          "8": "Spring Summer Outfits"
        },
        "annotations_with_links": {
          "Europe Outfits": {
            "url": "/ideas/europe-outfits/904854149980/",
            "name": "Europe Outfits"
          },
          "Italy Outfits": {
            "url": "/ideas/italy-outfits/934427945587/",
            "name": "Italy Outfits"
          },
          "Mode Inspo": {
            "url": "/ideas/mode-inspo/921079732344/",
            "name": "Mode Inspo"
          },
          "Looks Chic": {
            "url": "/ideas/looks-chic/940735411251/",
            "name": "Looks Chic"
          },
          "Outfit Casual": {
            "url": "/ideas/outfit-casual/941493827774/",
            "name": "Outfit Casual"
          },
          "Summer Fashion Outfits": {
            "url": "/ideas/summer-fashion-outfits/930305095528/",
            "name": "Summer Fashion Outfits"
          },
          "Mode Inspiration": {
            "url": "/ideas/mode-inspiration/959316492353/",
            "name": "Mode Inspiration"
          },
          "Lookbook Outfits": {
            "url": "/ideas/lookbook-outfits/931785222895/",
            "name": "Lookbook Outfits"
          },
          "Spring Summer Outfits": {
            "url": "/ideas/spring-summer-outfits/953836693773/",
            "name": "Spring Summer Outfits"
          }
        },
        "canonical_pin": {
          "id": "211174978048607"
        }
      },
      "promoter": null,
      "embed": null,
      "collection_pin": null,
      "digital_media_source_type": null,
      "dominant_color": "#e8e8e8",
      "creator_analytics": null,
      "tracking_params": "CwABAAAAEDE0NjQ0NTEzMDc4MTAxNTgGAAMAAQsABwAAAApuZ2FwaS9wcm9kAA",
      "promoted_is_removable": false,
      "is_go_linkless": false
    }
  },
  "cursor": "Y2JZakk0ZUU1WWQzaE9SRmt3VGtSVmVFMTZRVE5QUkVWM1RWUlZORXRyWkZKVVEzQTRUa2ROTVUxNlFtbE9Na2w1VFZkUk1sa3lXbWhPVjBaclRrUnNhRmxxUVhsT1JFcHRUVWRaZVZsVVp6TlpWRmsxVG1wWmVVNXFTVE5PUjBwc1RWUkdiRTF0VlROUFZFa3pUWHBOTkZwSFJtcE9hbWMxV1c1NFQxSldaRGc9fFVIbzVUMkl5Tld4bVJFVXdUbXBSTUU1VVJYcE5SR00wVFZSQmVFNVVaM0ZTTVVaTlMyNTRiRTFYVW0xYVYxRjZUMVJDYWxwRVZUUmFSRkV5VDFSc2FVMVhVbXhhVkZaclRrZFZORTlIVW10WlYxVTFUa2RTYkZwVVdtdFBSMVYzVDFSbmVGcHFaM2hPUjBrelRrUkNhVmxxU1hsT2VtaHNUVlJXYldaRk5VWldNM2M5fE5vbmV8MTQ2NDQ1MTMwNzgxMDE1OCpHUUwqfGRiYTM2NGJiYjY3MTE0MTAzOTBmOWNjYmRmMjI3NmVjNGIzM2MyZTBiYWVmM2IzMGMzY2IyZWVlODhhM2Q5Mzd8TkVXfA==",
  "creditsUsed": 1
}
💳 1 credit per request

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Format: sk_live_xxxxxxxxxxxxx

Get your API key from the Dashboard.

Query Parameters

​
url
string
required

The URL of the board to get

Example:

"https://www.pinterest.com/lizmrodgers/moms-night/"

​
cursor
string

The cursor to get the next page of results

Example:

"Y2JURlEwTWsxNlp6Vk9SR2MwV...."

​
trim
boolean

Set to true for a trimmed down version of the response

Example:

false

Response

Successful response

Key Response Fields:

  • pins[n].id: Pin unique ID
  • pins[n].title: Pin title
  • pins[n].description: Pin description text
  • pins[n].link: External destination URL
  • pins[n].domain: Source domain
  • pins[n].images: Image size variants
  • pins[n].pinner.username: Pinner handle
  • pins[n].aggregated_pin_data.aggregated_stats.saves: Total saves count
  • pins[n].board.name: Parent board name
  • cursor: Pagination cursor for next page