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

# Website Ranking

> Website Ranking — SimilarWeb

<Note>
  **First time?** Point any MCP client at `https://mcp.aisa.one/mcp` — Claude
  Code, Codex, Cursor, VS Code and the rest. Authorization is OAuth: the client
  opens a browser, you click Allow once, and there is no key to paste. The
  commands per client, and what each call costs, are on
  [aisa.one/mcp](https://aisa.one/mcp#connect).
</Note>

[Set this endpoint up in your agent →](https://aisa.one/mcp?from=/api-reference/similarweb/get_similarweb-website-ranking)


## OpenAPI

````yaml openapi/similarweb.json GET /similarweb/website/ranking
openapi: 3.0.3
info:
  title: SimilarWeb API
  version: 1.0.0
  description: >-
    SimilarWeb digital-intelligence data routed through the AIsa gateway:
    website traffic & engagement, ranking, traffic sources, audience, website
    content, and keyword/search insights.


    **Billing model**: SimilarWeb uses a two-phase (pre-authorization ->
    settlement) credit-based model, not a fixed unit price. (1) Before the call,
    an upper bound is estimated from the request dimensions and pre-authorized
    (response header `X-AISA-Estimated-Credits`); (2) the upstream call is made;
    (3) actual consumption is settled (response headers
    `X-AISA-Accounted-Credits`, `X-AISA-Price-USD`).

    - Billing dimensions: metrics x countries x time buckets (time-series
    endpoints); number of returned rows (list endpoints, capped at 20 rows,
    excess auto-truncated).

    - Countries: each country multiplies the cost once; world/global is
    normalized to world.

    - Settlement rounds up to whole credits; charged only when HTTP 2xx and data
    is non-empty; 4xx/5xx or empty data is not charged.
servers:
  - url: https://api.aisa.one/apis/v1
security:
  - BearerAuth: []
paths:
  /similarweb/website/ranking:
    get:
      summary: Website Ranking
      description: >-
        Website Ranking. Response follows the SimilarWeb v5 envelope (meta +
        data). Date constraint: the start_date-end_date span must cover between
        1 and 120 monthly buckets. Geographic coverage: worldwide (ww, default)
        and United States (us) only.
      operationId: get_similarweb_ranking
      parameters:
        - name: domain
          in: query
          required: true
          description: Target domain, e.g. example.com.
          schema:
            type: string
        - name: start_date
          in: query
          required: true
          description: Start month, format YYYY-MM.
          schema:
            type: string
        - name: end_date
          in: query
          required: true
          description: End month, format YYYY-MM.
          schema:
            type: string
        - name: granularity
          in: query
          required: false
          description: 'Time granularity. Allowed: monthly. Default: monthly.'
          schema:
            type: string
            enum:
              - monthly
            default: monthly
        - name: country
          in: query
          required: false
          description: >-
            Two-letter country code. Allowed: us, ww. Default: ww. Coverage is
            limited to ww and us on the current plan.
          schema:
            type: string
            enum:
              - us
              - ww
            default: ww
        - name: web_source
          in: query
          required: false
          description: 'Traffic source device split. Allowed: desktop, mobile_web, total.'
          schema:
            type: string
            enum:
              - desktop
              - mobile_web
              - total
        - name: main_domain_only
          in: query
          required: false
          description: 'Restrict to the main domain only (true/false). Default: True.'
          schema:
            type: boolean
            default: true
      responses:
        '200':
          description: SimilarWeb v5 envelope (meta + data).
          content:
            application/json:
              example:
                meta:
                  request:
                    format: json
                    domain: cnn.com
                    granularity: monthly
                    country: us
                    start_date: '2026-06-01'
                    end_date: '2026-06-30'
                    web_source: total
                    metrics:
                      - country_rank
                      - category_rank
                      - category
                  status: success
                  last_updated: '2026-07-31'
                data:
                  - date: '2026-06-01'
                    country_rank: 69
                    category: News_and_Media
                    category_rank: 5
              schema:
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/SimilarWebMeta'
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        date:
                          type: string
                        country_rank:
                          type: integer
                        category:
                          type: string
                        category_rank:
                          type: integer
components:
  schemas:
    SimilarWebMeta:
      type: object
      description: SimilarWeb v5 response envelope metadata.
      properties:
        status:
          type: string
          description: Upstream status; 'success' on a successful call.
          example: success
        last_updated:
          type: string
          description: Date of the most recent data point available upstream (YYYY-MM-DD).
          example: '2026-06-30'
        request:
          type: object
          description: >-
            Full echo of the normalized upstream request (parameters as
            received).
        query:
          type: object
          description: Pagination/sort echo when applicable (limit, offset, asc, sort).
      required:
        - status
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: AISA API Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.