Get board metadata

Try in Playground

Retrieve a public board’s details without its pins: name, description, owner, pin, follower, section and collaborator counts, cover images, category and SEO attributes. Source field names and nulls are preserved.

GET/v1/pinterest/board/metadatax-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

urlstringrequiredquery

Required HTTPS pinterest.com or www.pinterest.com board URL (/<handle>/<slug>/). Board slugs accept ASCII letters, digits, underscores, hyphens and percent-escaped punctuation such as %2B. No credentials, explicit ports, short links, regional domains or encoded path segments. Tracking query parameters and fragments are removed.

max 2048 chars

Examplehttps://www.pinterest.com/example/recipes/

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 board URL.

absolute HTTPS URL

fetchedAtstring

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

Identifies the public resource used for the board.

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

Public board record with id, name, canonical url and description, plus available source attributes such as owner, pin_count, follower_count, section_count, collaborator_count, image_cover_url, images, category and seo_description.

board.idstring

Always included.

board.namestring

Always included.

board.urlstring

Always included.

absolute HTTPS URL

board.descriptionstringnullable

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/board/metadata?url=https%3A%2F%2Fwww.pinterest.com%2Fexample%2Frecipes%2F" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/pinterest/board/metadata?url=https%3A%2F%2Fwww.pinterest.com%2Fexample%2Frecipes%2F",
  {
    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/board/metadata?url=https%3A%2F%2Fwww.pinterest.com%2Fexample%2Frecipes%2F",
  {
    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/board/metadata",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://www.pinterest.com/example/recipes/"
    },
    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/board/metadata?url=https%3A%2F%2Fwww.pinterest.com%2Fexample%2Frecipes%2F", 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/board/metadata?url=https%3A%2F%2Fwww.pinterest.com%2Fexample%2Frecipes%2F"))
            .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/example/recipes/",
  "board": {
    "id": "777",
    "type": "board",
    "name": "Synthetic recipes",
    "description": "",
    "url": "https://www.pinterest.com/example/recipes/",
    "owner": {
      "id": "456",
      "username": "example"
    },
    "privacy": "public",
    "pin_count": 2,
    "follower_count": 0,
    "image_cover_hd_url": null,
    "created_at": null,
    "section_count": 0,
    "collaborator_count": 0,
    "category": null
  }
}

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."
  }
}