Get a Linktree shop

Try in Playground

Retrieve published shop products and collections with prices, images, vendors and source collection totals.

GET/v1/linktree/shopx-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. The public Linktree profile URL.

max 2048 chars

Examplehttps://linktr.ee/example

Response fields

idinteger

Numeric account ID.

≥ 0

usernamestring

Profile username.

displayNamestringnullable

Published profile display name.

isVerifiedbooleannullable

Public verification flag.

Ordered PRODUCT and COLLECTION records. Products retain source string id and accountProductId, title, URL, image, currency, price, salePrice, vendor, vendorDisplayName and hasCommission. Collections contain id, title, storeProducts and storeProductsTotalCount.

up to 500 items

items.typestring

Always included.

items.idstring

Always included.

min 1 chars

items.accountProductIdstringnullableoptional

Optional.

items.titlestring

Always included.

items.urlstringoptional

Optional.

items.imagestringnullableoptional

Optional.

items.currencystringnullableoptional

Optional.

items.priceintegernullableoptional

Source integer price in minor currency units; for USD, 1299 represents $12.99.

≥ 0

items.salePriceintegernullableoptional

Source sale price in the same units.

≥ 0

items.vendorstringnullableoptional

Optional.

items.vendorDisplayNamestringnullableoptional

Optional.

items.hasCommissionbooleannullableoptional

Optional.

up to 500 items

items.storeProducts.typestring

Always included.

items.storeProducts.idstring

Always included.

min 1 chars

items.storeProducts.accountProductIdstringnullable

Always included.

items.storeProducts.titlestring

Always included.

items.storeProducts.urlstring

Always included.

items.storeProducts.imagestringnullable

Always included.

items.storeProducts.currencystringnullable

Always included.

items.storeProducts.priceintegernullable

Always included.

≥ 0

items.storeProducts.salePriceintegernullable

Always included.

≥ 0

items.storeProducts.vendorstringnullable

Always included.

items.storeProducts.vendorDisplayNamestringnullable

Always included.

items.storeProducts.hasCommissionbooleannullable

Always included.

items.storeProductsTotalCountintegernullableoptional

Source-reported number of products in the collection.

≥ 0

postsTotalCountintegernullable

Source-reported shop post count.

≥ 0

requestIdstring

Identifier for correlating a request with operational logs.

Upstream request count, decoded public-page source bytes read, and total duration.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

True when usable profile data is returned, including partial results.

statusenum

success or partial. Failures return failed or challenged with a failure object.

one of: success, partial

sourceUrlstring

Final canonical profile URL after allowed redirects.

absolute HTTPS URL

fetchedAtstring

UTC timestamp of retrieval.

complete applies to supported embedded public page fields. Inspect warnings for omitted or unavailable 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`	Invalid URL, missing URL, duplicates, or unsupported parameters.
401	`unauthorized`	Missing or invalid service API key.
403	`restricted_page`	The profile requires access or consent.
404	`not_found`	The profile is missing or inactive, or the directory category or page does not exist.
429	`upstream_rate_limited`	Linktree rate limited the request; no automatic retry.
502	`upstream_challenged`	The upstream rejected or challenged the request.
502	`unsupported_page`	Data is missing, malformed, or belongs to another profile.
502	`response_too_large` `unsafe_redirect` `request_limit` `upstream_error`	Retrieval could not safely complete.
503	`busy`	All worker slots are in use.
504	`timeout`	The request exceeded its deadline.

Code example

curl "https://api.scrapeatlas.com/v1/linktree/shop?url=https%3A%2F%2Flinktr.ee%2Fexample" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/linktree/shop?url=https%3A%2F%2Flinktr.ee%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/linktree/shop?url=https%3A%2F%2Flinktr.ee%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(`Linktree request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/linktree/shop",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://linktr.ee/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/linktree/shop?url=https%3A%2F%2Flinktr.ee%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/linktree/shop?url=https%3A%2F%2Flinktr.ee%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",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "fetchedAt": "2026-09-18T00:00:00.000Z",
  "coverage": {
    "source": "public_page",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 24000,
    "durationMs": 350
  },
  "id": 123,
  "username": "example",
  "displayName": "Example Creator",
  "isVerified": true,
  "items": [
    {
      "type": "PRODUCT",
      "id": "product-example",
      "accountProductId": "account-product-example",
      "title": "Example product",
      "url": "https://example.test/product",
      "image": "https://example.test/product.png",
      "currency": "USD",
      "price": 1299,
      "salePrice": 999,
      "vendor": "example",
      "vendorDisplayName": "Example shop",
      "hasCommission": false
    },
    {
      "type": "COLLECTION",
      "id": "collection-example",
      "title": "Favorites",
      "storeProducts": [
        {
          "type": "PRODUCT",
          "id": "product-example",
          "accountProductId": "account-product-example",
          "title": "Example product",
          "url": "https://example.test/product",
          "image": "https://example.test/product.png",
          "currency": "USD",
          "price": 1299,
          "salePrice": 999,
          "vendor": "example",
          "vendorDisplayName": "Example shop",
          "hasCommission": false
        }
      ],
      "storeProductsTotalCount": 1
    }
  ],
  "postsTotalCount": 0,
  "sourceUrl": "https://linktr.ee/example/shop"
}

Invalid URL, missing URL, duplicates, 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."
  }
}