Pinterest board API

Get a board and a page of its pins

curl --request POST \
  --url https://api.stophy.dev/v1/pinterest/board \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "boardUrl": "<string>",
  "cursor": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({boardUrl: '<string>', cursor: '<string>'})
};

fetch('https://api.stophy.dev/v1/pinterest/board', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/pinterest/board"

payload = {
    "boardUrl": "<string>",
    "cursor": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "boardUrl": "<string>",
    "results": [
      {
        "pinUrl": "<string>",
        "isPromoted": true,
        "pinId": "<string>",
        "title": "<string>",
        "text": "<string>",
        "altText": "<string>",
        "linkUrl": "<string>",
        "domain": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z",
        "imageUrl": "<string>",
        "imageWidth": 0,
        "imageHeight": 0,
        "dominantColor": "<string>",
        "videoUrl": "<string>",
        "videoDurationSeconds": 123,
        "saves": 0,
        "reposts": 0,
        "comments": 0,
        "reactions": 0,
        "authorId": "<string>",
        "authorUsername": "<string>",
        "authorName": "<string>",
        "authorUrl": "<string>",
        "authorAvatarUrl": "<string>",
        "authorIsVerified": true,
        "boardId": "<string>",
        "boardName": "<string>",
        "boardUrl": "<string>"
      }
    ],
    "boardId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "category": "<string>",
    "pins": 0,
    "followers": 0,
    "sections": 0,
    "thumbnailUrl": "<string>",
    "authorId": "<string>",
    "authorUsername": "<string>",
    "authorName": "<string>",
    "authorUrl": "<string>",
    "authorAvatarUrl": "<string>",
    "authorIsVerified": true,
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

board

Get a board and a page of its pins

curl --request POST \
  --url https://api.stophy.dev/v1/pinterest/board \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "boardUrl": "<string>",
  "cursor": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({boardUrl: '<string>', cursor: '<string>'})
};

fetch('https://api.stophy.dev/v1/pinterest/board', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/pinterest/board"

payload = {
    "boardUrl": "<string>",
    "cursor": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "boardUrl": "<string>",
    "results": [
      {
        "pinUrl": "<string>",
        "isPromoted": true,
        "pinId": "<string>",
        "title": "<string>",
        "text": "<string>",
        "altText": "<string>",
        "linkUrl": "<string>",
        "domain": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z",
        "imageUrl": "<string>",
        "imageWidth": 0,
        "imageHeight": 0,
        "dominantColor": "<string>",
        "videoUrl": "<string>",
        "videoDurationSeconds": 123,
        "saves": 0,
        "reposts": 0,
        "comments": 0,
        "reactions": 0,
        "authorId": "<string>",
        "authorUsername": "<string>",
        "authorName": "<string>",
        "authorUrl": "<string>",
        "authorAvatarUrl": "<string>",
        "authorIsVerified": true,
        "boardId": "<string>",
        "boardName": "<string>",
        "boardUrl": "<string>"
      }
    ],
    "boardId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "category": "<string>",
    "pins": 0,
    "followers": 0,
    "sections": 0,
    "thumbnailUrl": "<string>",
    "authorId": "<string>",
    "authorUsername": "<string>",
    "authorName": "<string>",
    "authorUrl": "<string>",
    "authorAvatarUrl": "<string>",
    "authorIsVerified": true,
    "cursor": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Returns a board and a page of its pins.

Request

boardUrl is required.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.pinterest.board({ boardUrl: "https://www.pinterest.com/marthastewart/kitchen-ideas/" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.pinterest.board(board_url="https://www.pinterest.com/marthastewart/kitchen-ideas/")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/pinterest/board \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"boardUrl":"https://www.pinterest.com/marthastewart/kitchen-ideas/"}'

stophy pinterest board https://www.pinterest.com/marthastewart/kitchen-ideas/

Response

If successful, the response body contains the standard envelope. data contains the board’s details, and results lists a page of its pins. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "boardId": "49328627107623443",
    "boardUrl": "https://www.pinterest.com/herbacinusa/fresh-fall-ideas/",
    "name": "Fresh Fall Ideas",
    "description": "Ideas for beauty, design, relaxation, and home decor",
    "category": "design",
    "pins": 301,
    "followers": 6163,
    "sections": 0,
    "thumbnailUrl": "https://i.pinimg.com/custom_covers/200x150/49328627107623443_1411083601.jpg",
    "authorId": "49328695826977854",
    "authorUsername": "herbacinusa",
    "authorName": "Herbacin",
    "authorUrl": "https://www.pinterest.com/herbacinusa/",
    "authorAvatarUrl": "https://i.pinimg.com/280x280_RS/54/37/a0/5437a0983226a913dc32d0beb98c1066.jpg",
    "results": [
      {
        "pinId": "49328558401525132",
        "pinUrl": "https://www.pinterest.com/pin/49328558401525132/",
        "text": "Fall Flower Arrangements | Martha Stewart Living - Gather armfuls of vivid leaves and berries from the garden before…",
        "altText": "a vase filled with red and purple flowers on top of a wooden table next to books",
        "linkUrl": "http://martha.ms/64958xCG7",
        "domain": "martha.ms",
        "publishedAt": "2017-08-26T19:52:00.000Z",
        "imageUrl": "https://i.pinimg.com/originals/cd/cb/6b/cdcb6ba072222d490f05c11a98ead99e.jpg",
        "imageWidth": 1040,
        "imageHeight": 1300,
        "dominantColor": "#876f75",
        "saves": 100,
        "reposts": 9,
        "isPromoted": false,
        "authorId": "32088353503445352",
        "authorUsername": "marthastewart",
        "authorName": "Martha Stewart",
        "authorUrl": "https://www.pinterest.com/marthastewart/",
        "authorAvatarUrl": "https://i.pinimg.com/140x140_RS/c8/11/4c/c8114c783347e27daef00e5d4a6ac4f3.jpg",
        "authorIsVerified": true,
        "boardId": "49328627107623443",
        "boardName": "Fresh Fall Ideas",
        "boardUrl": "https://www.pinterest.com/herbacinusa/fresh-fall-ideas/"
      }
    ],
    "cursor": "Y2JZakk0ZVU1WWR6Qk9SRWswVDBSak5VNUVVWHBQUkdkNlRsUm5NMHRyWkZKVVEzQTRUV3ByZVZsWFZUVk5SR2hwV20xWk0xbFhVVE5PZW14cVRYcEdiRTF…"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`cursor`	string	The pagination token. Pass it as `cursor` to retrieve the next page. Omitted on the last page.
`publishedAt`	string (ISO 8601)	The publication time, in UTC.

For every field, see the response schema on this page.

Optional parameters

Parameter	Type	Description
`cursor`	string	The pagination token from the previous response.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

Results are paginated. To retrieve the next page, pass the value of data.cursor as cursor in a subsequent request. A response that omits cursor is the last page.

Pinterest pin: Accepts pinUrl. Returns a pin’s details.
Pinterest profile: Accepts userUrl. Returns a profile and a page of its pins.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

boardUrl

string

required

Link to the Pinterest board, like https://www.pinterest.com/marthastewart/kitchen-ideas/.

cursor

string

The cursor from the previous response. Send it as is.

Minimum string length: 1

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

Pinterest board API

Request

Response

Optional parameters

Billing

Authorizations

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods