SimilarWeb

SimilarWeb Account API

Account credits, capabilities, and usage information

GitHub OpenAPI

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v3/batch/credits Check remaining data credits · Get Remaining Credits #
Ask an LLM
“How many data credits do I have left on my Similarweb account?”
“Am I about to run out of credits for batch data pulls?”
Tell an agent
Show my remaining data credit balance.
Tell me how many batch credits are left on the account.
GET /v1/website/{domain_name}/capabilities Check what my subscription covers for a site · Check Capabilities #
Ask an LLM
“What data does my subscription let me pull for a given website?”
“Which capabilities does my plan include when I look up a domain?”
Tell an agent
Check what my subscription can access for {domain_name}.
Show the account capability overview for the domain {domain_name}.

Documentation

📖
Documentation
https://developers.similarweb.com/
📖
GettingStarted
https://developers.similarweb.com/docs/getting-started
📖
Authentication
https://developers.similarweb.com/docs/authentication
📖
RateLimits
https://developers.similarweb.com/docs/rate-limit

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/similarweb/refs/heads/main/openapi/similarweb-account-api-openapi.yml

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/similarweb:similarweb-account-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

similarweb-account-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SimilarWeb REST Account API
  description: The SimilarWeb REST API provides real-time access to digital intelligence data covering website traffic and engagement metrics, traffic source breakdowns, audience demographics, keyword and search intelligence, mobile app performance, technographic data, e-commerce shopper behavior, company firmographics, and rank tracking. Authentication is via API key and usage is metered on a data credit model.
  version: 4.0.0
  termsOfService: https://www.similarweb.com/corp/legal/terms-of-use/
  contact:
    name: SimilarWeb Support
    url: https://support.similarweb.com/hc/en-us/articles/22089555897373-REST-API
  license:
    name: Proprietary
    url: https://www.similarweb.com/corp/legal/terms-of-use/
servers:
- url: https://api.similarweb.com
  description: SimilarWeb API server
tags:
- name: Account
  description: Account credits, capabilities, and usage information
paths:
  /v3/batch/credits:
    get:
      operationId: getCredits
      summary: Get Remaining Credits
      description: Retrieve the current remaining data credits available on the account.
      tags:
      - Account
      security:
      - apiKeyHeader: []
      responses:
        '200':
          description: Remaining credits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditsResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
  /v1/website/{domain_name}/capabilities:
    get:
      operationId: checkCapabilities
      summary: Check Capabilities
      description: Retrieve account capability overview based on subscription.
      tags:
      - Account
      security:
      - apiKeyQuery: []
      parameters:
      - $ref: '#/components/parameters/domainName'
      - $ref: '#/components/parameters/apiKeyQuery'
      responses:
        '200':
          description: Account capabilities
          content:
            application/json:
              schema:
                type: object
                properties:
                  capabilities:
                    type: array
                    items:
                      type: string
        '400':
          description: Bad request
components:
  parameters:
    domainName:
      name: domain_name
      in: path
      required: true
      schema:
        type: string
        example: example.com
      description: Website domain without 'www.' prefix
    apiKeyQuery:
      name: api_key
      in: query
      required: true
      schema:
        type: string
      description: SimilarWeb API authentication key
  schemas:
    CreditsResponse:
      type: object
      properties:
        credits:
          type: integer
          description: Remaining data credits on the account
          example: 1234
  securitySchemes:
    apiKeyQuery:
      type: apiKey
      in: query
      name: api_key
      description: SimilarWeb API key passed as a query parameter
    apiKeyHeader:
      type: apiKey
      in: header
      name: api-key
      description: SimilarWeb API key passed as a request header
externalDocs:
  description: SimilarWeb Developer Documentation
  url: https://developers.similarweb.com/