Get pin metadata

Try in Playground

Retrieve a public pin’s metadata, including its description, images, media, destination, author, board and engagement fields. The pin object preserves Pinterest’s source field names and nested attributes.

GET/v1/pinterest/pin/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 Pinterest pin URL. The response includes its canonical public URL.

max 2048 chars

Examplehttps://www.pinterest.com/pin/123456789/

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.

Identifies the public resource used for the metadata and the completeness of its returned source fields.

coverage.sourceenum

Always included.

one of: public_resource, public_page

coverage.completeboolean

Always included.

coverage.warningsenum[]

Always included.

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

accounting.upstreamRequestsinteger

Always included.

0 – 3

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

Public pin metadata with id, canonical url, description, images and pinner, plus available source attributes such as link, videos, board, created_at, repin_count, share_count, comment_count and reaction_counts. Source null values and nested fields are preserved.

pin.idstring

Always included.

pin.descriptionstringnullable

Always included.

pin.imagesobject

Always included.

pin.pinnerobjectnullable

Always included.

pin.urlstring

Always included.

absolute HTTPS URL

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

const response = await fetch(
  "https://api.scrapeatlas.com/v1/pinterest/pin/metadata?url=https%3A%2F%2Fwww.pinterest.com%2Fpin%2F123456789%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/pin/metadata?url=https%3A%2F%2Fwww.pinterest.com%2Fpin%2F123456789%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/pin/metadata",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://www.pinterest.com/pin/123456789/"
    },
    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/pin/metadata?url=https%3A%2F%2Fwww.pinterest.com%2Fpin%2F123456789%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/pin/metadata?url=https%3A%2F%2Fwww.pinterest.com%2Fpin%2F123456789%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/pin/123456789/",
  "pin": {
    "id": "123456789",
    "type": "pin",
    "title": "Synthetic recipe",
    "description": "",
    "created_at": "Thu, 10 Sep 2026 00:00:00 +0000",
    "images": {
      "orig": {
        "url": "https://i.pinimg.com/synthetic.jpg",
        "width": 800,
        "height": 600
      }
    },
    "pinner": {
      "id": "456",
      "username": "example",
      "follower_count": 0
    },
    "board": {
      "id": "777",
      "url": "/example/recipes/"
    },
    "videos": null,
    "sourceExtension": {
      "unknown": null
    },
    "url": "https://www.pinterest.com/pin/123456789/",
    "repin_count": 12,
    "share_count": 0,
    "reaction_counts": {
      "1": 2
    },
    "comment_count": 1
  }
}

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