# Komi Page API

Komi

Returns a public Komi creator page with everything it shows: links, products with prices, discount codes, videos, music, podcasts and events. Music releases and podcast episodes come with their link on each streaming service, and events with their date, venue and ticket link. The page also has its ID, username, display name, bio, avatar, owner's name and its row of social and contact links. Send its link, its host or its username.

GET `/v1/komi/page`

## Example

cURL:

```shell
curl -G 'https://socialtap.dev/v1/komi/page' \
  --data-urlencode 'handle=https://hek.komi.io' \
  -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.komi.page.get({ handle: "https://hek.komi.io" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
```

Node.js (fetch):

```javascript
const params = new URLSearchParams({
  handle: "https://hek.komi.io",
});
const res = await fetch(`https://socialtap.dev/v1/komi/page?${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/komi/page",
    params={"handle": "https://hek.komi.io"},
    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", "https://hek.komi.io")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/komi/page?"+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": [],
    "avatar_url": "https://komi-production-assets.s3-accelerate.amazonaws.com/photos/lDMv-wPUiMipP8yyiam66.jpg?tr=w-782%2Ch-983%2Ccm-extract%2Cx-149%2Cy-45&crp=%7B%22width%22%3A782%2C%22height%22%3A983%2C%22x%22%3A149%2C%22y%22%3A45%7D",
    "banner_url": null,
    "bio": null,
    "category": "Music",
    "country_code": null,
    "created_at": "2024-10-21T14:41:23Z",
    "display_name": "HEKKET",
    "external_links": [
      {
        "title": null,
        "url": "https://instagram.com/hekket17603/profilecard/?igsh=MW1oNWRiODA5dWZuMg=="
      },
      {
        "title": null,
        "url": "https://youtube.com/@hekket?si=-xnVB7PdutNtbgmk"
      },
      {
        "title": "DEAD BXTCH FT N8F",
        "url": "https://on.soundcloud.com/hEQzK"
      }
    ],
    "id": "fea18cd6-5ba9-4f7d-94ea-3d08c7cf31d7",
    "is_private": false,
    "is_verified": null,
    "location": null,
    "metrics": {
      "follower_count": null,
      "following_count": null,
      "post_count": null,
      "total_like_count": null,
      "total_view_count": null
    },
    "platform": "komi",
    "platform_specific": {
      "komi": {
        "display_name_image_url": null,
        "first_name": "HEKKET",
        "items": [
          {
            "coupon_code": null,
            "currency": null,
            "description": null,
            "group": null,
            "id": "ebefa060-2c52-4119-97a4-94f084bce23c",
            "is_sold_out": null,
            "links": [],
            "location": null,
            "price": null,
            "section": "SoundCloud",
            "starts_at": null,
            "thumbnail_url": "https://komi-production-assets.s3-accelerate.amazonaws.com/photos/4QeDwoRB1cv8sG2g47Jde.jpg",
            "title": "DEAD BXTCH FT N8F",
            "type": "link",
            "url": "https://on.soundcloud.com/hEQzK",
            "venue": null
          },
          {
            "coupon_code": null,
            "currency": null,
            "description": null,
            "group": null,
            "id": "92612586-9372-4ee0-9662-caffa7fccd3e",
            "is_sold_out": null,
            "links": [],
            "location": null,
            "price": null,
            "section": "YouTube Videos",
            "starts_at": null,
            "thumbnail_url": "https://i.ytimg.com/vi/aRR9J4af9gY/hqdefault.jpg",
            "title": "HEKKET & OMYSLIM - STRESSIN OUT",
            "type": "youtube_video",
            "url": "https://youtu.be/aRR9J4af9gY?si=vATDxe2tEjbf3gMP",
            "venue": null
          },
          {
            "coupon_code": null,
            "currency": null,
            "description": null,
            "group": null,
            "id": "342924db-5b88-488c-8a9f-26e593af8cf2",
            "is_sold_out": null,
            "links": [],
            "location": null,
            "price": null,
            "section": "YouTube Videos",
            "starts_at": null,
            "thumbnail_url": "https://i.ytimg.com/vi/SFzYp5P0U6k/hqdefault.jpg",
            "title": "HEKKET - DEAD BXTCH (feat N8F & Prod By DELIXE)",
            "type": "youtube_video",
            "url": "https://youtu.be/SFzYp5P0U6k?si=qNgExztHYFqS06Iw",
            "venue": null
          }
        ],
        "last_name": null,
        "social_links": [
          {
            "type": "instagram",
            "url": "https://instagram.com/hekket17603/profilecard/?igsh=MW1oNWRiODA5dWZuMg=="
          },
          {
            "type": "youtube",
            "url": "https://youtube.com/@hekket?si=-xnVB7PdutNtbgmk"
          }
        ]
      }
    },
    "type": "unknown",
    "unknown_fields": [],
    "url": "https://hek.komi.io",
    "username": "hek"
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "komi",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 2377,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "profile",
      "id": "fea18cd6-5ba9-4f7d-94ea-3d08c7cf31d7",
      "url": "https://hek.komi.io"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}
```

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

> [!NOTE]
>
> **Good to know**
>
> - A page has no follower counts or verified badge, so those fields are always null.
> - category is what the owner chose, or null. created_at is when the page was made, null for a page Komi moved over from its earlier service.
> - bio and the owner's name come from a slower lookup than the rest. When it fails, the page still comes back, with a partial_data warning naming them.
> - When Komi's page answer is down, an older copy stands in with a partial_data warning: approximate_fields marks its items and external_links, category and created_at are unknown, and the page may no longer be shown at all.
> - external_links lists every web link leading off the page once. platform_specific.komi.items keeps each item's type, group, section, image and price, in page order.
> - Modules the owner has hidden are not returned, and neither is what a sign-up form keeps behind it (a secret link or code).
> - A link's discount code is returned as coupon_code: its page on Komi shows it to anyone who follows the link.
> - Contact links come with their type in social_links and items: an email address as a mailto: link, a WhatsApp link as it is. external_links holds web links only, so it has no mailto: link.
> - A page Komi has switched off returns private_or_unavailable. A name no page has returns not_found.

## 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 Komi page: its link (https://kimkardashian.komi.io, on any path), the host alone (kimkardashian.komi.io), or its username with or without the @. | `kimkardashian` |

`handle` takes Komi 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 Komi has are under `platform_specific.komi`.

| 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` | 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.komi` | `object` or `null` | A Komi page's own fields. |
| `data.platform_specific.komi.first_name` | `string` or `null` | The owner's first name as entered on Komi; null when empty. |
| `data.platform_specific.komi.last_name` | `string` or `null` | The owner's last name as entered on Komi; null when empty. |
| `data.platform_specific.komi.display_name_image_url` | `string` (uri) or `null` | The artwork the page shows as its name, when it has one; null otherwise. |
| `data.platform_specific.komi.social_links` | `object[]` | The page's row of social and music profiles and contact links, in the page's order; \[\] when it has none (listed in unknown_fields when the source cannot see them). |
| `data.platform_specific.komi.social_links[].type` | `string` | Komi's name for the service, lowercase: instagram, tiktok, youtube, twitter, facebook, snapchat, spotify, apple_music, website, email, whatsapp, … New values may be added. |
| `data.platform_specific.komi.social_links[].url` | `string` (uri) | The link, as the owner entered it (https:// added when it had no scheme); an email address as a mailto: link. |
| `data.platform_specific.komi.items` | `object[]` | What the page shows, flattened in the page's order: links, products, videos, music, podcasts, events, text and galleries. Modules the owner has hidden are not returned; \[\] when the page shows nothing (listed in unknown_fields when the source cannot see them). |
| `data.platform_specific.komi.items[].id` | `string` or `null` | Komi's ID of the item; null for items Komi reads from another service (a shop's or Bandsintown's). |
| `data.platform_specific.komi.items[].type` | `string` | Komi's name for the kind of module, lowercase: link, product, digital_product, youtube_video, youtube_short, tiktok_video, instagram_reel, music, podcast, events, bandsintown, seated, text, media_gallery, shop_my_shelf, mail_link, data_capture_signup, form_data, … New values may be added: treat an unknown one as a generic item. |
| `data.platform_specific.komi.items[].group` | `string` or `null` | The name of the group the item sits in on the page; null when it is in none. |
| `data.platform_specific.komi.items[].section` | `string` or `null` | The title the page shows above the item's module; null when it shows none. |
| `data.platform_specific.komi.items[].title` | `string` or `null` | The item's label: a link's text, a product's name, a video's or a release's title. |
| `data.platform_specific.komi.items[].url` | `string` (uri) or `null` | Where the item leads: the link's target (a mailto: link for a mail_link), the product's page, the video, the release's or the digital product's page on Komi, an event's tickets. Null for a form or a text. |
| `data.platform_specific.komi.items[].thumbnail_url` | `string` (uri) or `null` | The item's image; null when it has none. |
| `data.platform_specific.komi.items[].description` | `string` or `null` | The text of a text module, a gallery image's caption, or a product's description. |
| `data.platform_specific.komi.items[].price` | `number` or `null` | A product's price as the page shows it, in major units of currency; 0 is a free digital download; null when the item has no price or the page shows none. |
| `data.platform_specific.komi.items[].currency` | `string` or `null` | ISO 4217 currency of price; null when the item has no price or Komi does not say. |
| `data.platform_specific.komi.items[].coupon_code` | `string` or `null` | The discount code a link's own page on Komi shows anyone who follows it; null when it has none. |
| `data.platform_specific.komi.items[].links` | `object[]` | For music and podcasts, the same release on each service, in the page's order; \[\] for everything else. |
| `data.platform_specific.komi.items[].links[].type` | `string` | Komi's name for the service, lowercase: spotify, apple_music, youtube_music, deezer, apple_podcast, … New values may be added. |
| `data.platform_specific.komi.items[].links[].url` | `string` (uri) | The release or the episode on that service. |
| `data.platform_specific.komi.items[].starts_at` | `string` (date-time) or `null` | When an event starts, RFC 3339 UTC; null otherwise. A Bandsintown or Seated time has no zone and is read as UTC (listed in approximate_fields). |
| `data.platform_specific.komi.items[].venue` | `string` or `null` | An event's venue; null otherwise. |
| `data.platform_specific.komi.items[].location` | `string` or `null` | An event's place as the page shows it; null otherwise. |
| `data.platform_specific.komi.items[].is_sold_out` | `boolean` or `null` | Whether an event is sold out; null for anything but an event. |
| `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`.

| Source | Price per successful request | Per 1,000 requests |
| --- | --- | --- |
| Platform API `api` | 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. |

`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 `komi.page` · operationId `komi.page.get` · [Product overview](https://socialtap.dev/apis/komi/page/index.md)

---

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