crawio-com API

openapi: 3.1.0
info:
  title: crawio-com API
  version: '2026-10-30'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-30: 4 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; crawio-com has published no machine-readable contract that the
    pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 1
    documentation: 3
    pages-with-code: 1
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-30'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://crawio.com/docs
servers:
- url: https://api.crawio.com
paths:
  /account:
    get:
      operationId: get_account
      tags:
      - Account
      summary: Your plan, the credits left in this billing period and your concurrent requests.
      x-source: https://crawio.com/docs
      parameters:
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: Your API key
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountResponse'
      x-evidence:
        kind: documentation
  /plugin/google/maps/reviews:
    get:
      operationId: get_plugin_google_maps_reviews
      tags:
      - Plugin
      summary: 'Get a place''s reviews as clean JSON: rating, date, text, likes, photos, the owner''s response, the reviewer and, for restaurants,
        the visit details.'
      x-source: https://crawio.com/docs
      parameters:
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: Your API key
      - name: place_id
        in: query
        required: false
        schema:
          type: string
        description: The place, like ChIJAyikp57iwogRFaRCSiDTihE. Send this or data_id.
      - name: data_id
        in: query
        required: false
        schema:
          type: string
        description: The place, like 0x88c2e29ea7a42803:0x118ad3204a42a415. Send this or place_id.
      - name: sort_by
        in: query
        required: false
        schema:
          type: string
        description: most_relevant (default), newest, highest_rating or lowest_rating.
      - name: num
        in: query
        required: false
        schema:
          type: number
        description: 'Reviews per page: 10 (default) or 20.'
      - name: pages
        in: query
        required: false
        schema:
          type: number
        description: How many pages in one call, 1 (default) to 10.
      - name: next_page_token
        in: query
        required: false
        schema:
          type: string
        description: 'Where to continue: search_information.next_page_token of an earlier answer.'
      - name: topic_id
        in: query
        required: false
        schema:
          type: string
        description: 'Only reviews about one topic: an id from the topics list of an earlier answer.'
      - name: query
        in: query
        required: false
        schema:
          type: string
        description: Only reviews that mention a word, like parking.
      - name: session
        in: query
        required: false
        schema:
          type: string
        description: Keeps the calls of one place on one IP.
      - name: hl
        in: query
        required: false
        schema:
          type: string
        description: Language of the reviews, like en (default), de or pt-BR.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPluginGoogleMapsReviewsResponse'
      x-evidence:
        kind: documentation
  /plugin/google/maps/search:
    get:
      operationId: get_plugin_google_maps_search
      tags:
      - Plugin
      summary: 'Google Maps and get the places back as clean JSON: name, rating, reviews, category, address, phone, website, opening state, coordinates
        and attributes.'
      x-source: https://crawio.com/docs
      parameters:
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: Your API key
      - name: q
        in: query
        required: true
        schema:
          type: string
        description: What to search for, like coffee shops austin.
      - name: ll
        in: query
        required: false
        schema:
          type: string
        description: 'Optional: an exact map spot to search around, as coordinates or a Google Maps link.'
      - name: start
        in: query
        required: false
        schema:
          type: number
        description: 'Result offset for the next pages: 0, 20, 40 and so on.'
      - name: pages
        in: query
        required: false
        schema:
          type: number
        description: How many pages from start in one search, 1 (default) to 10.
      - name: session
        in: query
        required: false
        schema:
          type: string
        description: Keeps every page on one IP.
      - name: hl
        in: query
        required: false
        schema:
          type: string
        description: Language of the results, like en (default), de or pt-BR.
      - name: gl
        in: query
        required: false
        schema:
          type: string
        description: Google country, a two-letter code like us (default) or de.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPluginGoogleMapsSearchResponse'
      x-evidence:
        kind: documentation
  /scrape:
    post:
      operationId: post_scrape
      tags:
      - Scrape
      summary: POST /scrape
      x-source: https://crawio.com/docs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostScrapeRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Python Copy curl -X POST https://api.crawio.com/scrape  -H "x-api-key: YOUR_API_KEY"  -H "content-type: application/json"  -H
          "Idempotency-Key: 8f14e45f-ea6f-4b1c-9f7a-2c1d3e4b5a60"  -d ''{"url": "https://example.com"}'' Reuse a key only to retry the same request.
          Once its response has been returned to you, that key is finished and reusing it returns 409. A 502, 503 or 504 says in its body whet'
components:
  schemas:
    GetAccountResponse:
      type: object
      properties:
        plan:
          type: string
          description: Your plan.
        status:
          type: string
          description: active, or suspended when requests are paused on your account.
        credits.allowance:
          type: number
          description: Credits this billing period holds.
        credits.used:
          type: number
          description: Credits used in this billing period.
        credits.remaining:
          type: number
          description: Credits left.
        credits.one_time:
          type: boolean
          description: 'true on the free plan: its credits are given once and do not refill.'
        period.start:
          type: string
          description: When this billing period started (UTC).
        period.renews:
          type: string
          description: When your plan renews (UTC).
        concurrency.limit:
          type: number
          description: How many requests can run at the same time.
        concurrency.in_use:
          type: number
          description: How many are running now.
    GetPluginGoogleMapsReviewsResponse:
      type: object
      properties:
        search_parameters:
          type: object
          description: Engine, data_id, place_id, sort_by, num, session.
        search_information:
          type: object
          description: Results count, pages_returned, next_page_token.
        place_info:
          type: object
          description: Place title, address, rating, reviews count, type.
        topics:
          type: array
          description: Review topics with keyword, mentions, id.
        reviews:
          type: array
          description: Reviews with position, rating, date, iso_date, snippet, likes, images, response, user, review_id, source.
        cost:
          type: number
          description: Credits the request used.
    GetPluginGoogleMapsSearchResponse:
      type: object
      properties:
        search_parameters:
          type: object
          description: Search parameters including engine, q, start, hl, gl.
        search_information:
          type: object
          description: Query displayed, results count, next_start, and retried pages.
        local_results:
          type: array
          description: Places with position, title, place_id, gps_coordinates, rating, reviews, type, address, phone, website, open_state, extensions.
        request_id:
          type: string
          description: The reference to quote when you contact support.
        cost:
          type: number
          description: Credits the request used.
    PostScrapeRequest:
      type: object
      properties:
        url:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
security:
- apiKey: []
tags:
- name: Account
- name: Plugin
- name: Scrape