# Pinterest Topic API

Pinterest

Returns a Pinterest ideas page (a topic) from its link or its words. You get its name, Pinterest's summary on category pages, and the related searches it suggests. You also get how many searches Pinterest counts for it, its followers, the broader topics above it, the narrower ones it offers, trending searches and the boards it shows. Words with no ideas page return not_found.

GET `/v1/pinterest/topic`

## Example

cURL:

```shell
curl -G 'https://socialtap.dev/v1/pinterest/topic' \
  --data-urlencode 'url=https://www.pinterest.com/ideas/star-nail-designs/961385779129/' \
  -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.topic.get({ url: "https://www.pinterest.com/ideas/star-nail-designs/961385779129/" });
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/ideas/star-nail-designs/961385779129/",
});
const res = await fetch(`https://socialtap.dev/v1/pinterest/topic?${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, meta } = body;
console.log(data, meta.credits_charged);
```

Python (requests):

```python
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/pinterest/topic",
    params={"url": "https://www.pinterest.com/ideas/star-nail-designs/961385779129/"},
    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, meta = body["data"], 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/ideas/star-nail-designs/961385779129/")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/pinterest/topic?"+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"`
		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": [],
    "description": null,
    "id": "961385779129",
    "name": "Star Nail Designs",
    "platform": "pinterest",
    "platform_specific": {
      "pinterest": {
        "cover_image_url": "https://i.pinimg.com/474x/37/81/19/378119e7f9eb391d50b55b175a04b870.jpg",
        "follower_count": null,
        "is_category": false,
        "is_interest": false,
        "parent_topics": [
          {
            "id": "935541271955",
            "name": "Beauty",
            "url": "https://www.pinterest.com/ideas/beauty/935541271955/"
          },
          {
            "id": "956143059915",
            "name": "Nails",
            "url": "https://www.pinterest.com/ideas/nails/956143059915/"
          },
          {
            "id": "944365099264",
            "name": "Nail Art",
            "url": "https://www.pinterest.com/ideas/nail-art/944365099264/"
          }
        ],
        "refinements": [
          {
            "id": "920700149322",
            "label": "Blue",
            "name": "Blue Star Nail Designs",
            "url": "https://www.pinterest.com/ideas/blue-star-nail-designs/920700149322/"
          },
          {
            "id": "907171573460",
            "label": "Moon",
            "name": "Moon and Star Nail Designs",
            "url": "https://www.pinterest.com/ideas/moon-and-star-nail-designs/907171573460/"
          },
          {
            "id": "945556081760",
            "label": "Black",
            "name": "Black Star Nail Designs",
            "url": "https://www.pinterest.com/ideas/black-star-nail-designs/945556081760/"
          }
        ],
        "related_boards": [
          {
            "id": "1023513521504626611",
            "title": "Nails",
            "url": "https://www.pinterest.com/e18b0cb235799f1d10ec6bbc1873d1/nails/"
          },
          {
            "id": "634866947410870831",
            "title": "Nails",
            "url": "https://www.pinterest.com/ngerceski/nails/"
          },
          {
            "id": "396879854601657012",
            "title": "nails",
            "url": "https://www.pinterest.com/isabellagabriellagordon/nails/"
          }
        ],
        "related_topics": [
          {
            "id": "949217630033",
            "name": "Stars Nails Short",
            "url": "https://www.pinterest.com/ideas/stars-nails-short/949217630033/"
          },
          {
            "id": "960496442969",
            "name": "Starry Nail Designs",
            "url": "https://www.pinterest.com/ideas/starry-nail-designs/960496442969/"
          },
          {
            "id": "945281507083",
            "name": "Stars Nail Art",
            "url": "https://www.pinterest.com/ideas/stars-nail-art/945281507083/"
          }
        ],
        "search_count": 66701,
        "trending_searches": [],
        "updated_at": "2026-11-08T19:12:22Z"
      }
    },
    "related_searches": [
      "Blue Star Nail Designs",
      "Moon and Star Nail Designs",
      "Black Star Nail Designs"
    ],
    "unknown_fields": [],
    "url": "https://www.pinterest.com/ideas/star-nail-designs/961385779129/"
  },
  "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": "topic",
      "id": "961385779129",
      "url": "https://www.pinterest.com/ideas/star-nail-designs/961385779129/"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}
```

Long arrays and strings are shortened for display; real responses are complete.

> [!NOTE]
>
> **Good to know**
>
> - A topic's pins are Pinterest's search results for its words: send the topic's name to the Pinterest Search API.
> - Case and hyphens are ignored, so Star Nail Designs and star-nail-designs are one topic.
> - Pinterest knows many search phrases without an ideas page. Those return not_found, as the page itself does.
> - platform_specific.pinterest.search_count is the number Pinterest's page data states. Pinterest doesn't say over which period it counts.
> - follower_count is set for interests, the topics accounts can follow (is_interest true), and null for pages made for a search phrase.
> - description is set on category pages (is_category true). Pinterest writes no summary for most other topics, so it is null there.

## 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`<br>max 2,048 chars | The topic: its ideas page link (pinterest.com/ideas/star-nail-designs/961385779129/, also on a country's site such as uk.pinterest.com or pinterest.co.uk) or its words (star nail designs). Words are matched as Pinterest matches them: case and hyphens are ignored. | `https://www.pinterest.com/ideas/star-nail-designs/961385779129/` |

`url` takes Pinterest topic 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)).

**Parameters every endpoint accepts**

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `max_age` optional | `integer`<br>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, meta}`. `data` is a [topic](https://socialtap.dev/resources/topic/index.md) object; `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 (instagram, tiktok, …). |
| `data.id` | `string` | Platform-native topic ID; on platforms whose topic pages are keyed by their words (Instagram), the words lowercased and joined by hyphens (harry-potter). |
| `data.name` | `string` or `null` | The topic's title as its page shows it (Harry Potter); null when the source does not show it. |
| `data.url` | `string` (uri) | Canonical topic page URL. |
| `data.description` | `string` or `null` | The platform's summary of the topic, as plain text with paragraph breaks (on Instagram, superscript markers ¹, ² cite platform_specific.instagram.source_urls by position). Null when the page has none. |
| `data.related_searches` | `string[]` | Related searches the platform suggests for the topic, in its order; each is a topic of its own (pass it as url). \[\] when none. |
| `data.platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\<platform>); each null when unknown. |
| `data.platform_specific.pinterest` | `object` or `null` | A Pinterest topic's own fields. |
| `data.platform_specific.pinterest.search_count` | `integer` or `null` | How many searches Pinterest counts for the topic's words, as its ideas page data states it (Pinterest doesn't say over which period); null when the source does not state it. |
| `data.platform_specific.pinterest.follower_count` | `integer` or `null` | Accounts following the topic on Pinterest; null for a topic that is no interest accounts can follow (is_interest false). |
| `data.platform_specific.pinterest.is_category` | `boolean` or `null` | The topic is one of Pinterest's top categories (Travel, Beauty, …), as its ideas page lists them. |
| `data.platform_specific.pinterest.is_interest` | `boolean` or `null` | The topic is one of Pinterest's interests, which pins are filed under and accounts can follow; false for a page made for a search phrase. |
| `data.platform_specific.pinterest.updated_at` | `string` (date-time) or `null` | When Pinterest last updated the topic's page data (its counts and related topics). |
| `data.platform_specific.pinterest.parent_topics` | `object[]` | The broader topics this one sits under, broadest first, as the page's breadcrumbs show them; \[\] for a top category. |
| `data.platform_specific.pinterest.parent_topics[].id` | `string` | The topic's ID. |
| `data.platform_specific.pinterest.parent_topics[].name` | `string` or `null` | The topic's name as the page shows it. |
| `data.platform_specific.pinterest.parent_topics[].url` | `string` (uri) | The topic's ideas page. |
| `data.platform_specific.pinterest.refinements` | `object[]` | The narrower topics the page offers as buttons above its pins, in its order; \[\] when none. |
| `data.platform_specific.pinterest.refinements[].label` | `string` or `null` | The button's text (Blue for Blue Star Nail Designs). |
| `data.platform_specific.pinterest.refinements[].id` | `string` | The narrower topic's ID. |
| `data.platform_specific.pinterest.refinements[].name` | `string` or `null` | The narrower topic's full name. |
| `data.platform_specific.pinterest.refinements[].url` | `string` (uri) | The narrower topic's ideas page. |
| `data.platform_specific.pinterest.related_topics` | `object[]` | Related topics the page links to, in its order; \[\] when none. |
| `data.platform_specific.pinterest.related_topics[].id` | `string` | The topic's ID. |
| `data.platform_specific.pinterest.related_topics[].name` | `string` or `null` | The topic's name as the page shows it. |
| `data.platform_specific.pinterest.related_topics[].url` | `string` (uri) | The topic's ideas page. |
| `data.platform_specific.pinterest.trending_searches` | `string[]` | Searches Pinterest shows as trending for the topic, in its order; \[\] when none. |
| `data.platform_specific.pinterest.related_boards` | `object[]` | Boards Pinterest shows on the topic's page, in its order; \[\] when none. |
| `data.platform_specific.pinterest.related_boards[].id` | `string` or `null` | The board's ID. |
| `data.platform_specific.pinterest.related_boards[].title` | `string` or `null` | The board's name. |
| `data.platform_specific.pinterest.related_boards[].url` | `string` (uri) or `null` | The board's link. |
| `data.platform_specific.pinterest.cover_image_url` | `string` (uri) or `null` | The picture Pinterest shows for the topic when its page is shared (one of its pins' pictures, so it changes over time); null when the page has none. |
| `data.approximate_fields` | `string[]` | JSON paths of values rounded by the platform or parsed from display text ("189M reels": platform_specific.instagram.post_count). \[\] 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 is item-level: the request was fine, the item can't be returned.

### 400

400 Bad Request: 1 error code. 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. |

### 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: 1 error code. 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. |

### 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. |

## Pricing

From **1 credit** per request. Charged only for successful requests. Errors are free. The price depends on the source that produced the result, reported as `meta.source`; sources are tried cheapest first: Platform API → Public page.

| Source | Price per successful request | Per 1,000 requests |
| --- | --- | --- |
| Any source | 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. |
| `page` | Public page | Data embedded in the platform's public web page. |

`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.topic` · operationId `pinterest.topic.get` · [Product overview](https://socialtap.dev/apis/pinterest/topic/index.md)

---

[HTML version](https://socialtap.dev/docs/reference/pinterest/topic/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)