Linkme API

Linkme Scraper API for Profiles and Contact Links

Retrieve public Linkme profiles, social destinations and published contact links.

WHAT YOU CAN BUILD / 01 ENDPOINT

Put Linkme data to work.

Find your use case, then explore the request and response.

Get a Linkme profile

GET/v1/linkme

Build a creator directory entry from a Linkme profile’s biography, grouped links and linked accounts.

HOW IT WORKS

From API key to Linkme data in four steps.

Run a sample below without a key.

  1. 01

    Get your API key

    Create a free account and copy your key. You start with 100 free credits; no card needed.

  2. 02

    Choose an endpoint

    Pick one of the 1 Linkme endpoint and add its input, such as a public URL.

  3. 03

    Send one request

    Call it with your key in the x-api-key header. ScrapeAtlas reads the public Linkme data and retries when a read fails.

  4. 04

    Use the JSON

    Get structured JSON with a coverage status. Only successful requests use a credit.

TRY IT HERE / LIVE SAMPLE

Try a sample request.

Try the Linkme API right here. This sample uses the Get a Linkme profile endpoint and returns live JSON. No API key needed.

  1. 01
    Choose a sample value

    Start with https://link.me/linkme, or change the url field to your own value.

  2. 02
    Select Run sample

    Execute the sample code and see the response in the JSON response tab.

  3. 03
    Build on the result

    Open the full playground to try more parameters and copy code for your app.

Open this endpoint in the playground Request and response fields
LIVE SAMPLE / Get a Linkme profileNo API key needed

Preparing the sample…

// Run this sample here — no API key needed.
const value = "https://link.me/linkme";
const url = new URL("/website/demo/linkme",
  "https://api.scrapeatlas.com");
url.searchParams.set("value", value);

const response = await fetch(url);
const data = await response.json();
console.log(data);
GET/v1/linkme

A live example from our playground. Change the value above, then select Run sample.

CUSTOMER STORIES

What they are saying
about us.

Nigel Yong — Founder, PostOnce

Pay as you go

Start free.
Build at your pace.

One-time credit packs, priced in US dollars. Credits never expire, and there is no monthly commitment.

Free

Try the API with your next idea.

$0No credit card needed

100 free credits

One starter grant per account

Starter

For a new idea or a one-off project.

$19USD / one-time

10,000 credits

$1.90 per 1,000 successful requests

Growth

Save 6.3%

For regular workflows and bigger builds.

$89USD / one-time

50,000 credits

$1.78 per 1,000 successful requests

Enterprise Plan

Want to scrape larger volumes?

Let’s talk about a plan that fits your scale.

Linkme API

Frequently Asked Questions

Explore the API reference

Linkme API and scraping

What profile information can I retrieve with the Linkme API?

Retrieve a public Linkme profile as structured data, preserving its profile information and published link records. Use the result in a creator preview or searchable link directory.

How do I scrape a public Linkme profile page?

Send the profile URL to the Linkme Profile endpoint. Read the returned profile object and map its identity and grouped link information into your application’s profile or resource fields.

Can I retrieve Linkme profile data as JSON for my application?

Yes. Profile places the creator record under profile, including identity fields and the published link groups. Use the profile ID and username to associate the response with the creator entry in your own application.

Linkme: profile previews and creator links

Can I use Linkme profile data to create a creator preview?

Yes. Use the profile information and image references to describe the creator, then add the published destinations as resource links. Keep the original profile URL so readers can open the Linkme page.

Can I extract Linkme links into a searchable directory?

Yes. The profile record preserves the published link values and their grouping. Your application can index those destinations alongside the creator’s profile information to make a searchable resource list.

Does the Linkme API preserve the titles of link groups?

Yes. Published webLinks and infoLinks groups retain their titles and link IDs, with the links nested inside each group. Keep this structure when presenting a creator’s resources so the directory follows the page’s organization.

API access and integration

How do I get a ScrapeAtlas API key and authenticate requests?

Create a ScrapeAtlas account and generate an API key in the dashboard. Send the key in the x-api-key request header when calling https://api.scrapeatlas.com. The API playground lets you enter an endpoint’s parameters and inspect its JSON response.

Can I call the scraping API from Python, JavaScript or the CLI?

Yes. Send authenticated HTTP requests from Python, JavaScript or another language that supports HTTP. The endpoint reference includes request examples and response fields. Use the ScrapeAtlas CLI for terminal workflows and pass the returned pagination values when requesting additional result pages.

Can I connect an AI assistant to the ScrapeAtlas MCP server?

Yes. Connect an MCP-compatible assistant to the ScrapeAtlas MCP server to discover and call the public platform tools with your ScrapeAtlas account. The agent reference also gives coding assistants a readable guide to the endpoints and their request schemas.

Make something with it

Ready to build?

Bring social data into your next project.
Start with 100 free credits and see what you can build.

No credit card needed.Building with an AI agent?