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

# SERP API overview

> Get SERP API subscription overview: plan, credits used/remaining, status. Permission: `serp_api:read`.



## OpenAPI

````yaml /openapi-account.json get /v4/account/{subAccountId}/serp-api/overview
openapi: 3.0.3
info:
  title: ProxyScrape Account API
  description: Account API — authenticate with the api-token header.
  version: 1.0.0
servers:
  - url: https://api.proxyscrape.com
    description: ProxyScrape API
security:
  - apiToken: []
tags:
  - name: API key management
    description: Create, list, update, regenerate, and revoke API keys
  - name: Subaccounts
    description: List subaccounts and manage preferences
  - name: Datacenter
    description: 'Datacenter shared and dedicated: overview, proxy list, usage, whitelist'
  - name: Residential
    description: 'Residential (bandwidth): overview, subusers, usage'
  - name: Residential unlimited
    description: 'Residential unlimited: overview, statistics, password'
  - name: SERP API
    description: 'SERP API: overview, subusers, search'
  - name: API ordering
    description: >-
      Place wallet-paid orders and read the wallet balance via the headless API
      ordering surface.
paths:
  /v4/account/{subAccountId}/serp-api/overview:
    get:
      tags:
        - SERP API
      summary: SERP API overview
      description: >-
        Get SERP API subscription overview: plan, credits used/remaining,
        status. Permission: `serp_api:read`.
      operationId: getSerpApiOverview
      parameters:
        - name: subAccountId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: SERP API overview
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    type: string
                  credits_used:
                    type: integer
                  credits_limit:
                    type: integer
                  status:
                    type: string
      security:
        - apiToken: []
components:
  securitySchemes:
    apiToken:
      type: apiKey
      in: header
      name: api-token
      description: >-
        API key. Create and manage keys at /v4/account/api-keys or in the
        dashboard.

````