KOLens X API

The X API from KOLens — 1 operation(s) for x.

GitHub OpenAPI

Operations 1

POST /api/x/scrape Submit X Scrape #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/kolens-ai:kolens-ai-x-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kolens-ai-x-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: KOLens X API
  description: KOLens — TikTok KOL Intelligence API. Search keywords, extract KOL profiles, collect contact info, export reports.
  version: 1.0.0
tags:
- name: X
paths:
  /api/x/scrape:
    post:
      tags:
      - X
      summary: Submit X Scrape
      description: 'Submit an X (Twitter) scrape job.


        Pre-charges credits using the same ``ceil(max_tweets / 10)`` shape

        as the YT / IG routes. The apidojo X actor is cheaper per item

        (~$0.40 / 1K tweets vs ~$2.40 / 1K YT videos) so this is a

        conservative over-estimate until the cross-cutting

        pricing-per-platform sub-issue lands.'
      operationId: submit_x_scrape_api_x_scrape_post
      security:
      - HTTPBearer: []
      parameters:
      - name: x-kolens-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Kolens-User-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XScrapeRequest'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XScrapeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    XScrapeRequest:
      properties:
        query:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Query
        handles:
          anyOf:
          - items:
              type: string
            type: array
            maxItems: 50
          - type: 'null'
          title: Handles
        max_tweets:
          type: integer
          maximum: 200.0
          minimum: 1.0
          title: Max Tweets
          default: 50
      type: object
      title: XScrapeRequest
      description: 'Either ``query`` or ``handles`` must be supplied — not both.

        ``max_tweets`` follows the IG / YT semantics: the number of recent

        tweets to pull per handle (NOT the total across the batch).'
    XScrapeResponse:
      properties:
        job_id:
          type: string
          title: Job Id
        status:
          type: string
          title: Status
        keyword:
          type: string
          title: Keyword
        estimated_seconds:
          type: integer
          title: Estimated Seconds
        query_plan:
          anyOf:
          - $ref: '#/components/schemas/QueryPlanEcho'
          - type: 'null'
      type: object
      required:
      - job_id
      - status
      - keyword
      - estimated_seconds
      title: XScrapeResponse
    QueryPlanEcho:
      properties:
        raw_query:
          type: string
          title: Raw Query
        search_terms:
          items:
            type: string
          type: array
          title: Search Terms
          default: []
        filters:
          type: object
          title: Filters
          default: {}
        market:
          anyOf:
          - type: string
          - type: 'null'
          title: Market
        language:
          anyOf:
          - type: string
          - type: 'null'
          title: Language
        notes:
          type: string
          title: Notes
          default: ''
      type: object
      required:
      - raw_query
      title: QueryPlanEcho
      description: 'Display-only echo of how the NL query planner interpreted a typed

        intent sentence (Phase 1). Returned on the create / search-submit

        response so the UI can show "Interpreted as: [terms] · filters".


        Only present when the planner flag is ON *and* the planner produced a

        real (non-passthrough) interpretation — null otherwise so existing

        clients ignore it. An editable confirm step is Phase 2.'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer