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

# Get account quota

> Check your plan and remaining request budget.

This read does not consume search quota and remains available when quota is exhausted. The response contains account fields directly, without the search envelope. Use `remaining` and `resets_at` before a longer run. See [usage and billing](https://docs.sanfoundation.com/platform/usage-and-billing.md).


## OpenAPI

````yaml https://api.sanfoundation.com/openapi.json GET /v1/account
openapi: 3.0.0
info:
  title: SAN API
  description: >-
    Web data and context for agents, served by a network of miners running real
    browsers on residential connections. One resource per thing an agent asks
    for: search the web, read the news, find places, hotels and flights, and
    quote a symbol. Present an API key as `Authorization: Bearer san_...`. Every
    response is snake_case JSON and every error is `{ error: { code, message,
    param } }`.
  version: 0.0.1
  contact: {}
servers: []
security: []
tags:
  - name: web
    description: Web search
  - name: news
    description: News search
  - name: places
    description: Places search
  - name: hotels
    description: Stays search
  - name: flights
    description: Flight search
  - name: finance
    description: Quotes and charts
  - name: shopping
    description: Products and sellers
  - name: account
    description: Plan and remaining budget
paths:
  /v1/account:
    get:
      tags:
        - account
      summary: Plan and remaining budget
      description: >-
        What the presented key can still spend this month. Check it before a
        long run of searches.
      operationId: AccountController_account
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicAccountDto'
        '400':
          description: A parameter is missing, invalid or not recognized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorDto'
        '401':
          description: Invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorDto'
      security:
        - api_key: []
        - x-api-key: []
components:
  schemas:
    PublicAccountDto:
      type: object
      properties:
        account_id:
          type: string
          format: uuid
        email:
          type: string
          example: someone@example.com
        api_key:
          type: string
          example: san_a1B2c3D4…
          description: The presented key, masked to its display prefix.
        plan:
          type: string
          example: starter
          description: Plan code.
        plan_name:
          type: string
          example: Starter
        plan_price_usd:
          type: number
          example: 12
          description: Price per billing interval, in US dollars.
        quota:
          type: number
          example: 4000
          description: Requests included this month.
        used:
          type: number
          example: 12
          description: Requests used this month.
        remaining:
          type: number
          example: 3988
        resets_at:
          type: string
          example: '2026-10-01T00:00:00.000Z'
          description: When the monthly counter resets.
      required:
        - account_id
        - email
        - api_key
        - plan
        - plan_name
        - plan_price_usd
        - quota
        - used
        - remaining
        - resets_at
    PublicErrorDto:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/PublicErrorBodyDto'
      required:
        - error
    PublicErrorBodyDto:
      type: object
      properties:
        code:
          type: string
          enum:
            - unauthorized
            - missing_parameter
            - invalid_parameter
            - not_found
            - quota_exceeded
            - rate_limited
            - unavailable
            - expired
            - internal_error
          example: missing_parameter
        message:
          type: string
          example: Missing parameter `query`.
        param:
          type: string
          example: query
          description: The parameter at fault, when one parameter is at fault.
      required:
        - code
        - message
  securitySchemes:
    api_key:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: 'Public API key: `Authorization: Bearer san_...`.'
    x-api-key:
      type: apiKey
      in: header
      name: X-Api-Key
      description: The same public API key, as a header.

````

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