pinterest

Search

Returns Pinterest pins matching a keyword, each with its text, original image, pinner and pin date; include=engagement adds save, reaction, comment and share counts.

Use it to discover pins on a topic; add include=engagement for each pin's saves, or call pin when you already have one pin URL.

Metered: 10–260 credits. We reserve the ceiling when the call starts and charge what it actually used when it finishes.

Paginates by cursor: see Pagination.

get/v1/pinterest/search

Request

  • Base URL: https://api.insightsocial.app
  • URL: https://api.insightsocial.app/v1/pinterest/search
  • Auth: API key in header x-api-key

Query parameters

querystring required
Example:home decor ideas

Keyword or phrase to search Pinterest pins for.

cursorstring

Cursor to get the next page. Take it from pagination.next_cursor on the previous response.

trimboolean

Set to true for a lighter record with fewer fields.

include'engagement'

Set to engagement (one token only) to fill post.engagement.saves, .likes (reactions), .comments and .shares on every row in this one call.

limitinteger

Take the top N rows of the page (1 to 25) after the search has run. It is not a page size: next_cursor still advances past the full page, so rows beyond N on this page are not returned by the next page.

sincestring

Only rows published on or after this date: YYYY-MM-DD (midnight UTC) or an ISO 8601 timestamp. Rows older than it are left off each page. This list is not in date order, so the walk does not stop at the date: keep following next_cursor, and each page costs what a page costs even when every row on it is filtered out. A row with no date is kept.

untilstring

Only rows published on or before this date: YYYY-MM-DD (that whole UTC day is included) or an ISO 8601 timestamp. Newer rows are left off each page and the walk does not stop, so older pages follow. A row with no date is kept.

dry_run'1'

Set to 1 to get the price of this call without making it: data.dry_run carries credits_min and credits_max. Nothing is charged.

Response

Success.

successtrue required
platformstring required
endpointstring required
schema_version'2' required
unavailablestring[] required
credits_usedinteger required
credits_remaininginteger required
request_idstring required
cachedboolean required
idempotent_replayboolean required
charge_reasonstring required
free_callboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.