Skip to main content
POST
linkinbio.linktree.detail

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
url
string
required

Public page URL to look up, e.g. https://example.com/item.

Response

The result

username
string
required

Username.

description
string

Biography.

avatarUrl
string

Profile photo.

timezone
string

Timezone the page declares.

The page's links, in the order the page shows them.

platforms
string[]

Link platforms the page names.

verticals
string[]

Content categories the page names.

instagramUrl
string

Instagram account linked on the page.

tiktokUrl
string

TikTok account linked on the page.

youtubeUrl
string

YouTube account linked on the page.

spotifyUrl
string

Spotify account linked on the page.

soundcloudUrl
string

SoundCloud account linked on the page.

appleMusicUrl
string

Apple Music account linked on the page.