What you get#
Onekey exposes Pinterest as 7 endpoints behind one API key: 5 endpoints return one record (data is an object) and 2 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for Pinterest also works for the rest of the social networks category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
board | Pinterest board: name, description, pin and follower counts. | id* | 1 | beta |
board_pins | Pins on a Pinterest board. | id* | 2 | beta |
pin | Pinterest pin oEmbed: title, pinner, image. | id* | 1 | stable may need a pack |
pin_details | Pinterest pin details via API v5: title, description, image, link. | id* | 2 | beta may need a pack |
profile | Pinterest profile card: name, tagline, image. | user* | 1 | stable may need a pack |
search_pins | Search Pinterest pins by keyword (Standard access). | q*, cursor | 2 | beta may need a pack |
url_stats | How many times a web page URL has been saved to Pinterest. | url* | 1 | stable |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls pinterest.pin (1 credit, stable). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/pinterest/pin?id=99360735500167749" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Pinterest, with the same names as on every other platform. The count is how many of its 7 mapped endpoints return the field; a field the source lacks is null, never missing. 1 platform-specific field (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
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 |
The full schema is in Unified schema.
Pricing#
Pinterest calls cost 1 to 2 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.