Public profile on linktree, with the exact follower count.

One public profile, normalised into the same envelope as every other platform. Source: public page, logged out. Costs 1 credit; the answer is cached for an hour and a cache hit costs nothing (cached: true, credits_used: 0).

Linktree username: letters, digits, dot, hyphen and underscore.

get/api/v1/linktree/profile

Request

  • Base URL: https://honesthook.com
  • URL: https://honesthook.com/api/v1/linktree/profile
  • Auth: HTTP bearer

Query parameters

handlestring required
Example:comedycentral

Linktree username: letters, digits, dot, hyphen and underscore.

Response

Profile found

successboolean required
platformstring required
endpointstring required
credits_usedinteger required
credits_remaininginteger nullable required

THE SUM: purchased balance plus what is left of this month's free allowance. This is the only number that answers "can I call again" — it is not 0 while you can still call. null means we could not read it, which is not the same as zero.

credits_purchased_remaininginteger nullable

Bought credits. These never expire.

free_credits_remaininginteger nullable

What is left of this month's free allowance.

free_credits_totalinteger nullable

The monthly free allowance for this key.

free_credits_reset_atstring date-time

When the free allowance resets: 00:00 UTC on the 1st. It is here so the sum dropping at the turn of the month is expected rather than a surprise.

cachedboolean required

true is a promise that we did NOT charge: it always comes with credits_used: 0.

request_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.