Link in bio

Linkme API

Retrieve a public Linkme profile with grouped contact links, social links, and page settings.

1 endpointx-api-key

Read the profile embedded in Linkme’s public website. Preserve published IDs, grouped links, image paths, formatted visit counts, and theme metadata.

API availability: Available

Base URL · local workerhttp://localhost:3009Public API: https://api.scrapeatlas.com.

Authenticationx-api-keyCustomer key from your account. See Authentication.

Retrieve a public Linkme profile under profile, preserving image paths and linkValue strings.

Create an API key on your account page, then call the public API. Values below are placeholders.

Terminal

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

One profile per request; four active requests per worker, with 503 busy on overload.
15-second total deadline; three upstream requests including redirects, with at most one retry for network errors or HTTP 5xx. No automatic 429/challenge retry.
2 MiB decoded HTML; 100,000 parser tokens; 4,096 shared references; nesting depth 24 and 10,000 expanded data nodes. Complex or unsupported serialization fails explicitly.
At most 500 visited link records across infoLinks and webLinks, with 100 groups per collection. Limits preserve the available records and report partial coverage.
Private, locked, or age-gated profiles return restricted_page. Gated link groups and entries are omitted with a partial result.
The parser reads serialized data only. It never executes page JavaScript, pixels, embedded markup, or outbound URLs.
The response covers the embedded profile object: identity, grouped info and web links, visit counts and theme metadata.
Fresh page reads on every request; upstream page caching can still affect freshness.

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.
429	`upstream_rate_limited`	Linkme 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.
502	`payload_too_complex`	Embedded data exceeded token, reference, nesting, or expanded-node limits.
200	`partial`	Usable profile data with explicit warnings about missing, malformed, gated, or limited fields.

Your privacy, your choice