Pinterest profile API

Get a profile and a page of its pins

curl --request POST \
  --url https://api.stophy.dev/v1/pinterest/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "marthastewart"
}
'

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

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

import requests

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

payload = { "username": "marthastewart" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "userUrl": "<string>",
    "isVerified": true,
    "isPrivate": true,
    "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>"
      }
    ],
    "userId": "<string>",
    "username": "<string>",
    "name": "<string>",
    "avatarUrl": "<string>",
    "followers": 0,
    "bio": "<string>",
    "website": "<string>",
    "following": 0,
    "pins": 0,
    "boards": 0,
    "createdAt": "2023-11-07T05:31:56Z",
    "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

profile

Get a profile and a page of its pins

curl --request POST \
  --url https://api.stophy.dev/v1/pinterest/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "marthastewart"
}
'

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

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

import requests

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

payload = { "username": "marthastewart" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "success": true,
  "data": {
    "userUrl": "<string>",
    "isVerified": true,
    "isPrivate": true,
    "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>"
      }
    ],
    "userId": "<string>",
    "username": "<string>",
    "name": "<string>",
    "avatarUrl": "<string>",
    "followers": 0,
    "bio": "<string>",
    "website": "<string>",
    "following": 0,
    "pins": 0,
    "boards": 0,
    "createdAt": "2023-11-07T05:31:56Z",
    "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 profile and a page of its pins. The user is identified by its URL or username.

Request

Exactly one of userUrl or username is required. A request that sets both, or none, fails with invalidRequest.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.pinterest.profile({ username: "marthastewart" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.pinterest.profile(username="marthastewart")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/pinterest/profile \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"username":"marthastewart"}'

stophy pinterest profile --username marthastewart

Response

If successful, the response body contains the standard envelope. data contains the profile’s bio and counts, 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": {
    "userId": "32088353503445352",
    "username": "marthastewart",
    "userUrl": "https://www.pinterest.com/marthastewart/",
    "name": "Martha Stewart",
    "avatarUrl": "https://i.pinimg.com/280x280_RS/c8/11/4c/c8114c783347e27daef00e5d4a6ac4f3.jpg",
    "followers": 1868060,
    "bio": "Daily recipes, crafts, and inspiration from Martha Stewart.",
    "website": "http://marthastewart.com",
    "following": 322,
    "pins": 105458,
    "boards": 174,
    "isVerified": true,
    "isPrivate": false,
    "createdAt": "2011-09-15T07:56:17.000Z",
    "results": [
      {
        "pinId": "49328558414951308",
        "pinUrl": "https://www.pinterest.com/pin/49328558414951308/",
        "title": "Do Mums Come Back Every Year? How to Keep Them Blooming Each Fall",
        "text": "Yes, perennial mums will come back every year—if you care for them the right way. Here, gardening experts provide some…",
        "altText": "many pink flowers are growing in the garden",
        "linkUrl": "https://www.marthastewart.com/do-mums-come-back-every-year-12159330?utm_campaign=marthastewart_6ac401c97b1ba300014d59a4…",
        "domain": "marthastewart.com",
        "publishedAt": "2026-10-05T20:00:09.000Z",
        "imageUrl": "https://i.pinimg.com/originals/4f/fa/68/4ffa68ab16dd1768bcb1879e149da1a9.jpg",
        "imageWidth": 1000,
        "imageHeight": 667,
        "dominantColor": "#552626",
        "saves": 1,
        "reposts": 0,
        "comments": 0,
        "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": "Pz8zMjA4ODIxNjA5OTcwODU1NToxNzkwOTc0ODEyfDEwNDU2ODY4NTYyODM4NzEqR1FMKnxmZjliM2VkOGEzYzE4MjQ0NDAxZjA5ODdjMTg3OWIwYTAyYzZ…"
  },
  "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.
`createdAt`	string (ISO 8601)	The creation 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 board: Accepts boardUrl. Returns a board 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

userUrl

string

Link to the Pinterest profile, like https://www.pinterest.com/marthastewart/. Send this or username.

username

string

Pinterest profile username, like marthastewart. Send this or userUrl.

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 profile 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