# Pinterest on Onekey

> 7 endpoints for Pinterest (3 stable, 4 beta), 1 to 2 credits each. Category: Social networks. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.
Access: 4 of 7 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

Page: https://onekey.dev/platforms/pinterest
Reference (Markdown): https://onekey.dev/docs/api/pinterest.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 7 mapped Pinterest endpoints return each:

- `author.username` (string): 4
- `content.text` (string): 4
- `content.title` (string): 4
- `content.url` (URL): 4
- `media.thumbnailUrl` (URL): 4
- `content.createdAt` (ISO 8601 date): 3
- `content.id` (string): 3
- `author.displayName` (string): 2
- `author.url` (URL): 2
- `author.avatarUrl` (URL): 1
- `engagement.bookmarks` (integer): 1
- `entity.description` (string): 1
- `entity.id` (string): 1
- `entity.name` (string): 1
- `entity.stats.followers` (integer): 1
- plus 1 platform-specific field under `ext.`

## Endpoints

### pinterest.board

Pinterest board: name, description, pin and follower counts.
- Price: 1 credit per fresh call. Status: beta. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/pinterest/board?id=549755885175` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Pinterest board id
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.stats.followers`, `author.username`, `ext.pins`
- Reference: https://onekey.dev/docs/api/pinterest/board.md

### pinterest.board_pins

Pins on a Pinterest board.
- Price: 2 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/pinterest/board_pins?id=549755885175` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Pinterest board id
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `content.url`, `media.thumbnailUrl`, `author.username`
- Reference: https://onekey.dev/docs/api/pinterest/board_pins.md

### pinterest.pin

Pinterest pin oEmbed: title, pinner, image.
- Price: 1 credit per fresh call. Status: stable. Access: may need a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/pinterest/pin?id=99360735500167749` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Pinterest pin id
- Fields returned: `content.title`, `author.displayName`, `author.url`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/pinterest/pin.md

### pinterest.pin_details

Pinterest pin details via API v5: title, description, image, link.
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/pinterest/pin_details?id=99360735500167749` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Pinterest pin id
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `content.url`, `media.thumbnailUrl`, `author.username`
- Reference: https://onekey.dev/docs/api/pinterest/pin_details.md

### pinterest.profile

Pinterest profile card: name, tagline, image.
- Price: 1 credit per fresh call. Status: stable. Access: may need a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/pinterest/profile?user=pinterest` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `user` (string, required): Pinterest username
- Fields returned: `author.displayName`, `content.text`, `author.avatarUrl`, `author.url`
- Reference: https://onekey.dev/docs/api/pinterest/profile.md

### pinterest.search_pins

Search Pinterest pins by keyword (Standard access).
- Price: 2 credits per fresh call. Status: beta. Access: may need a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/pinterest/search_pins?q=recipes` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search keyword
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `content.url`, `media.thumbnailUrl`, `author.username`
- Reference: https://onekey.dev/docs/api/pinterest/search_pins.md

### pinterest.url_stats

How many times a web page URL has been saved to Pinterest.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/pinterest/url_stats?url=https%3A%2F%2Fwww.nytimes.com%2F` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `url` (string, required): Absolute http(s) page URL to count saves for (exact variant)
- Fields returned: `content.url`, `engagement.bookmarks`
- Reference: https://onekey.dev/docs/api/pinterest/url_stats.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/pinterest/pin?id=99360735500167749" \
  -H "x-api-key: YOUR_API_KEY"
```