Pinterest API

List the pins saved on one public board

Identify the board with board_id to keep the request at one upstream lookup, or with the username plus slug pair. A slug call resolves the board id first; that resolution is cached for an hour on the slug pair and is never billed separately, so one request is always one charge and a repeat call to the same board costs the single feed lookup. Only pins are returned: advertisements and other non-pin modules are filtered out.

get/pinterest/board/pins

Request

  • Base URL: https://scrappa.co/api
  • URL: https://scrappa.co/api/pinterest/board/pins
  • Auth: API key in header X-API-KEY

Query parameters

board_idstring nullable

Numeric Pinterest board id. Recommended: it keeps the request to one upstream lookup. Without it the board id is resolved from username plus slug first, which is cached for an hour and never billed separately.

usernamestring nullable

Board owner username, without the @ prefix.

slugstring nullable

Board slug, as it appears in the board URL. Percent-encoded and NFD-composed slugs are normalised to the same NFC lookup.

limitinteger nullable

Number of pins to request (max 250). Default: 25.

bookmarkstring nullable

Pagination token from a previous response.

Response

successboolean required
board_idstring required
countinteger required
nextBookmarkstring nullable required
pinsobject[] required

Changes

No recorded changes to this operation across all 3 revisions of this API.