Get search suggestions

Try in Playground

Autocomplete a partial keyword with Pinterest’s own search suggestions: suggested queries with their search links, plus suggested accounts where Pinterest includes them. Suggestions keep Pinterest’s order and source fields.

GET/v1/pinterest/search/suggestionsx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

querystringrequiredquery

Required partial keyword, 1–100 characters after trimming.

min 1 chars · max 100 chars

Examplesynthetic

Response fields

successboolean

True when usable supported data was retrieved.

statusenum

success, partial, failed, or challenged. Partial results carry coverage warnings.

one of: success, partial

requestIdstring

Opaque operation identifier for correlation.

sourceUrlstring

Canonical public source page. This field can contain the requested search query.

absolute HTTPS URL

fetchedAtstring

UTC retrieval time. Every call makes fresh upstream requests; Pinterest may serve its own cached data.

Completeness of the returned suggestions. Warnings: restricted_records, malformed_records and record_limit.

coverage.sourceenum

Always included.

one of: public_resource, public_page, public_graphql, public_widget

coverage.completeboolean

Always included.

coverage.warningsenum[]

Always included.

Upstream attempts, total decoded response bytes, and elapsed milliseconds.

accounting.upstreamRequestsinteger

Always included.

0 – 11

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

Ordered suggestion records. Each has type (for example query or user) and label; query suggestions carry query and url, account suggestions carry username and profile image fields.

up to 100 items

suggestions.typestring

Always included.

min 1 chars

suggestions.labelstring

Always included.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
200	`partial`	Some records were restricted, malformed or capped, or pagination was unavailable. Inspect coverage.warnings.
400	`invalid_request`	Missing, duplicate, unsupported or invalid parameters or URL.
401	`unauthorized`	Missing or invalid service key.
403	`restricted_page`	Access-gated pin, board or profile, or no usable public records.
404	`not_found`	Pinterest explicitly reported a missing resource, or the route is unknown.
429	`upstream_rate_limited`	Pinterest rate limited retrieval.
502	`upstream_challenged`	Pinterest challenged the request.
502	`unsupported_page` `upstream_error`	Incomplete, changed or mismatched source data, or retrieval failure.
502	`response_too_large` `payload_too_complex` `request_limit`	A byte, parsing or request bound was exceeded.
502	`unsafe_redirect`	Upstream redirected; redirects are not followed.
503	`busy`	All worker slots are occupied.
504	`timeout`	The shared deadline expired.

Code example

curl "https://api.scrapeatlas.com/v1/pinterest/search/suggestions?query=synthetic" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/pinterest/search/suggestions?query=synthetic",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/pinterest/search/suggestions?query=synthetic",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Pinterest request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/pinterest/search/suggestions",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "query": "synthetic"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/pinterest/search/suggestions?query=synthetic", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/pinterest/search/suggestions?query=synthetic"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "success": true,
  "status": "success",
  "requestId": "synthetic-pinterest-request",
  "fetchedAt": "2026-09-10T00:00:00.000Z",
  "coverage": {
    "source": "public_resource",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 1200,
    "durationMs": 120
  },
  "sourceUrl": "https://www.pinterest.com/search/pins/?q=synthetic",
  "suggestions": [
    {
      "type": "query",
      "label": "synthetic recipes",
      "query": "synthetic recipes",
      "id": "ac_synthetic",
      "url": "/search/pins/?q=synthetic+recipes&rs=ac",
      "resultIndex": 0
    },
    {
      "type": "user",
      "label": "Synthetic Example",
      "username": "example",
      "id": "456",
      "url": "/example/"
    }
  ]
}

Missing, duplicate, unsupported or invalid parameters or URL.

{
  "success": false,
  "status": "failed",
  "requestId": "string",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}