Get a Pillar page

Try in Playground

Accepts a public Pillar profile URL. Returns profile fields, links, and products at the top level. Outbound URLs are returned as data and never visited.

GET/v1/pillarx-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. An HTTPS pillar.io/<username> URL. www, case, tracking parameters, and fragments are canonicalized.

max 2048 chars · absolute HTTPS URL

Examplehttps://pillar.io/example

Response fields

idstring

Published creator UUID, checked against the requested public shop handle and record ownership.

first_namestringnullable

Structured account first name from Pillar’s public-client query; upstream nulls are preserved.

last_namestringnullable

Structured account last name from Pillar’s public-client query; upstream nulls are preserved.

email_primarystringnullable

Primary account email from Pillar’s public-client account query. This may differ from the displayed social email; explicit upstream nulls are preserved.

locationstringnullable

Published location text; unknown or unavailable values are null.

emailstringnullableoptional

Public EMAIL social value. Other social channels appear as lowercase top-level keys, such as instagram, tiktok, youtube, github, and threads. Source empty strings and nulls are preserved.

Ordered public link records: id, type, title, url, clicks, and order. type and title are the trimmed, lowercase source tagline. Duplicates and source array order are preserved; no sorting by order is applied.

up to 500 items

links.idstring

Always included.

min 1 chars

links.typestringnullable

Always included.

links.titlestringnullable

Always included.

links.urlstringnullable

Always included.

links.clicksintegernullable

Always included.

links.ordernumbernullable

Always included.

Featured product records: id, title, price, url, name, description, and image. title and name use the published product name. Prices keep source values; no currency conversion is performed. Descriptions may contain markup and are not executed.

up to 500 items

products.idstring

Always included.

min 1 chars

products.titlestringnullable

Always included.

products.pricenumbernullable

Always included.

products.urlstringnullable

Always included.

products.namestringnullable

Always included.

products.descriptionstringnullable

Always included.

products.imagestringnullable

Always included.

requestIdstring

Identifier for correlating the request with operational logs.

Upstream request count, decoded JSON bytes read, and duration. Rejected error bodies are discarded; these are operational counts, not billing totals.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

True when usable data is returned, including partial results.

statusenum

success or partial. Failures use failed or challenged and include a failure object.

one of: success, partial

sourceUrlstring

Canonical public profile URL.

absolute HTTPS URL

fetchedAtstring

UTC timestamp of retrieval.

Coverage of supported public profile fields, links, and featured products. Warnings describe missing, malformed, gated, or limited data.

coverage.sourcestring

Always included.

coverage.completeboolean

Always included.

coverage.warningsenum[]

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
400	`invalid_request`	Missing/invalid profile URL, duplicate URL, or unsupported parameters.
401	`unauthorized`	Missing or invalid service API key.
403	`restricted_page`	The profile requires access or consent.
404	`not_found`	The public profile is missing or inactive.
429	`upstream_rate_limited`	Pillar rate limited retrieval; no automatic retry.
502	`upstream_challenged`	Pillar rejected or challenged the public request.
502	`unsupported_page`	Malformed or unsupported JSON, missing identity, or mismatched profile.
502	`response_too_large` `payload_too_complex`	The public JSON exceeds byte, depth, or node limits.
502	`unsafe_redirect` `request_limit` `upstream_error`	The bounded retrieval could not complete.
503	`busy`	All worker slots are in use.
504	`timeout`	Retrieval exceeded the total deadline.
502	`public_client_unavailable` `account_metadata_unavailable`	The public client or required account metadata could not be verified.
200	`partial`	Usable data with warnings about missing, invalid, gated, or truncated records.

Code example

curl "https://api.scrapeatlas.com/v1/pillar?url=https%3A%2F%2Fpillar.io%2Fexample" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/pillar?url=https%3A%2F%2Fpillar.io%2Fexample",
  {
    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/pillar?url=https%3A%2F%2Fpillar.io%2Fexample",
  {
    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(`Pillar request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/pillar",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://pillar.io/example"
    },
    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/pillar?url=https%3A%2F%2Fpillar.io%2Fexample", 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/pillar?url=https%3A%2F%2Fpillar.io%2Fexample"))
            .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",
  "id": "00000000-0000-4000-8000-000000000001",
  "first_name": "Example",
  "last_name": "Creator",
  "location": "Example City",
  "email": "hello@example.test",
  "email_primary": "account@example.test",
  "instagram": "https://instagram.com/example",
  "github": "",
  "links": [
    {
      "id": "00000000-0000-4000-8000-000000000010",
      "type": "my website",
      "title": "my website",
      "url": "https://example.test/",
      "clicks": 0,
      "order": null
    }
  ],
  "products": [
    {
      "id": "00000000-0000-4000-8000-000000000020",
      "title": "Example Product",
      "price": 19,
      "url": "https://example.test/product",
      "name": "Example Product",
      "description": "A synthetic product listing.",
      "image": null
    }
  ],
  "requestId": "00000000-0000-4000-8000-000000000099",
  "sourceUrl": "https://pillar.io/example",
  "fetchedAt": "2026-09-10T00:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 4,
    "responseBytes": 1300000,
    "durationMs": 1200
  }
}

Missing/invalid profile URL, duplicate URL, or unsupported parameters.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}