# Linkme Profile API

Linkme

Returns a public Linkme profile with its total followers, each social account's handle and followers, every link and its contact details. Contact details are the emails, phone numbers and street addresses the page lists. Each link has its title, description, thumbnail and section, and a music link its destination on each streaming service. The profile adds the name, bio, picture, logo, banner, verified badge, and when it was created and last changed. Send the page's name or link.

GET `/v1/linkme/profile`

## Example

cURL:

```shell
curl 'https://socialtap.dev/v1/linkme/profile?handle=papisteak' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
```

TypeScript SDK:

```typescript
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.linkme.profile.get({ handle: "papisteak" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
```

Node.js (fetch):

```javascript
const params = new URLSearchParams({
  handle: "papisteak",
});
const res = await fetch(`https://socialtap.dev/v1/linkme/profile?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, meta } = body;
console.log(data, meta.credits_charged);
```

Python (requests):

```python
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/linkme/profile",
    params={"handle": "papisteak"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, meta = body["data"], body["meta"]
print(data, meta["credits_charged"])
```

Go (net/http):

```go
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("handle", "papisteak")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/linkme/profile?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}
```

200 OK:

```json
{
  "data": {
    "approximate_fields": [
      "platform_specific.linkme.profile_visit_count"
    ],
    "avatar_url": "https://media.link.me/images/user-profile/2123271/tmp-565-1766183620379.png",
    "banner_url": null,
    "bio": "Iconic high-energy Steakhouse",
    "category": null,
    "country_code": null,
    "created_at": "2025-12-19T19:47:40Z",
    "display_name": "Papi Steak",
    "external_links": [
      {
        "title": "Instagram",
        "url": "https://www.instagram.com/papisteak"
      },
      {
        "title": "Facebook",
        "url": "https://www.facebook.com/papisteakmiami/"
      },
      {
        "title": "Threads",
        "url": "https://www.threads.net/@papisteak?igshid=NTc4MTIwNjQ2YQ=="
      }
    ],
    "id": "2123271",
    "is_private": false,
    "is_verified": true,
    "location": null,
    "metrics": {
      "follower_count": 239913,
      "following_count": null,
      "post_count": null,
      "total_like_count": null,
      "total_view_count": null
    },
    "platform": "linkme",
    "platform_specific": {
      "linkme": {
        "emails": [],
        "featured_links": [
          {
            "description": null,
            "group": null,
            "id": "1688371",
            "image_url": "https://media.link.me/images/external-links/2123271/1793642723656.png",
            "is_adult": false,
            "platform": "link",
            "platforms": [],
            "section": null,
            "title": "Doordash",
            "url": "https://order.online/business/24734529/store/51360639"
          },
          {
            "description": null,
            "group": null,
            "id": "686462",
            "image_url": "https://media.link.me/images/external-links/2123271/1766177538178.jpeg",
            "is_adult": false,
            "platform": "link",
            "platforms": [],
            "section": null,
            "title": "Website",
            "url": "https://papisteak.com/"
          },
          {
            "description": null,
            "group": null,
            "id": "686481",
            "image_url": "https://media.link.me/images/external-links/2123271/1766177573005.jpeg",
            "is_adult": false,
            "platform": "link",
            "platforms": [],
            "section": "PAPI STEAK MIAMI BEACH",
            "title": "Menu",
            "url": "https://papisteak.com/miami/menu/"
          }
        ],
        "is_adult": false,
        "link_count": 16,
        "linkme_connection_count": 2,
        "locations": [],
        "logo_url": "https://media.link.me/images/logo-image/2123271/tmp-2241-1778613564542.png",
        "network_follower_count": 239911,
        "phones": [],
        "profile_visit_count": 15400,
        "social_links": [
          {
            "follower_count": 194575,
            "handle": "papisteak",
            "is_adult": false,
            "platform": "Instagram",
            "url": "https://www.instagram.com/papisteak"
          },
          {
            "follower_count": 7900,
            "handle": "papisteakmiami",
            "is_adult": false,
            "platform": "Facebook",
            "url": "https://www.facebook.com/papisteakmiami/"
          },
          {
            "follower_count": 37436,
            "handle": "papisteak",
            "is_adult": false,
            "platform": "Threads",
            "url": "https://www.threads.net/@papisteak?igshid=NTc4MTIwNjQ2YQ=="
          }
        ],
        "updated_at": "2026-08-28T22:13:02Z"
      }
    },
    "type": "unknown",
    "unknown_fields": [],
    "url": "https://link.me/papisteak",
    "username": "papisteak"
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "linkme",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 281,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "profile",
      "id": "2123271",
      "url": "https://link.me/papisteak"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}
```

Long arrays and strings are shortened for display; real responses are complete.

> [!NOTE]
>
> **Good to know**
>
> - metrics.follower_count is the page's Total Followers, unrounded: network_follower_count (from the networks the account connected) plus linkme_connection_count (the Links in the page's followers sheet), both in platform_specific.linkme.
> - follower_count is null when the page has no total, as on most accounts. Their icons in social_links can still carry follower counts of their own, which we never add up.
> - Linkme shows the total only on verified accounts' pages, but an unverified account's total is in the page's data and is returned too.
> - external_links holds every web link on the page once: social icons, the contact block's website, then the link list with each carousel card and music destination. Emails, phones and street addresses are in platform_specific.linkme.
> - What an account hides from its page (bio, icons, link list, contact block or total followers) is not returned, though Linkme's data holds it.
> - Event tickets, shop products, courses, videos and photos are other parts of the page and are not returned.
> - An icon can hold a name to copy instead of a link (an Xbox gamertag, a Zelle name). Its url is then null and handle has the name.
> - Links Linkme marks as adult open after a notice any visitor can pass, so they are returned like the others, with is_adult true.
> - A page that shows "This page is locked" returns private_or_unavailable.
> - A private account's page shows only the name, picture and icons, and so do we: is_private is true, bio and follower_count are null, and the link and contact lists are in unknown_fields.
> - type is unknown, and category, country_code and the other metrics are null: Linkme has none of them.
> - A name no account has, or an account Linkme removed, returns not_found. Names of Linkme's own pages (pricing, login) are refused as input.

## Authorizations

`x-api-key`stringheaderrequired

Your API key. [Authentication](https://socialtap.dev/docs/authentication/index.md)

## Query parameters

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `handle` required | `string`<br>max 2,048 chars | The Linkme page: its name (papisteak, with or without the @) or its link (https://link.me/papisteak). | `papisteak` |

`handle` takes Linkme profile links; another kind of link, or another platform's, fails free with [`invalid_input`](https://socialtap.dev/docs/errors/index.md#invalid_input). Unknown parameters are rejected with a suggestion, never ignored ([Requests](https://socialtap.dev/docs/requests/index.md)).

**Parameters every endpoint accepts**

| Name | Type | Description | Example |
| --- | --- | --- | --- |
| `max_age` optional | `integer`<br>min 0 | Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent. | — |
| `fields` optional | `string` | Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments\[\].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole. | — |

## Response

### 200

`{data, meta}`. `data` is a [profile](https://socialtap.dev/resources/profile/index.md) object; `meta` describes the request ([meta](https://socialtap.dev/docs/reference/index.md#meta)). Fields only Linkme has are under `platform_specific.linkme`.

| Field | Type | Description |
| --- | --- | --- |
| `data.platform` | `string` | Platform ID (tiktok, youtube, …). |
| `data.id` | `string` | Platform-native account ID (string; YouTube UC…, Reddit t2_…). |
| `data.username` | `string` or `null` | Handle without the @; null when the account has none. |
| `data.display_name` | `string` or `null` | Display name, channel title or page name; null when empty or not exposed. |
| `data.url` | `string` (uri) | Canonical profile URL. |
| `data.type` | `string` | Coarse account kind, as the platform labels it; unknown when it does not (TikTok labels organizations only). New values may be added; treat unknown values as unknown.<br>One of `person`, `organization`, `community`, `unknown` |
| `data.bio` | `string` or `null` | Profile bio, channel description or page about text; null when empty or not exposed. |
| `data.avatar_url` | `string` (uri) or `null` | Profile picture URL (largest available). Platform CDN URLs can expire within hours. |
| `data.banner_url` | `string` (uri) or `null` | Header or cover image URL. |
| `data.is_verified` | `boolean` or `null` | Platform verification badge; null where the platform has no badge. |
| `data.is_private` | `boolean` or `null` | True when the account's posts are not public. |
| `data.category` | `string` or `null` | Platform category label (e.g. Musician, Media & Entertainment), as shown; not normalized. Often set only for business or creator accounts. |
| `data.external_links` | `object[]` | Links in the bio or channel links; \[\] if none or not exposed. |
| `data.external_links[].url` | `string` (uri) | Link target, absolute (https:// is added where the platform stores the link without a scheme). |
| `data.external_links[].title` | `string` or `null` | Link label shown by the platform. |
| `data.location` | `string` or `null` | Self-declared location text. |
| `data.country_code` | `string` or `null` | ISO 3166-1 alpha-2 country the platform states for the account. |
| `data.created_at` | `string` (date-time) or `null` | Account creation or join date, RFC 3339 UTC (some platforms give only the day: see approximate_fields). |
| `data.metrics` | `object` | Counts at fetch time; null = hidden or not exposed, 0 = zero. |
| `data.metrics.follower_count` | `integer` or `null` | Linkme: total followers. Followers or subscribers. |
| `data.metrics.following_count` | `integer` or `null` | Accounts this profile follows. |
| `data.metrics.post_count` | `integer` or `null` | Posts or videos as the platform counts them on the profile (for a private account, posts the caller cannot see). |
| `data.metrics.total_like_count` | `integer` or `null` | Likes received across all of the profile's posts (not likes given). |
| `data.metrics.total_view_count` | `integer` or `null` | Lifetime views across all of the profile's posts. |
| `data.platform_specific` | `object` | Fields only this platform has, under its ID (platform_specific.\<platform>); each null when unknown. |
| `data.platform_specific.linkme` | `object` or `null` | A Linkme page's own fields. |
| `data.platform_specific.linkme.emails` | `string[]` | Email addresses the page publishes in its contact block; \[\] if none. |
| `data.platform_specific.linkme.phones` | `string[]` | Phone numbers the page publishes in its contact block, as written; \[\] if none. |
| `data.platform_specific.linkme.locations` | `string[]` | Street addresses or places the page publishes in its contact block, as written; \[\] if none. |
| `data.platform_specific.linkme.social_links` | `object[]` | The page's row of social icons, in order; \[\] if none. |
| `data.platform_specific.linkme.social_links[].platform` | `string` | The icon's name as Linkme labels it (Instagram, Tiktok, Youtube, OF, Customlink, …). |
| `data.platform_specific.linkme.social_links[].url` | `string` (uri) or `null` | Where the icon links to; null when it holds no link, only a name to copy (an Xbox gamertag, a Zelle name), which handle then gives. |
| `data.platform_specific.linkme.social_links[].handle` | `string` or `null` | The name or ID Linkme stores for the icon, usually the account's username on that platform. |
| `data.platform_specific.linkme.social_links[].follower_count` | `integer` or `null` | The account's followers on that platform, as Linkme last read them; null for a link the account did not connect. |
| `data.platform_specific.linkme.social_links[].is_adult` | `boolean` or `null` | True when Linkme marks the link as adult content and shows a notice before opening it. |
| `data.platform_specific.linkme.featured_links` | `object[]` | The page's list of link buttons and cards, in page order, with a carousel's cards in place of the carousel and without section headings, which each entry names instead; \[\] if none. |
| `data.platform_specific.linkme.featured_links[].id` | `string` | The link's ID on Linkme. |
| `data.platform_specific.linkme.featured_links[].title` | `string` or `null` | The link's label. |
| `data.platform_specific.linkme.featured_links[].description` | `string` or `null` | The text under the label; a music link's artist; null if none. |
| `data.platform_specific.linkme.featured_links[].url` | `string` (uri) or `null` | Where the link goes; null only for an adult link whose target could not be read (the list is then in approximate_fields) or a music link, which has platforms instead. |
| `data.platform_specific.linkme.featured_links[].image_url` | `string` (uri) or `null` | The link's thumbnail; null if none. |
| `data.platform_specific.linkme.featured_links[].platform` | `string` or `null` | The site Linkme recognizes the link as (instagram, spotify, opentable, …); link for any other. |
| `data.platform_specific.linkme.featured_links[].section` | `string` or `null` | The heading the link sits under on the page; null if none. |
| `data.platform_specific.linkme.featured_links[].group` | `string` or `null` | The title of the carousel the card belongs to; null outside a carousel or for one without a title. |
| `data.platform_specific.linkme.featured_links[].is_adult` | `boolean` or `null` | True when Linkme marks the link as adult content and shows a notice before opening it. |
| `data.platform_specific.linkme.featured_links[].platforms` | `object[]` | The destinations a music link offers in its menu; \[\] for any other link. |
| `data.platform_specific.linkme.featured_links[].platforms[].name` | `string` | The destination's label (Spotify, Apple Music, …). |
| `data.platform_specific.linkme.featured_links[].platforms[].url` | `string` (uri) | The release on that destination. |
| `data.platform_specific.linkme.link_count` | `integer` or `null` | How many entries Linkme counts in the page's link list, section headings and carousels each counting as one. |
| `data.platform_specific.linkme.profile_visit_count` | `integer` or `null` | How many visits Linkme counts for the page, as Linkme rounds it from a thousand up: then listed in approximate_fields. |
| `data.platform_specific.linkme.network_follower_count` | `integer` or `null` | The part of metrics.follower_count that comes from the networks the account connected to Linkme. Null when it has none (no network connected), when the account hid its total, or on a private page. |
| `data.platform_specific.linkme.linkme_connection_count` | `integer` or `null` | The part of metrics.follower_count Linkme counts itself, which the page's followers sheet lists as Links on the account's own Linkme row; not the links on the page (link_count is). Null when the account hid its total, or on a private page. |
| `data.platform_specific.linkme.is_adult` | `boolean` or `null` | True when the page opens behind an age gate: a notice to continue past, or a birth date to type. |
| `data.platform_specific.linkme.logo_url` | `string` (uri) or `null` | The brand logo the page uploaded; null if none. |
| `data.platform_specific.linkme.updated_at` | `string` (date-time) or `null` | When the account last changed, RFC 3339 UTC. |
| `data.approximate_fields` | `string[]` | JSON paths of values rounded by the platform or parsed from display text (e.g. metrics.follower_count). A list path (external_links) means the list may be incomplete. \[\] when all exact. |
| `data.unknown_fields` | `string[]` | JSON paths of lists whose \[\] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. \[\] when every list is known. |

not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.

### 400

400 Bad Request: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `invalid_input` | 400 | No | A parameter is missing or malformed, or the link is not one this endpoint takes. | Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one. |

### 401

401 Unauthorized: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `unauthorized` | 401 | No | The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired. | Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url. |

### 402

402 Payment Required: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `insufficient_credits` | 402 | No | The account does not have enough credits for this request. | Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically. |
| `spend_limit_reached` | 402 | No | The API key reached its spend limit for this period. The account may still have credits. | Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically. |

### 403

403 Forbidden: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `forbidden` | 403 | No | The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code. | Act on details.reason. suspended: contact [support](mailto:support@socialtap.dev). scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP. |
| `private_or_unavailable` | 403 | No | The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code. | Only public items can be fetched. Do not retry. |

### 404

404 Not Found: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `not_found` | 404 | No | The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why). | Check the link or ID. Do not retry. |

### 429

429 Too Many Requests: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `rate_limited` | 429 | Yes, later | The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it. | Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask [support](mailto:support@socialtap.dev) to raise the ceiling; without an API key, send one. |

### 500

500 Internal Error: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `internal` | 500 | Yes, later | An unexpected error on SocialTap's side. | Retry with backoff. If it keeps happening, contact [support](mailto:support@socialtap.dev) with the request_id. |

### 502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_error` | 502 | Yes, later | The platform failed, or answered with something we could not read. | Retry with backoff. Failed requests are free. |

### 503

503 Unavailable: 2 error codes. Free: errors cost nothing.

| Code | HTTP | Retry | Meaning | What to do |
| --- | --- | --- | --- | --- |
| `upstream_blocked` | 503 | Yes, later | The platform refused every attempt, our own retries included. | Retry later with backoff. Failed requests are free. |
| `overloaded` | 503 | Yes, later | SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged. | Retry after the seconds in the retry-after header. Failed requests are free. |

## Pricing

From **1 credit** per request. Charged only for successful requests. Errors are free. The price depends on the source that produced the result, reported as `meta.source`; sources are tried cheapest first: Platform API → Public page.

| Source | Price per successful request | Per 1,000 requests |
| --- | --- | --- |
| Platform API `api` | 1 credit | $0.75–$1.97 |
| Public page `page` | 1 credit | $0.75–$1.97 |

**Balance, sources and what you were charged**

Your balance must be at least **1 credit** to start a request; with less, it is refused with [`insufficient_credits`](https://socialtap.dev/docs/errors/index.md#insufficient_credits) (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

| meta.source | Source | What it means |
| --- | --- | --- |
| `api` | Platform API | The platform's public, logged-out API. |
| `page` | Public page | Data embedded in the platform's public web page. |

`meta.credits_charged` and the `x-credits-charged` header show what you paid. [How credits work](https://socialtap.dev/docs/credits/index.md) · [Packs](https://socialtap.dev/pricing/index.md)

Endpoint ID `linkme.profile` · operationId `linkme.profile.get` · [Product overview](https://socialtap.dev/apis/linkme/profile/index.md)

---

[HTML version](https://socialtap.dev/docs/reference/linkme/profile/) · [Docs index for AI agents](https://socialtap.dev/llms.txt) · [All docs in one file](https://socialtap.dev/llms-full.txt)