/pinterest/pins/search

POST /api/pinterest/pins/search

Price: 5 credits

Search Pinterest Pins

How to use it

Search Pinterest pins by keyword. Set commerce_only to return only shoppable product pins; price range and source-domain filters further narrow product pins.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Search keyword (examples: "banana bread"; minLength: 1)
• count integer required — Max result count (examples: 20; min: 1)
• commerce_only boolean — Return only shoppable product pins (default: false)
• price_min number nullable — Minimum price filter for product pins (min: 0)
• price_max number nullable — Maximum price filter for product pins (min: 0)
• domains array nullable — Filter pins by source domain

Response

• @type string (default: "PinterestPin")
• id string required
• description string nullable
• image string nullable
• dominant_color string nullable
• alt_text string nullable
• link_url string nullable
• domain string nullable
• url string nullable
• hashtags array (default: [])
• save_count integer nullable
• reaction_count integer nullable
• comment_count integer nullable
• share_count integer nullable
• created_at integer nullable
• is_video boolean (default: false)
• video_url string nullable
• rich_type string nullable
• site_name string nullable
• price_value number nullable
• price_currency string nullable
• is_in_stock boolean nullable
• has_price_drop boolean (default: false)
• brand string nullable
• is_idea_pin boolean (default: false)
• page_count integer nullable
• recipe object nullable
  • @type string (default: "PinterestRecipe")
  • name string nullable
  • servings string nullable
  • cook_time integer nullable
  • diets array (default: [])
  • ingredients array (default: [])
• pinner object nullable
  • @type string (default: "PinterestUser")
  • id string required
  • alias string required
  • full_name string nullable
  • about string nullable
  • image string nullable
  • cover string nullable
  • follower_count integer nullable
  • following_count integer nullable
  • pin_count integer nullable
  • board_count integer nullable
  • video_pin_count integer nullable
  • story_pin_count integer nullable
  • website_url string nullable
  • domain string nullable
  • instagram_url string nullable
  • url string nullable
  • created_at integer nullable
  • is_verified boolean (default: false)
  • is_partner boolean (default: false)
  • is_verified_merchant boolean (default: false)
  • is_private_profile boolean (default: false)
• board object nullable
  • @type string (default: "PinterestBoard")
  • id string required
  • name string required
  • url string nullable
  • description string nullable
  • image string nullable
  • pin_count integer nullable
  • follower_count integer nullable
  • section_count integer nullable
  • collaborator_count integer nullable
  • privacy string nullable
  • created_at integer nullable
  • is_collaborative boolean (default: false)
  • owner object nullable
    • @type string (default: "PinterestUser")
    • id string required
    • alias string required
    • full_name string nullable
    • about string nullable
    • image string nullable
    • cover string nullable
    • follower_count integer nullable
    • following_count integer nullable
    • pin_count integer nullable
    • board_count integer nullable
    • video_pin_count integer nullable
    • story_pin_count integer nullable
    • website_url string nullable
    • domain string nullable
    • instagram_url string nullable
    • url string nullable
    • created_at integer nullable
    • is_verified boolean (default: false)
    • is_partner boolean (default: false)
    • is_verified_merchant boolean (default: false)
    • is_private_profile boolean (default: false)

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.