Get a Komi profile

Try in Playground

Pass one public Komi profile URL. Tracking parameters and fragments are removed. Returned URLs are data; their destinations are never fetched.

GET/v1/komix-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

urlstringrequiredquery

Required. An HTTPS <username>.komi.io profile URL. Custom domains and paths are unsupported.

max 2048 chars · absolute HTTPS URL

Examplehttps://example.komi.io/

Response fields

idstring

Komi profile UUID, distinct from its numeric user ID.

usernamestring

Canonical Komi username.

min 1 chars

avatarstringnullable

Account avatar URL, or null when unavailable.

biostringnullable

Public profile bio, preserving empty strings; null when unavailable.

firstNamestringnullable

Public first name, or null.

lastNamestringnullable

Public last name, or null.

displayNamestringnullable

Public display name, or null.

displayNameImagestringnullable

Public image used as the display name, or null.

websitestringnullable

Profile website field. Null when Komi publishes no value.

instagramstringoptional

Published instagram social link; omitted if absent.

tiktokstringoptional

Published tiktok social link; omitted if absent.

youtubestringoptional

Published youtube social link; omitted if absent.

twitterstringoptional

Published twitter social link; omitted if absent.

facebookstringoptional

Published facebook social link; omitted if absent.

snapchatstringoptional

Published snapchat social link; omitted if absent.

spotifystringoptional

Published spotify social link; omitted if absent.

apple_musicstringoptional

Published apple music social link; omitted if absent.

deezerstringoptional

Published deezer social link; omitted if absent.

soundcloudstringoptional

Published soundcloud social link; omitted if absent.

twitchstringoptional

Published twitch social link; omitted if absent.

discordstringoptional

Published discord social link; omitted if absent.

linkedinstringoptional

Published linkedin social link; omitted if absent.

emailstringoptional

Published email social link; omitted if absent.

Ordered public module records. Groups flatten in source order; music and podcast destinations become individual records. Products preserve prices and currency. Video titles come from metadata when present. IDs are absent on some music destinations. Music uses the parent item subtype, such as NORMAL, while podcasts use PODCAST.

up to 500 items

links.idstring | numberoptional

Optional.

links.typestring

Always included.

min 1 chars

links.urlstringnullableoptional

Optional.

links.titlestringnullableoptional

Optional.

links.ordernumberoptional

Optional.

links.visiblebooleanoptional

Optional.

links.thumbnailstringnullableoptional

Optional.

links.moduleIdstringnullableoptional

Optional.

links.versionIdstringnullableoptional

Optional.

links.pricenumber | stringnullableoptional

Optional.

links.currencystringnullableoptional

Optional.

requestIdstring

Identifier for correlating a request with operational logs.

Upstream requests, decoded JSON bytes read across both responses, and total duration. Discarded error bodies are excluded.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

True when usable profile data is returned, including partial results.

statusenum

success or partial. Failures return failed or challenged with a failure object.

one of: success, partial

sourceUrlstring

Final canonical profile URL after allowed redirects.

absolute HTTPS URL

fetchedAtstring

UTC timestamp of retrieval.

Supported public API data only. Inspect warnings and optional moduleFailure when module retrieval is incomplete.

coverage.sourcestring

Always included.

coverage.completeboolean

Always included.

coverage.warningsenum[]

Always included.

coverage.moduleFailureenumoptional

Optional.

one of: invalid_request, unauthorized, not_found, upstream_challenged, upstream_rate_limited, upstream_error, unsupported_page, restricted_page, response_too_large, unsafe_redirect, request_limit, timeout, busy

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Invalid URL, missing URL, duplicates, or unsupported parameters.
401	`unauthorized`	Missing or invalid service API key.
403	`restricted_page`	The profile requires access or consent.
404	`not_found`	The profile is missing or inactive.
429	`upstream_rate_limited`	Komi rate limited the request; no automatic retry.
502	`upstream_challenged`	The upstream rejected or challenged the request.
502	`unsupported_page`	Data is missing, malformed, or belongs to another profile.
502	`response_too_large` `unsafe_redirect` `request_limit` `upstream_error`	Retrieval could not safely complete.
503	`busy`	All worker slots are in use.
504	`timeout`	The request exceeded its deadline.
200	`partial`	Profile metadata is usable, but coverage warnings identify missing modules, fields, gates, or limits.

Code example

curl "https://api.scrapeatlas.com/v1/komi?url=https%3A%2F%2Fexample.komi.io%2F" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/komi?url=https%3A%2F%2Fexample.komi.io%2F",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/komi?url=https%3A%2F%2Fexample.komi.io%2F",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Komi request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/komi",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://example.komi.io/"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/komi?url=https%3A%2F%2Fexample.komi.io%2F", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/komi?url=https%3A%2F%2Fexample.komi.io%2F"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "fetchedAt": "2026-09-10T00:00:00.000Z",
  "id": "00000000-0000-4000-8000-000000000002",
  "username": "example",
  "avatar": "https://example.test/avatar.png",
  "bio": "Synthetic creator",
  "firstName": "Example",
  "lastName": "Creator",
  "displayName": "Example Creator",
  "displayNameImage": null,
  "instagram": "https://instagram.com/example",
  "website": null,
  "links": [
    {
      "id": "link-1",
      "type": "LINK",
      "url": "https://example.test/",
      "title": "Website",
      "order": 0,
      "visible": true
    },
    {
      "id": "product-1",
      "type": "PRODUCT",
      "url": "https://example.test/shop",
      "title": "Studio T-shirt",
      "price": 44,
      "currency": "USD",
      "visible": false
    },
    {
      "type": "NORMAL",
      "url": "https://example.test/music",
      "isVisible": true
    }
  ],
  "sourceUrl": "https://example.komi.io/",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 2,
    "responseBytes": 18000,
    "durationMs": 750
  }
}

Invalid URL, missing URL, duplicates, or unsupported parameters.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}