Appearance
Board
GET /v1/pinterest/board
Fetches a paginated list of pins from a Pinterest board by URL, returning each pin's id, description, title, images, board info, pin_join annotations, and aggregated_pin_data. Supports pagination via cursor and a trim option for lighter responses.
Authentication
All requests require the x-api-key header. Get your key at scrapecreators.com.
Query Parameters
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
url | string | yes | The URL of the board to get | https://www.pinterest.com/lizmrodgers/moms-night/ |
cursor | string | no | The cursor to get the next page of results | Y2JURlEwTWsxNlp6Vk9SR2MwV.... |
trim | boolean | no | Set to true for a trimmed down version of the response | false |
Example Request
curl
bash
curl 'https://api.scrapecreators.com/v1/pinterest/board?url=https://www.pinterest.com/lizmrodgers/moms-night/' \
-H 'x-api-key: $SCRAPECREATORS_API_KEY'Node / TypeScript
js
const params = new URLSearchParams({ url: 'https://www.pinterest.com/lizmrodgers/moms-night/' });
const res = await fetch(`https://api.scrapecreators.com/v1/pinterest/board?${params}`, {
headers: { 'x-api-key': process.env.SCRAPECREATORS_API_KEY }
});
const data = await res.json();
console.log(data);Python
python
import os, requests
r = requests.get(
'https://api.scrapecreators.com/v1/pinterest/board',
headers={'x-api-key': os.environ['SCRAPECREATORS_API_KEY']},
params={'url': 'https://www.pinterest.com/lizmrodgers/moms-night/'},
)
r.raise_for_status()
print(r.json())CLI
bash
scrapecreators pinterest board --helpExample Response
json
{
"success": true,
"pins": [
{
"id": "549579960798399243",
"link": "https://gekbuzz.com/crispy-air-fryer-pizza-rolls-recipe/",
"title": "Crispy Air Fryer Pizza Rolls Recipe -",
"board": {
"node_id": "Qm9hcmQ6NTQ5NTgwMDI5NDY3NTc3NDM2",
"followed_by_me": false,
"owner": {
"node_id": "VXNlcjo1NDk1ODAwOTgxODYwMzM3MzU=",
"image_small_url": "https://s.pinimg.com/images/user/default_30.png",
"is_primary_website_verified": true,
"is_verified_merchant": false,
"full_name": "Gekbuzz",
"username": "sharat24k",
"image_medium_url": "https://s.pinimg.com/images/user/default_75.png",
"id": "549580098186033735",
"verified_identity": {}
},
"privacy": "public",
"is_collaborative": false,
"url": "/sharat24k/pizza-recipes/",
"layout": "default",
"type": "board",
"name": "Pizza Recipes",
"id": "549580029467577436",
"collaborated_by_me": false
},
"unified_user_note": "Craving a quick snack that combines cheesy goodness and crispy texture? These air fryer pizza rolls are the answer! Perfect for movie nights, parties, or just a casual treat, they pack all the flavor of your favorite pizza into a bite-sized delight. Imagine biting into a perfectly golden roll where melty cheese and zesty sauce meld together. The air fryer gives these pizza rolls a satisfying crunch without the extra oil, making them a healthier option that doesn’t skimp on taste.",
"alt_text": "Crispy air fryer pizza rolls served with marinara sauce for dipping on a plate.",
"rich_summary": {
"actions": [],
"products": [],
"apple_touch_icon_link": null,
"type_name": "article",
"type": "richpingriddata",
"id": "5aa12f54bef882f6f3cdd77234027e25",
"favicon_link": "https://s.pinimg.com/images/default_rich_pin_favicon.png",
"url": "https://gekbuzz.com/crispy-air-fryer-pizza-rolls-recipe/",
"display_name": "Crispy Air Fryer Pizza Rolls Recipe -",
"favicon_images": {
"orig": "https://s.pinimg.com/images/default_rich_pin_favicon.png"
},
"display_description": "Craving a quick snack that combines cheesy goodness and crispy texture? These air fryer pizza rolls are the answer! Perfect for movie nights, parties, or just a casual treat, they pack all the flavor of your favorite pizza into a bite-sized delight. Imagine biting into a perfectly golden roll where melty cheese and zesty sauce […]",
"apple_touch_icon_images": null,
"site_name": "gekbuzz.com"
},
"reaction_counts": {},
"pinner": {
"node_id": "VXNlcjo1NDk1ODAwOTgxODYwMzM3MzU=",
"image_small_url": "https://s.pinimg.com/images/user/default_30.png",
"is_primary_website_verified": true,
"is_verified_merchant": false,
"full_name": "Gekbuzz",
... (truncated)Credits
Most ScrapeCreators endpoints consume 1 credit per successful response. Some heavier endpoints (transcripts, AI-driven enrichment, ad detail lookups) may cost more. Check GET /v1/credit-balance for your remaining balance.
Errors
| Status | Meaning | Action |
|---|---|---|
| 200 | Success. | Use the JSON payload. |
| 400 | Invalid or missing parameter. | Verify required parameters and value format. |
| 401 | Missing or invalid x-api-key. | Pass a valid API key in the header. |
| 402 | Out of credits. | Top up at scrapecreators.com or wait for plan reset. |
| 404 | Resource not found or private. | Confirm the handle, URL, or id and that the resource is public. |
| 429 | Rate limited. | Backoff and retry with exponential delay. |
| 500 | Server error or upstream platform failure. | Retry with backoff; report persistent errors to support. |