---
title: "Get a Komi profile"
method: GET
path: "/v1/komi"
tags: ["Komi"]
---

# Get a Komi profile

`GET /v1/komi`

## Request

- Base URL: `https://api.scrapeatlas.com`
- URL: `https://api.scrapeatlas.com/v1/komi`
- Auth: API key in header `x-api-key`

Pass one public Komi profile URL. Tracking parameters and fragments are removed. Returned URLs are data; their destinations are never fetched. Each successful request costs 1 account credit, including partial results. Failed requests cost 0 credits.

## Query parameters

- `url` string, uri, required: HTTPS <username>.komi.io profile URL only. No credentials, ports or paths. Tracking parameters and fragments are removed.

## Response `200`

Inspect the response status and failure or coverage fields.

- union
  - object
    - `id` string, uuid, required
    - `username` string, required
    - `avatar` string, nullable, required
    - `bio` string, nullable, required
    - `firstName` string, nullable, required
    - `lastName` string, nullable, required
    - `displayName` string, nullable, required
    - `displayNameImage` string, nullable, required
    - `website` string, nullable, required
    - `instagram` string
    - `tiktok` string
    - `youtube` string
    - `twitter` string
    - `facebook` string
    - `snapchat` string
    - `spotify` string
    - `apple_music` string
    - `deezer` string
    - `soundcloud` string
    - `twitch` string
    - `discord` string
    - `linkedin` string
    - `email` string
    - `links` object[], required
      - `id` union
        - string
        - number
      - `type` string, required
      - `url` string, nullable
      - `title` string, nullable
      - `order` number
      - `visible` boolean
      - `thumbnail` string, nullable
      - `moduleId` string, nullable
      - `versionId` string, nullable
      - `price` union
        - number
        - string
      - `currency` string, nullable
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `success` true, required
    - `status` 'success' | 'partial', required
    - `sourceUrl` string, uri, required
    - `fetchedAt` string, date-time, required
    - `coverage` object, required
      - `source` 'public_api', required
      - `complete` boolean, required
      - `warnings` string[], required
      - `moduleFailure` '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'
  - object
    - `requestId` string, uuid, required
    - `accounting` object, required
      - `upstreamRequests` integer, required
      - `responseBytes` integer, required
      - `durationMs` number, required
    - `success` false, required
    - `status` 'failed' | 'challenged', required
    - `failure` object, required
      - `code` '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', required
      - `message` string, required

## Other responses

- `400`: Request could not complete; inspect error or failure.code.
- `401`: Request could not complete; inspect error or failure.code.
- `402`: Request could not complete; inspect error or failure.code.
- `403`: Request could not complete; inspect error or failure.code.
- `404`: Request could not complete; inspect error or failure.code.
- `408`: Request could not complete; inspect error or failure.code.
- `413`: Request could not complete; inspect error or failure.code.
- `429`: Request could not complete; inspect error or failure.code.
- `500`: Request could not complete; inspect error or failure.code.
- `502`: Request could not complete; inspect error or failure.code.
- `503`: Request could not complete; inspect error or failure.code.
- `504`: Request could not complete; inspect error or failure.code.

---

[API](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api.md) · [All operations](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapeatlas/apis/scrapeatlas-api/revisions/9ba049316894?raw)