Skip to content
Examples

Update Settings

Configure Pinterest Scraper settings

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.
POSThttps://api.lobstr.io/v1/squids/{squid_hash}

Configure your Pinterest Scraper squid settings.

Headers

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Content-Typestringheaderrequired

Must be application/json. Value: application/json

Squid Parameters

Parameter Type Default Description
video_only boolean false Only keep pins that come with a playable video. Idea pins are not included.
pin_details boolean false Open each pin to add its share, comment and save counts, price, alt text, full description and the topics Pinterest detected. Included at no extra cost when the task is a single pin link. Costs 1 extra credit per pin otherwise.
max_results integer — The most pins to collect from each keyword, board or profile. Leave empty to collect everything Pinterest shows.
max_unique_results_per_run integer — Maximum number of unique pins retrieved across all tasks in the entire run. Leave empty for unlimited.

Code Examples

curl -X POST https://api.lobstr.io/v1/squids/YOUR_SQUID_HASH \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "video_only": false,
    "pin_details": true,
    "max_results": 100
  }'

Response

201
{"params": {"video_only": false, "pin_details": true, "max_results": 100}}