Pinterest icon

Pinterest

Interact with Pinterest API using pinterest-js-client

Search → Search

AI-generated

Summary

Searches Pinterest for pins, boards, or people matching a specified query, returning up to a given limit of results.

Inputs

  • Query (required) — The search query string to find relevant pins, boards, or people.
  • Scope — Specifies what to search for: pins, boards, or people. Defaults to pins.
  • Limit — Maximum number of search results to return. Defaults to 50.
  • Slowmo (Ms) — Slows down browser actions by the specified milliseconds for more human-like behavior; 0 for fastest.
  • Timeout (Ms) — Maximum time in milliseconds to wait for browser operations; default is 30000.
  • Viewport Width — Browser viewport width in pixels; default is 1920.
  • Viewport Height — Browser viewport height in pixels; default is 1080.

Output shape

a list of search result items matching the query within the requested scope

The output contains the search results as JSON objects returned by the Pinterest client library's search method. The number of results does not exceed the Limit parameter. Errors during execution are handled per-item if continueOnFail is set; otherwise, execution stops on failure.

Examples

Example 1: Search for pins matching 'chocolate cake' with a limit of 10

Set Query to 'chocolate cake', Scope to 'pins', and Limit to 10

Discussion