pinterest

Get Pinterest Trends for a country

Returns what people in one market are searching for on Pinterest, with no keyword in: the Pinterest Trends list for a country and a table. type picks the table: growing (terms rising fastest, the default), seasonal (terms that come back at this time every year), top_monthly or top_yearly (the most searched). Each item has rank (1 is the top), term, country, market (the list Pinterest reads it from: Ireland reads GB+IE, Australia and New Zealand read AU+NZ, Great Britain alone has its own list), type, search_index (relative search volume, 0 to 100 within the answer), weekly_change, monthly_change and yearly_change (as Pinterest reports them, a fraction where 0.3 is +30%; Pinterest reports 100.01 for a term that was near zero before), seasonality (0 to 1), url (the term's Pinterest Trends page) and as_of (the date Pinterest's weekly data is as of; null on the rare call served while Pinterest throttles the primary route). Narrow with include and exclude, comma-separated keywords. Filters that match nothing, and a list Pinterest has empty, return 404 at 0 credits. Flat 10 credits whatever the depth. Exact repeats within 6 hours are served from cache at 0 credits.

get/pinterest/trends

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/pinterest/trends
  • Auth: API key in header x-api-key

Query parameters

country'AR' | 'AU' | 'BR' | 'CA' | 'CO' | 'DE' | 'EG' | 'ES' | 'FR' | 'GB' | 'ID' | 'IE' | 'IN' | 'IT' | 'KR' | 'MX' | 'MY' | 'NZ' | 'PH' | 'SA' | 'TH' | 'TR' | 'US'

ISO country code, in any case: AR, AU, BR, CA, CO, DE, EG, ES, FR, GB, ID, IE, IN, IT, KR, MX, MY, NZ, PH, SA, TH, TR, US. Pinterest publishes no list for other countries, and one of them is a free 400. IE reads Pinterest's GB+IE list and AU and NZ read AU+NZ; GB alone has its own list. Defaults to US.

type'growing' | 'seasonal' | 'top_monthly' | 'top_yearly'

Which Pinterest Trends table: growing (the default), seasonal, top_monthly or top_yearly.

limitinteger

How many terms to return, from the top, 1 to 50. Defaults to 25. The price is the same at any depth.

includestring

Keep only terms containing one of these keywords, comma-separated (up to 10, e.g. nails,wedding).

excludestring

Drop terms containing any of these keywords, comma-separated (up to 10, e.g. fall).

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "pinterest",
  "endpoint": "/v1/pinterest/trends",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  },
  "pagination": {
    "next_cursor": "sc.eyJ2IjoyLCJjIjoiMiIsInAiOiJwYWdlIn0",
    "has_more": true,
    "page_size": 30,
    "stopped_at": "known_id"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.