/v1/linkme

GET

Profile

Get Linkme profile info by URL

Credit cost	Default: 1 credit How charges are determined Cost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns. A call that fails costs 0 credits. A result served from cache costs 0 credits. `default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins. A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true). A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute.
Cache support	Use a cached response this old or newer for 0 credits. If none is available, fetch live at the endpoint’s normal price.
Pagination	No explicit pagination metadata in the published contract. Consult the parameters and response fields below.

Parameters

Name	Location / required	Schema
`url` Linkme profile URL	query / required	`string`
`cache_max_age` Use a cached response this old or newer for 0 credits. If none is available, fetch live at the endpoint’s normal price.	query / optional	`string` Allowed values `["1d","3d","7d","14d","30d"]`

Request examples

Replace placeholder values and supply your own API key. For operations with a request body, populate the body using the schema above.

cURL

curl --request GET 'https://api.fetchproof.com/v1/linkme?url=YOUR_URL' \
  --header 'x-api-key: YOUR_API_KEY'

JavaScript

const response = await fetch("https://api.fetchproof.com/v1/linkme?url=YOUR_URL", {
  method: 'GET',
  headers: { 'x-api-key': process.env.FETCHPROOF_API_KEY }
});
console.log(await response.text());

Python

import os
import requests

response = requests.get("https://api.fetchproof.com/v1/linkme?url=YOUR_URL",
    headers={"x-api-key": os.environ["FETCHPROOF_API_KEY"]})
print(response.text)

Responses

200Success. Envelope: success / credits_remaining / credits_charged.

application/json

object

successrequired

boolean

credits_remainingrequired

integer

credits_chargedrequired

integer

profilerequired

object

idrequired

string

firstNamerequired

string

lastNamerequired

string

usernamerequired

string

verifiedAccountrequired

integer

biorequired

string

isAmbassadorrequired

integer

friendStatusrequired

integer

profileVisitCountrequired

string

isDefaultProfilePicturerequired

boolean

profileImagerequired

string

profileImageWebprequired

string

isPrivaterequired

integer

referralLinkrequired

string

deeplinkrequired

string

logorequired

string

logoMetaDatarequired

string

QRCoderequired

string

webThemerequired

string

linkmeCustomIconrequired

string

coverrequired

string

createdAtrequired

string

updatedAtrequired

string

stripeStatusrequired

object

tipsEnabledrequired

integer

stripeAccountIdrequired

string

stripeEnabledrequired

boolean

killerrequired

integer

hideBottomButtonsrequired

integer

customMailFormrequired

integer

hideAddToContactsrequired

integer

subscriptionFeaturerequired

string

showFormrequired

boolean

subscriptionTyperequired

integer

displayNameOptionrequired

string

trackingPixelsrequired

array

isMuteEnablerequired

integer

totalLinksrequired

integer

chatIDrequired

string

infoLinksrequired

array

Array items

object

titlerequired

string

linkIdrequired

integer

isCustomrequired

boolean

linksrequired

array

Array items

object

webLinkIdrequired

integer

linkImagerequired

string

linkValuerequired

string

faceValuerequired

string

isCustomrequired

boolean

isAdultrequired

boolean

businessInforequired

null

webLinksrequired

array

Array items

object

titlerequired

string

linkIdrequired

integer

isCustomrequired

boolean

linksrequired

array

Array items

object

webLinkIdrequired

integer

linkImagerequired

string

linkValuerequired

string

faceValuerequired

string

baseUrlrequired

string

isCustomrequired

boolean

isAdultrequired

boolean

customisedThemerequired

object

verifiedIconrequired

string

backgroundColorrequired

string

backgroundImagerequired

string

mainTextColorrequired

string

level1TextColorrequired

string

level2TextColorrequired

string

featuredLinkTitlesrequired

null

bioBackgroundrequired

string

profilePicturerequired

string

customFontrequired

string

totalFollowersrequired

null

sectionSettingsrequired

object

shoutsrequired

object

enabledrequired

boolean

positionrequired

null

sectionVisibilityrequired

array

Array items

object

sectionrequired

string

orderrequired

integer

enabledrequired

integer

cachedoptional

boolean

cached_atoptional

string

{
  "format": "date-time"
}

401Invalid or missing x-api-key

402No credits remaining

403Upstream denied (age gate, audience controls)

404Resource or endpoint not found

429Rate limited