linkme.page_links

stable Standard

Linkme profile with its linked social accounts, bio and avatar.

GET /v1/linkme/page_links

What you get#

One Linkme record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`handle`	string	yes	(required)	Linkme handle (the path after link.me/)	max 60 chars; must match `[A-Za-z0-9._-]{1,60}`; trimmed, leading @ removed

Request#

curl "https://api.onekey.dev/v1/linkme/page_links?handle=linkme" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Linkme response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "author": {
      "username": "linkme",
      "displayName": "@linkme",
      "bio": "Join Linkme: Your Personalized Link in Bio",
      "avatarUrl": "https://media.link.me/_resize/image/quality=90,format=webp/images/webp-images/user-profile/429/17802a89-deeb-48ad-beb4-866db2a18be0.webp",
      "url": "https://link.me/linkme",
      "createdAt": "2021-05-11T17:44:18Z"
    },
    "ext": {
      "sameAs": [
        "https://www.instagram.com/LinkMe",
        "https://www.snapchat.com/add/linkmeglobal",
        "https://www.facebook.com/LinkMeMobile?mibextid=AEUHqQ",
        "https://www.twitter.com/linkme",
        "https://youtube.com/c/LinkMeglobal",
        "https://www.tiktok.com/@joinlinkme"
      ],
      "modifiedAt": "2026-09-01T22:15:14Z"
    }
  },
  "metadata": {
    "platform": "linkme",
    "endpoint": "page_links",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`mainEntity.identifier`	`author.username`	-
`mainEntity.name`	`author.displayName`	-
`mainEntity.description`	`author.bio`	-
`mainEntity.image`	`author.avatarUrl`	`safeUrl`
`mainEntity.url`	`author.url`	`safeUrl`
`dateCreated`	`author.createdAt`	`toIsoDate`
`mainEntity.sameAs`	`ext.sameAs`	-
`dateModified`	`ext.modifiedAt`	`toIsoDate`

Caching and freshness#

Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).