/v1/linkbio
Linkbio page
Linkbio (lnk.bio) page
| Credit cost | Default: 1 credit How charges are determinedCost 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 |
|---|---|---|
urlURL to Linkbio (lnk.bio) page | query / required |
|
cache_max_ageUse a cached response this old or newer for 0 credits. If none is available, fetch live at the endpoint’s normal price. | query / optional |
Allowed values |
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/linkbio?url=YOUR_URL' \
--header 'x-api-key: YOUR_API_KEY'JavaScript
const response = await fetch("https://api.fetchproof.com/v1/linkbio?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/linkbio?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
handlerequired
string
idrequired
string
instagramrequired
null
emailrequired
null
tiktokrequired
null
youtuberequired
null
twitterrequired
null
whatsapprequired
null
websiterequired
null
linksrequired
array
Array items
object
urlrequired
string
textrequired
string
cachedoptional
boolean
cached_atoptional
string
{
"format": "date-time"
}