# Pinterest Board Pins API
Pinterest
Returns the pins of a public Pinterest board from its link, pin.it short link or ID, or the pins of one section from the section's link. Each pin has its title, description, picture or video files with their sizes, exact saves and reactions, the page it links to, the pinner and the account that first pinned it. Page through the whole board with the cursor.
GET `/v1/pinterest/board_pins`
## Example
cURL:
```shell
curl -G 'https://socialtap.dev/v1/pinterest/board_pins' \
--data-urlencode 'url=https://www.pinterest.com/giphy/best-gifs/' \
-H "x-api-key: $SOCIALTAP_API_KEY"
```
TypeScript SDK:
```typescript
import { SocialTap } from "socialtap";
const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY
const res = await client.pinterest.boardPins.list({ url: "https://www.pinterest.com/giphy/best-gifs/" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
```
Node.js (fetch):
```javascript
const params = new URLSearchParams({
url: "https://www.pinterest.com/giphy/best-gifs/",
});
const res = await fetch(`https://socialtap.dev/v1/pinterest/board_pins?${params}`, {
headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, page, meta } = body;
console.log(data, meta.credits_charged);
```
Python (requests):
```python
import os
import requests
res = requests.get(
"https://socialtap.dev/v1/pinterest/board_pins",
params={"url": "https://www.pinterest.com/giphy/best-gifs/"},
headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, page, meta = body["data"], body["page"], body["meta"]
print(data, meta["credits_charged"])
```
Go (net/http):
```go
package main
import (
"encoding/json"
"fmt"
"log"
"net/http"
"net/url"
"os"
)
func main() {
q := url.Values{}
q.Set("url", "https://www.pinterest.com/giphy/best-gifs/")
req, err := http.NewRequest("GET", "https://socialtap.dev/v1/pinterest/board_pins?"+q.Encode(), nil)
if err != nil {
log.Fatal(err)
}
req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
log.Fatal(err)
}
defer res.Body.Close()
var body struct {
Data json.RawMessage `json:"data"`
Page json.RawMessage `json:"page"`
Meta map[string]any `json:"meta"`
Error *struct {
Code string `json:"code"`
Message string `json:"message"`
} `json:"error"`
}
if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
log.Fatal(err)
}
if body.Error != nil {
log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
}
fmt.Println(string(body.Data), body.Meta["credits_charged"])
}
```
200 OK:
```json
{
"data": [
{
"approximate_fields": [],
"author": {
"avatar_url": "https://i.pinimg.com/280x280_RS/f3/a9/1b/f3a91b786c4e9ad0646de1388871c331.jpg",
"display_name": "GIPHY",
"id": "493636946564764083",
"is_verified": false,
"url": "https://www.pinterest.com/giphy/",
"username": "giphy"
},
"coauthors": [],
"duration_ms": null,
"hashtags": [],
"id": "e1_AfqPShwBVp5ZokaT5khmGRiwRiGqtei_y-FH7Ja8X5R6VT4xupTL",
"is_nsfw": null,
"is_pinned": null,
"is_sponsored": false,
"language": null,
"media": [
{
"alt_text": null,
"duration_ms": null,
"expires_at": null,
"height": 1067,
"thumbnail_url": "https://i.pinimg.com/originals/0c/06/20/0c062027526cb5ea955f68145fc430c0.gif",
"type": "gif",
"url": "https://i.pinimg.com/originals/0c/06/20/0c062027526cb5ea955f68145fc430c0.gif",
"width": 480
}
],
"mentions": [],
"metrics": {
"comment_count": null,
"like_count": 12,
"quote_count": null,
"repost_count": null,
"save_count": 185,
"share_count": null,
"view_count": null
},
"platform": "pinterest",
"platform_specific": {
"pinterest": {
"author_follower_count": null,
"board": {
"id": "493636877845977605",
"title": "Best GIFs!",
"url": "https://www.pinterest.com/giphy/best-gifs/"
},
"caption_languages": [],
"domain": "medium.com",
"dominant_color": "#444477",
"interests": [],
"is_ad": false,
"is_author_verified_merchant": false,
"is_repin": false,
"link_url": "https://medium.com/@giphy/compassion-virtual-events-and-holidays-lead-giphys-april-insights-78b7adb09431",
"original_pinner": {
"avatar_url": "https://i.pinimg.com/280x280_RS/f3/a9/1b/f3a91b786c4e9ad0646de1388871c331.jpg",
"display_name": "GIPHY",
"id": "493636946564764083",
"is_verified": false,
"url": "https://www.pinterest.com/giphy/",
"username": "giphy"
},
"repin_count": 177,
"rich_type": "article"
}
},
"platform_type": "pin",
"published_at": "2020-05-07T14:46:12Z",
"text": null,
"thumbnail_url": "https://i.pinimg.com/originals/0c/06/20/0c062027526cb5ea955f68145fc430c0.gif",
"title": null,
"type": "image",
"unknown_fields": [
"platform_specific.pinterest.interests"
],
"url": "https://www.pinterest.com/pin/e1_AfqPShwBVp5ZokaT5khmGRiwRiGqtei_y-FH7Ja8X5R6VT4xupTL/"
},
{
"approximate_fields": [],
"author": {
"avatar_url": "https://i.pinimg.com/280x280_RS/f3/a9/1b/f3a91b786c4e9ad0646de1388871c331.jpg",
"display_name": "GIPHY",
"id": "493636946564764083",
"is_verified": false,
"url": "https://www.pinterest.com/giphy/",
"username": "giphy"
},
"coauthors": [],
"duration_ms": null,
"hashtags": [],
"id": "e1_AfqPShx_93vkYha4fXkGKz4d5W8bAC00UIJf5ygYQ5a810vu6yg_",
"is_nsfw": null,
"is_pinned": null,
"is_sponsored": false,
"language": null,
"media": [
{
"alt_text": "the text reads, 2020 year in review on a black background with pink and purple squares",
"duration_ms": null,
"expires_at": null,
"height": 375,
"thumbnail_url": "https://i.pinimg.com/originals/d9/b3/d2/d9b3d2accbee36003a039826fa6fa455.gif",
"type": "gif",
"url": "https://i.pinimg.com/originals/d9/b3/d2/d9b3d2accbee36003a039826fa6fa455.gif",
"width": 750
}
],
"mentions": [],
"metrics": {
"comment_count": null,
"like_count": 3,
"quote_count": null,
"repost_count": null,
"save_count": 71,
"share_count": null,
"view_count": null
},
"platform": "pinterest",
"platform_specific": {
"pinterest": {
"author_follower_count": null,
"board": {
"id": "493636877845977605",
"title": "Best GIFs!",
"url": "https://www.pinterest.com/giphy/best-gifs/"
},
"caption_languages": [],
"domain": "giphy.medium.com",
"dominant_color": "#141414",
"interests": [],
"is_ad": false,
"is_author_verified_merchant": false,
"is_repin": false,
"link_url": "https://giphy.medium.com/giphys-most-viewed-gifs-of-2020-f198557f0080",
"original_pinner": null,
"repin_count": 64,
"rich_type": "article"
}
},
"platform_type": "pin",
"published_at": "2020-12-01T15:41:37Z",
"text": null,
"thumbnail_url": "https://i.pinimg.com/originals/d9/b3/d2/d9b3d2accbee36003a039826fa6fa455.gif",
"title": null,
"type": "image",
"unknown_fields": [
"platform_specific.pinterest.interests"
],
"url": "https://www.pinterest.com/pin/e1_AfqPShx_93vkYha4fXkGKz4d5W8bAC00UIJf5ygYQ5a810vu6yg_/"
},
{
"approximate_fields": [],
"author": {
"avatar_url": "https://i.pinimg.com/280x280_RS/f3/a9/1b/f3a91b786c4e9ad0646de1388871c331.jpg",
"display_name": "GIPHY",
"id": "493636946564764083",
"is_verified": false,
"url": "https://www.pinterest.com/giphy/",
"username": "giphy"
},
"coauthors": [],
"duration_ms": null,
"hashtags": [],
"id": "e1_AfqPShzsdXeagQPfHhFlJl0p6GhC23D3tyYmQMyvJTWRiKCh1KYz",
"is_nsfw": null,
"is_pinned": null,
"is_sponsored": false,
"language": null,
"media": [
{
"alt_text": "the zodiac sign is in front of a blue background with an image of a woman and two",
"duration_ms": null,
"expires_at": null,
"height": 1920,
"thumbnail_url": "https://i.pinimg.com/originals/ca/aa/4b/caaa4bfeeaf1611db85fc1f9d35980df.gif",
"type": "gif",
"url": "https://i.pinimg.com/originals/ca/aa/4b/caaa4bfeeaf1611db85fc1f9d35980df.gif",
"width": 1080
}
],
"mentions": [],
"metrics": {
"comment_count": null,
"like_count": 0,
"quote_count": null,
"repost_count": null,
"save_count": 9,
"share_count": null,
"view_count": null
},
"platform": "pinterest",
"platform_specific": {
"pinterest": {
"author_follower_count": null,
"board": {
"id": "493636877845977605",
"title": "Best GIFs!",
"url": "https://www.pinterest.com/giphy/best-gifs/"
},
"caption_languages": [],
"domain": "giphy.com",
"dominant_color": "#20aab9",
"interests": [],
"is_ad": false,
"is_author_verified_merchant": false,
"is_repin": false,
"link_url": "https://giphy.com/stories/zodiac-d010c61c-f7e3",
"original_pinner": {
"avatar_url": "https://i.pinimg.com/280x280_RS/f3/a9/1b/f3a91b786c4e9ad0646de1388871c331.jpg",
"display_name": "GIPHY",
"id": "493636946564764083",
"is_verified": false,
"url": "https://www.pinterest.com/giphy/",
"username": "giphy"
},
"repin_count": 8,
"rich_type": "classifier data"
}
},
"platform_type": "pin",
"published_at": "2020-01-23T19:00:03Z",
"text": "It's the year on the Rat.",
"thumbnail_url": "https://i.pinimg.com/originals/ca/aa/4b/caaa4bfeeaf1611db85fc1f9d35980df.gif",
"title": "What's Your Zodiac Sign?",
"type": "image",
"unknown_fields": [
"platform_specific.pinterest.interests"
],
"url": "https://www.pinterest.com/pin/e1_AfqPShzsdXeagQPfHhFlJl0p6GhC23D3tyYmQMyvJTWRiKCh1KYz/"
}
],
"page": {
"has_more": true,
"next_cursor": "c1.EXAMPLE_CURSOR",
"next_cursor_expires_at": "2026-10-26T12:00:00Z",
"end_reason": null
},
"meta": {
"request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
"platform": "pinterest",
"source": "api",
"is_cached": false,
"credits_charged": 1,
"latency_ms": 0,
"fetched_at": "2026-10-25T12:00:00Z",
"input": {
"kind": "playlist",
"id": "493636877845977605",
"url": "https://www.pinterest.com/giphy/best-gifs/"
},
"credits_remaining": 9999,
"client_request_id": null,
"warnings": []
}
}
```
Long arrays and strings are shortened for display; real responses are complete.
> [!NOTE]
>
> **Good to know**
>
> - Pinterest gives the pins of a whole board an ID starting with e1_, which its pin page opens only for signed-in accounts, so the Pinterest Pin API can't take it. Everything else about each pin is in the item. A section's pins have their usual numeric IDs.
> - Pinterest hides some of a board's pins from logged-out visitors, so the list can hold fewer pins than the board's pin count. When it stops short of that count, page.end_reason is platform_limit, not end.
> - Pinterest sometimes shows a logged-out visitor only a board's first 25 pins. When every attempt meets that limit, the first page has 25 pins and page.end_reason platform_limit; asking again later, once the cached answer expires, can return the full page.
> - Pins come in Pinterest's own order: mostly the latest saved first, with a few it picks moved to the top. since and until are not taken.
> - A board's list has no comment or share counts, the pinner's follower count or the pin's interests. The Pinterest Pin API has them for a pin with a numeric ID.
> - When Pinterest's main API fails, the first page comes from its embed API, which serves a board's latest pins and nothing past them: numeric IDs, no dates or reactions, and page.end_reason platform_limit when the board has more.
## Authorizations
`x-api-key`stringheaderrequired
Your API key. [Authentication](https://socialtap.dev/docs/authentication/index.md)
## Query parameters
| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `url` required | `string`
max 2,048 chars | The board: its link (pinterest.com/\/\/, also on a country's site such as uk.pinterest.com or pinterest.co.uk), a section's link (pinterest.com/\/\/\/) for that section's pins, a short link (pin.it/\) or the board's ID. | `https://www.pinterest.com/pinterest/easy-and-chic-holiday-nail-ideas/` |
| `limit` optional | `integer`
min 1
max 50 | Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for. | `50` |
| `cursor` optional | `string` | page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page. | — |
`url` takes Pinterest playlist links; another kind of link, or another platform's, fails free with [`invalid_input`](https://socialtap.dev/docs/errors/index.md#invalid_input). Unknown parameters are rejected with a suggestion, never ignored ([Requests](https://socialtap.dev/docs/requests/index.md)). `limit` and `cursor` page through the list: see Pagination.
**Parameters every endpoint accepts**
| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `max_age` optional | `integer`
min 0 | Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. | — |
| `fields` optional | `string` | Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments\[\].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole. | — |
## Response
### 200
`{data, page, meta}`. `data` is an array of up to 50 [post](https://socialtap.dev/resources/post/index.md) objects, Pinterest's order for logged-out visitors: mostly the latest saved first, with a few pins it picks moved to the top; `page` says how to get the next page; `meta` describes the request ([meta](https://socialtap.dev/docs/reference/index.md#meta)). Fields only Pinterest has are under `platform_specific.pinterest`.
| Field | Type | Description |
| --- | --- | --- |
| `data[].platform` | `string` | Platform ID (tiktok, youtube, …). |
| `data[].id` | `string` | Platform-native post ID (string; Instagram shortcode, Reddit with its t3_ prefix). |
| `data[].url` | `string` (uri) | Canonical post URL. |
| `data[].type` | `string` | Normalized content shape. New values may be added; treat unknown values as other.
One of `video`, `image`, `carousel`, `text`, `link`, `audio` |
| `data[].platform_type` | `string` or `null` | The platform's own product label, lowercase (reel, short, story, live, tweet, …). |
| `data[].title` | `string` or `null` | Headline (YouTube title, Reddit title); null on caption-only platforms. |
| `data[].text` | `string` or `null` | Caption, description or body as plain text. |
| `data[].language` | `string` or `null` | BCP-47 language of text, when the platform states it. |
| `data[].published_at` | `string` (date-time) or `null` | When the post went public, RFC 3339 UTC. |
| `data[].author` | `object` | The posting account. An account the platform no longer names (a deleted account) has a null id and username and the platform's label as display_name (Reddit: \[deleted\]). A post credited to what is no account of the platform's (an Apple Music radio episode's show) has a null id and username, and every other field null too when the platform doesn't name it. |
| `data[].author.id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data[].author.username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data[].author.display_name` | `string` or `null` | Display name shown on the profile. |
| `data[].author.url` | `string` (uri) or `null` | Canonical profile URL. |
| `data[].author.avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data[].author.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data[].coauthors` | `object[]` | Other accounts credited as co-authors of the post (Instagram and Facebook collabs, YouTube collaborations), in the platform's order, author excluded; \[\] if none. |
| `data[].coauthors[].id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data[].coauthors[].username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data[].coauthors[].display_name` | `string` or `null` | Display name shown on the profile. |
| `data[].coauthors[].url` | `string` (uri) or `null` | Canonical profile URL. |
| `data[].coauthors[].avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data[].coauthors[].is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data[].duration_ms` | `integer` or `null` | Length of the primary video or audio in milliseconds; null for other posts. |
| `data[].thumbnail_url` | `string` (uri) or `null` | Cover or poster image URL. |
| `data[].media` | `object[]` | Attachments in display order (carousel items); \[\] for text posts. |
| `data[].media[].type` | `string` | Kind of file. New values may be added; treat unknown values as other.
One of `image`, `video`, `audio`, `gif` |
| `data[].media[].url` | `string` (uri) or `null` | Direct file URL; null when the platform withholds it, or when the link would only work from SocialTap's network or with a login. Often signed and expiring: see expires_at. |
| `data[].media[].expires_at` | `string` (date-time) or `null` | When url stops working, RFC 3339 UTC, read from the platform's signed URL; null when unknown or when it does not expire. |
| `data[].media[].thumbnail_url` | `string` (uri) or `null` | Poster or preview image URL. |
| `data[].media[].width` | `integer` or `null` | Width in pixels. |
| `data[].media[].height` | `integer` or `null` | Height in pixels. |
| `data[].media[].duration_ms` | `integer` or `null` | Duration in milliseconds (video and audio only). |
| `data[].media[].alt_text` | `string` or `null` | Accessibility text provided by the author or platform. |
| `data[].hashtags` | `string[]` | Hashtags without #, case kept; \[\] if none. |
| `data[].mentions` | `string[]` | Mentioned or tagged usernames without @; \[\] if none. |
| `data[].is_pinned` | `boolean` or `null` | Pinned to the author's profile. |
| `data[].is_sponsored` | `boolean` or `null` | Labeled as a paid partnership or branded content. |
| `data[].is_nsfw` | `boolean` or `null` | Marked adult or sensitive by the platform. |
| `data[].metrics` | `object` | Counts at fetch time; null = hidden or not exposed, 0 = zero. |
| `data[].metrics.view_count` | `integer` or `null` | Views or plays. |
| `data[].metrics.like_count` | `integer` or `null` | Pinterest: reactions. Likes, hearts, total reactions or upvotes; never negative. Null when hidden by the owner. |
| `data[].metrics.comment_count` | `integer` or `null` | Comments and replies. |
| `data[].metrics.share_count` | `integer` or `null` | Shares or sends (not reposts). |
| `data[].metrics.repost_count` | `integer` or `null` | Reposts, retweets or reshares. |
| `data[].metrics.quote_count` | `integer` or `null` | Quote posts. |
| `data[].metrics.save_count` | `integer` or `null` | Pinterest: saves. Saves, bookmarks or favorites. |
| `data[].platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\); each null when unknown. |
| `data[].platform_specific.pinterest` | `object` or `null` | A pin's own fields. |
| `data[].platform_specific.pinterest.link_url` | `string` (uri) or `null` | The page the pin links to (its destination); null for a pin saved without one. |
| `data[].platform_specific.pinterest.domain` | `string` or `null` | The linked site's domain as Pinterest shows it (tastemade.com); null for a pin that links nowhere. |
| `data[].platform_specific.pinterest.board` | `object` or `null` | The board the pin is saved to. |
| `data[].platform_specific.pinterest.board.id` | `string` or `null` | The board's ID. |
| `data[].platform_specific.pinterest.board.title` | `string` or `null` | The board's name. |
| `data[].platform_specific.pinterest.board.url` | `string` (uri) or `null` | The board's link. |
| `data[].platform_specific.pinterest.original_pinner` | `object` or `null` | The account that first saved this picture or video to Pinterest (its uploader, for a pin made on Pinterest); null when Pinterest names none. author is the account whose pin this is, which for a repin is another. |
| `data[].platform_specific.pinterest.original_pinner.id` | `string` or `null` | Platform-native account ID; null when only the handle is known. |
| `data[].platform_specific.pinterest.original_pinner.username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data[].platform_specific.pinterest.original_pinner.display_name` | `string` or `null` | Display name shown on the profile. |
| `data[].platform_specific.pinterest.original_pinner.url` | `string` (uri) or `null` | Canonical profile URL. |
| `data[].platform_specific.pinterest.original_pinner.avatar_url` | `string` (uri) or `null` | Profile picture URL. Platform CDN URLs can expire within hours. |
| `data[].platform_specific.pinterest.original_pinner.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data[].platform_specific.pinterest.author_follower_count` | `integer` or `null` | The pinner's exact follower count; null when the source does not state it. |
| `data[].platform_specific.pinterest.is_author_verified_merchant` | `boolean` or `null` | Whether the pinner is a Pinterest verified merchant (a shop Pinterest checked); null when the source does not state it. |
| `data[].platform_specific.pinterest.is_repin` | `boolean` or `null` | The pin is a save (repin) of another account's pin. |
| `data[].platform_specific.pinterest.repin_count` | `integer` or `null` | Saves of this pin itself; metrics.save_count counts the saves of every pin of the same picture or video. |
| `data[].platform_specific.pinterest.dominant_color` | `string` or `null` | The picture's dominant color, as #rrggbb. |
| `data[].platform_specific.pinterest.rich_type` | `string` or `null` | The kind of page a rich pin shows details of (recipe, article, product, …); null for a pin that is no rich pin. |
| `data[].platform_specific.pinterest.interests` | `string[]` | The interests Pinterest files the pin under, each an ideas page of its own, in its order; \[\] when none. |
| `data[].platform_specific.pinterest.caption_languages` | `string[]` | The languages of the captions Pinterest has for the pin's video (en-us, …), as BCP-47 tags; \[\] when none. |
| `data[].platform_specific.pinterest.is_ad` | `boolean` or `null` | The pin runs as an ad (a Promoted pin). |
| `data[].approximate_fields` | `string[]` | JSON paths of values rounded by the platform or parsed from display text. A list path (external_links) means the list may be incomplete. \[\] when all exact. |
| `data[].unknown_fields` | `string[]` | JSON paths of lists whose \[\] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. \[\] when every list is known. |
not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.
### 400
400 Bad Request: 2 error codes. Free: errors cost nothing.
| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | A parameter is missing or malformed, or the link is not one this endpoint takes. | Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one. |
| `invalid_cursor` | 400 | No | The cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it. | Repeat the original request without cursor to start the list again. |
### 401
401 Unauthorized: 1 error code. Free: errors cost nothing.
| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired. | Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url. |
### 402
402 Payment Required: 2 error codes. Free: errors cost nothing.
| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `insufficient_credits` | 402 | No | The account does not have enough credits for this request. | Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically. |
| `spend_limit_reached` | 402 | No | The API key reached its spend limit for this period. The account may still have credits. | Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically. |
### 403
403 Forbidden: 2 error codes. Free: errors cost nothing.
| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code. | Act on details.reason. suspended: contact [support](mailto:support@socialtap.dev). scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP. |
| `private_or_unavailable` | 403 | No | The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code. | Only public items can be fetched. Do not retry. |
### 404
404 Not Found: 1 error code. Free: errors cost nothing.
| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `not_found` | 404 | No | The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why). | Check the link or ID. Do not retry. |
### 429
429 Too Many Requests: 1 error code. Free: errors cost nothing.
| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, later | The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it. | Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask [support](mailto:support@socialtap.dev) to raise the ceiling; without an API key, send one. |
### 500
500 Internal Error: 1 error code. Free: errors cost nothing.
| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `internal` | 500 | Yes, later | An unexpected error on SocialTap's side. | Retry with backoff. If it keeps happening, contact [support](mailto:support@socialtap.dev) with the request_id. |
### 502
502 Bad Gateway: 1 error code. Free: errors cost nothing.
| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_error` | 502 | Yes, later | The platform failed, or answered with something we could not read. | Retry with backoff. Failed requests are free. |
### 503
503 Unavailable: 2 error codes. Free: errors cost nothing.
| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_blocked` | 503 | Yes, later | The platform refused every attempt, our own retries included. | Retry later with backoff. Failed requests are free. |
| `overloaded` | 503 | Yes, later | SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged. | Retry after the seconds in the retry-after header. Failed requests are free. |
## Pagination
Items come in pages, **Pinterest's order for logged-out visitors: mostly the latest saved first, with a few pins it picks moved to the top**. To get the next page, send **the same request plus `cursor`** set to `page.next_cursor` from the previous response. Keep every other parameter the same (limit, max_age and fields may change); anything else that differs is rejected. When `page.has_more` is `false` the walk is over, and `page.end_reason` says why: only `end` means you have every item (the others say the platform or a page cap stopped the walk early).
- **Order**: Pinterest's order for logged-out visitors: mostly the latest saved first, with a few pins it picks moved to the top
- **Page size**: Up to 50 pins (the default; `limit` lowers it)
- **Cursor lifetime**: 24 hours; don't store cursors
- **Price**: Per page, 1 credit
### The `page` object
| Field | Type | Description |
| --- | --- | --- |
| `page.has_more` | `boolean` | True when another page exists; then next_cursor is set. An empty page with has_more true is not the end. |
| `page.next_cursor` | `string` or `null` | Pass as cursor, with the same other parameters, to get the next page; null at the end. |
| `page.next_cursor_expires_at` | `string` (date-time) or `null` | When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors. |
| `page.end_reason` | `string` or `null` | Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.
One of `end`, `platform_limit`, `max_pages` |
### Next page
cURL: next page:
```shell
curl -G 'https://socialtap.dev/v1/pinterest/board_pins' \
--data-urlencode 'url=https://www.pinterest.com/giphy/best-gifs/' \
--data-urlencode 'cursor=c1.EXAMPLE_CURSOR' \
-H "x-api-key: $SOCIALTAP_API_KEY"
```
- The price is per page: each successful page costs the same, whatever `limit` is and however many items it has. Empty pages are charged too (an empty page with `has_more: true` is not the end).
- A `limit` below 50 doesn't save credits: the next request serves the rest of the same platform page, which is fetched again and charged as a page each time, and items can shift between those requests if the platform changes the list. Omitting `limit` is the cheapest way to walk the list.
- Errors are free, including a rejected cursor.
- Pages served from the cache are free.
- An expired or altered cursor, or one sent with different parameters, fails with [`invalid_cursor`](https://socialtap.dev/docs/errors/index.md#invalid_cursor) (HTTP 400): Repeat the original request without cursor to start the list again.
[Pagination guide](https://socialtap.dev/docs/pagination/index.md)
## Pricing
From **1 credit** per page. Charged per successful page, whatever its number of items. Errors are free. The price depends on the source that produced the result, reported as `meta.source`.
| Source | Price per successful page | Per 1,000 pages |
| --- | --- | --- |
| Platform API `api` | 1 credit | $0.75–$1.97 |
**Balance, sources and what you were charged**
Your balance must be at least **1 credit** to start a request; with less, it is refused with [`insufficient_credits`](https://socialtap.dev/docs/errors/index.md#insufficient_credits) (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.
| meta.source | Source | What it means |
| --- | --- | --- |
| `api` | Platform API | The platform's public, logged-out API. |
`meta.credits_charged` and the `x-credits-charged` header show what you paid. [How credits work](https://socialtap.dev/docs/credits/index.md) · [Packs](https://socialtap.dev/pricing/index.md)
Endpoint ID `pinterest.board_pins` · operationId `pinterest.board_pins.list` · [Product overview](https://socialtap.dev/apis/pinterest/board_pins/index.md)
---
[HTML version](https://socialtap.dev/docs/reference/pinterest/board_pins/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)