> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scraperize.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a public Komi page

> Fetches a public Komi.io creator page by URL: the profile (name, display name, avatar, socials, theme) and its content sections — each with its title and the items it holds (links, products with prices, YouTube videos, podcast with streaming links, mailing-list forms, …), every item with its title, url and image.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/komi/page
openapi: 3.0.3
info:
  title: Scraperize API
  version: 1.0.0
  description: >-
    Extract public data from social media platforms as clean JSON. Endpoints are
    split by platform and by what they return, e.g. `GET /v1/twitter/tweet`.


    ## Authentication

    Send your API key in the `x-api-key` header (or `Authorization: Bearer
    <key>`). Create keys in your dashboard.


    ## Credits

    Each successful live scrape costs **1 credit**. Credits are prepaid and
    never expire.


    ## Caching

    Every endpoint accepts an optional `cache_max_age`
    (`1d`|`3d`|`7d`|`14d`|`30d`). A cache hit within that window is returned for
    **0 credits**.


    ## Responses

    Success returns `{ "data": …, "meta": { "requestId", … } }`. Errors return
    `{ "error": { "code", "message", "requestId" } }` with a matching HTTP
    status. `meta` on a scrape carries `creditsCharged`, `creditsRemaining`,
    `cached`, and (on a hit) `cachedAt`.


    ## Rate limits

    Requests are limited per team per minute; over the limit returns `429` with
    a `Retry-After` header.
servers:
  - url: https://api.scraperize.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Twitter
    description: Twitter / X scraping endpoints
  - name: Facebook
    description: Facebook scraping endpoints
  - name: Linkme
    description: Linkme (link.me) scraping endpoints
  - name: Amazon
    description: Amazon (creator shop / storefront) scraping endpoints
  - name: Linkbio
    description: Linkbio (lnk.bio) scraping endpoints
  - name: Pillar
    description: Pillar (pillar.io) scraping endpoints
  - name: Komi
    description: Komi (komi.io) scraping endpoints
  - name: Linktree
    description: Linktree (linktr.ee) scraping endpoints
  - name: Kick
    description: Kick (kick.com) scraping endpoints
  - name: Snapchat
    description: Snapchat (snapchat.com) scraping endpoints
  - name: Telegram
    description: Telegram (t.me) scraping endpoints
  - name: Google
    description: Google Search scraping endpoints
paths:
  /v1/komi/page:
    get:
      tags:
        - Komi
      summary: Get a public Komi page
      description: >-
        Fetches a public Komi.io creator page by URL: the profile (name, display
        name, avatar, socials, theme) and its content sections — each with its
        title and the items it holds (links, products with prices, YouTube
        videos, podcast with streaming links, mailing-list forms, …), every item
        with its title, url and image.
      parameters:
        - name: url
          in: query
          required: true
          description: Public Komi page URL, e.g. https://shxtsngigs.komi.io.
          schema:
            type: string
          example: https://shxtsngigs.komi.io
        - name: cache_max_age
          in: query
          required: false
          description: >-
            Optional. Return a cached result if one this age or newer exists —
            served for **0 credits** with `meta.cached=true` and
            `meta.cachedAt`. Otherwise a fresh scrape runs (**1 credit**) and
            refreshes the cache. Omit to always scrape fresh.
          schema:
            type: string
            enum:
              - 1d
              - 3d
              - 7d
              - 14d
              - 30d
          example: 7d
      responses:
        '200':
          description: The Komi page.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      page:
                        type: object
                      fetchedAt:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    description: >-
                      requestId + credit/caching metadata (creditsCharged,
                      creditsRemaining, cached, cachedAt).
                required:
                  - data
                  - meta
              example:
                data:
                  page:
                    username: shxtsngigs
                    name: ShxtsNGigs
                    displayName: ShxtsNGigs
                    displayNameType: IMAGE
                    displayNameImageUrl: >-
                      https://komi-production-assets.s3-accelerate.amazonaws.com/photos/qpUoVqwkkPOn4iRdqNdnz.png
                    avatarUrl: >-
                      https://komi-production-assets.s3-accelerate.amazonaws.com/photos/y9apL0SDVc6CrGkUElA6k.jpg?tr=w-810%2Ch-1018%2Ccm-extract%2Cx-0%2Cy-0&crp=%7B%22x%22%3A0%2C%22y%22%3A40.68571428571428%2C%22zoomVal%22%3A1%7D
                    avatarRatio: 1.25
                    category: null
                    currency: USD
                    status: active
                    isActive: true
                    createdAt: '2024-03-19T11:32:59.680Z'
                    updatedAt: '2024-07-04T10:55:41.860Z'
                    theme:
                      type: CUSTOM
                      backgroundColor: '#D02E26'
                      typographyColor: '#FFFFFF'
                      overlayColor: '#FFFFFF'
                      overlayOpacity: 0.1
                      showNavBar: true
                      showDisplayName: true
                    socialLinks:
                      - type: TIKTOK
                        url: https://www.tiktok.com/@shxtsngigs
                      - type: INSTAGRAM
                        url: https://www.instagram.com/shxtsngigs/
                      - type: YOUTUBE
                        url: https://www.youtube.com/@ShtsNGigsPodcast
                    sections:
                      - id: 54ac6f12-45d8-45bc-8b49-7effd634daa8
                        title: Daddy's Home Live Tour
                        order: 1
                        showTitle: true
                        items:
                          - id: 0b7b97c1-8ae4-4ac9-ba7b-a3805963e231
                            type: LINK
                            title: 'UK & Ireland Tour Tickets! '
                            subtitle: null
                            url: >-
                              https://www.livenation.co.uk/shxtsngigs-tickets-adp1406143
                            imageUrl: >-
                              https://komi-production-assets.s3-accelerate.amazonaws.com/photos/x0hzq2QRLdBkF2wMKxHOM.jpg
                            order: 0
                            variant: null
                            price: null
                            currency: null
                            numberOfEpisodes: null
                            links: null
                            cta: null
                            fields: null
                            videos: null
                      - id: dc6133a6-6e36-433b-ac17-0f909fca27fd
                        title: Mailing list
                        order: 2
                        showTitle: true
                        items:
                          - id: f73f0042-b1f8-426a-be34-7319e03dda92
                            type: DATA_CAPTURE_SIGNUP
                            title: SNG mailing list
                            subtitle: >-
                              Sign up to the mailing list to be the first to
                              know about new tour dates! 
                            url: null
                            imageUrl: >-
                              https://komi-production-assets.s3-accelerate.amazonaws.com/photos/fjs8sXjLet7-wbNlciDD6.jpg
                            order: 0
                            variant: data-capture
                            price: null
                            currency: null
                            numberOfEpisodes: null
                            links: null
                            cta: Subscribe
                            fields:
                              - name: email
                                label: Email
                                type: email
                                required: true
                                placeholder: Enter your email address
                              - name: name
                                label: Full Name
                                type: full_name
                                required: true
                                placeholder: Full name
                              - name: dob
                                label: Date of birth
                                type: date_of_birth
                                required: true
                                placeholder: null
                            videos: null
                      - id: 97900181-dcf8-4f81-95fe-b06ade975b62
                        title: Shop the Merch
                        order: 3
                        showTitle: true
                        items:
                          - id: b4032ffc-3267-4288-bfbc-8cd8ca8105c6
                            type: PRODUCT
                            title: Varsity Jacket
                            subtitle: null
                            url: https://shxtsngigs.store/products/jacket
                            imageUrl: >-
                              https://komi-production-assets.s3-accelerate.amazonaws.com/photos/WTnxuCTIgdEwQhsPQyD-Y.png
                            order: 1
                            variant: null
                            price: 140
                            currency: GBP
                            numberOfEpisodes: null
                            links: null
                            cta: null
                            fields: null
                            videos: null
                          - id: fbb78327-7ee7-42da-8e58-7f07e731e542
                            type: PRODUCT
                            title: Joggers
                            subtitle: null
                            url: https://shxtsngigs.store/products/joggers
                            imageUrl: >-
                              https://komi-production-assets.s3-accelerate.amazonaws.com/photos/rKHibxsR7PZ9eZlKdRAmD.png
                            order: 5
                            variant: null
                            price: 60
                            currency: GBP
                            numberOfEpisodes: null
                            links: null
                            cta: null
                            fields: null
                            videos: null
                    sectionCount: 9
                    itemCount: 16
                  fetchedAt: '2026-09-14T12:14:44.062Z'
                meta:
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
                  creditsCharged: 1
                  creditsRemaining: 4999
                  cached: false
        '401':
          description: Missing, invalid, or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: UNAUTHORIZED
                  message: API key required — pass it in the `x-api-key` header.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '402':
          description: Not enough credits for this request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: INSUFFICIENT_CREDITS
                  message: >-
                    This request costs 1 credit, but your balance is 0. Top up
                    to continue.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '404':
          description: Page not found / unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: NOT_FOUND
                  message: >-
                    The requested content was not found (it may not exist, be
                    deleted, or be private).
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '422':
          description: Invalid query parameters (missing or malformed url).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: VALIDATION_ERROR
                  message: Request validation failed
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
                  details:
                    - path: url
                      message: Required
        '429':
          description: Over the per-minute rate limit — honour `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: RATE_LIMITED
                  message: >-
                    Rate limit exceeded — max 100 requests per 60s. Retry in
                    ~30s.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
        '502':
          description: Upstream block.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: UPSTREAM_BLOCKED
                  message: >-
                    The source was temporarily unavailable. Please try again
                    shortly.
                  requestId: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: NOT_FOUND
            message:
              type: string
              example: The requested content was not found.
            requestId:
              type: string
              example: req_8f0c2b7e-1a2b-4c3d-9e8f-0a1b2c3d4e5f
            details:
              type: array
              items:
                type: object
              description: Present on validation errors.
          required:
            - code
            - message
            - requestId
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your API key. Send it in the `x-api-key` header (or `Authorization:
        Bearer <key>`). Create and manage keys from your dashboard.

````