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

# Account Summary

> Get usage and balance summary for the authenticated account.



## OpenAPI

````yaml api_specs.yaml GET /v1/account
openapi: 3.0.0
info:
  title: TAMradar API
  version: '1.0'
  description: Canonical OpenAPI spec for TAMradar customer-facing APIs.
servers:
  - url: https://api.tamradar.com
    description: Production API server
security: []
paths:
  /v1/account:
    get:
      tags:
        - Account
      summary: Get account summary
      description: >-
        Returns the user's remaining balance in USD, active/inactive radar
        counts, and usage metrics for the requested calendar month.


        **Account Section**: Current radar status counts across all time
        (mutually exclusive categories).


        **Usage Section**: Monthly activity metrics that track different events
        during the specified month. Note that the same radar can appear in
        multiple usage metrics if it underwent multiple state changes (e.g.,
        created and then deactivated in the same month).


        - `radars_activated`: Successfully created radars (excluding failed
        radars)

        - `radars_deactivated`: User-initiated radar deactivations, or radars
        that were deactivated due to insufficient funds

        - `radars_failed`: Radars that transitioned to failed status (regardless
        of creation date)
      operationId: getAccountSummary
      parameters:
        - name: month
          in: query
          description: >-
            Optional month to scope usage metrics to (UTC). Format YYYY-MM.
            Defaults to current month when omitted.
          required: false
          schema:
            type: string
            pattern: ^\d{4}-\d{2}$
            example: 2025-06
      responses:
        '200':
          description: Account summary retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                  code:
                    type: integer
                    enum:
                      - 200
                  timestamp:
                    type: string
                    format: date-time
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      usage:
                        type: object
                        description: >-
                          Monthly activity metrics for the specified month
                          period
                        properties:
                          month:
                            type: string
                            pattern: ^\d{4}-\d{2}$
                            description: The month these usage metrics cover
                          balance_used_usd:
                            type: number
                            format: float
                            description: Total USD spent on radar credits during this month
                          radars_activated:
                            type: integer
                            description: >-
                              Number of radars successfully created this month
                              (excluding those that failed during initial setup)
                          radars_deactivated:
                            type: integer
                            description: >-
                              Number of radars that were deactivated by user
                              action during this month
                          radars_failed:
                            type: integer
                            description: >-
                              Number of radars that transitioned to failed
                              status during this month (regardless of when they
                              were originally created)
                          updates_found:
                            type: integer
                            description: >-
                              Number of radar findings approved during this
                              month. Counts the moment a finding was approved
                              and became accessible to the customer (via webhook
                              or read API). Consistent across all pricing
                              models.
                      account:
                        type: object
                        description: Current radar status counts across all time
                        properties:
                          total_radars:
                            type: integer
                            description: >-
                              Total number of radars ever created for this
                              account
                          active_radars:
                            type: integer
                            description: Number of radars currently running and monitoring
                          inactive_radars:
                            type: integer
                            description: >-
                              Number of radars currently deactivated (user
                              cancelled, insufficient funds, or admin action)
                          failed_radars:
                            type: integer
                            description: >-
                              Number of radars currently in failed status
                              (missing prerequisites, source inaccessible, or
                              error)
                          total_updates_found:
                            type: integer
                            description: >-
                              Total number of radar findings approved across all
                              time for this account. Not scoped to any month —
                              reflects the full lifetime count.
                      balance_remaining_usd:
                        type: number
                        format: float
              example:
                status: success
                code: 200
                timestamp: '2025-07-08T07:50:34.000Z'
                message: Account summary retrieved
                data:
                  usage:
                    month: 2026-04
                    radars_activated: 10
                    balance_used_usd: 1.92
                    radars_deactivated: 5
                    radars_failed: 2
                    updates_found: 127
                  account:
                    total_radars: 182
                    active_radars: 16
                    inactive_radars: 164
                    failed_radars: 2
                    total_updates_found: 5590
                  balance_remaining_usd: 29.85
        '400':
          description: Bad Request – Invalid month parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: error
                code: 400
                message: Invalid month parameter. Expected format YYYY-MM.
                errors:
                  - field: month
                    reason: Bad format, expected YYYY-MM
                timestamp: '2026-04-23T17:05:26.000Z'
                error_id: f72ac8d3-4bca-4f4c-b14a-30af90e3eac2
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: error
                code: 401
                message: Authentication required
                errors:
                  - field: x-api-key
                    reason: Missing or invalid API key
                timestamp: '2026-04-23T17:05:26.000Z'
                error_id: f72ac8d3-4bca-4f4c-b14a-30af90e3eac2
        '429':
          description: >-
            Rate limit exceeded — no operation was performed. Check
            `Retry-After` to know when to retry, or `X-RateLimit-Remaining` to
            know your current budget.
          headers:
            Retry-After:
              schema:
                type: integer
              description: Seconds until your budget is restored
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Your per-minute budget for this endpoint
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Tokens remaining right now
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                minute_limit:
                  summary: Per-minute budget exhausted
                  value:
                    status: error
                    code: 429
                    message: Per-minute rate limit exceeded. Retry after 45 seconds.
                    errors:
                      - field: rate_limit
                        reason: minute
                    timestamp: '2026-04-23T17:05:26.000Z'
                    error_id: f72ac8d3-4bca-4f4c-b14a-30af90e3eac2
                burst_limit:
                  summary: Per-second burst limit hit
                  value:
                    status: error
                    code: 429
                    message: Per-second burst limit exceeded. Retry after 1 second.
                    errors:
                      - field: rate_limit
                        reason: burst
                    timestamp: '2026-04-23T17:05:26.000Z'
                    error_id: f72ac8d3-4bca-4f4c-b14a-30af90e3eac2
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                status: error
                code: 500
                message: An internal server error occurred.
                errors: []
                timestamp: '2026-04-23T17:05:26.000Z'
                error_id: f72ac8d3-4bca-4f4c-b14a-30af90e3eac2
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      required:
        - status
        - code
        - message
        - errors
        - timestamp
        - error_id
      properties:
        status:
          type: string
          enum:
            - error
        code:
          type: integer
          enum:
            - 400
            - 401
            - 402
            - 403
            - 404
            - 409
            - 429
            - 500
            - 503
        message:
          type: string
        errors:
          type: array
          items:
            type: object
            required:
              - field
              - reason
            properties:
              field:
                type: string
              reason:
                type: string
              conflicting_radar_id:
                type: string
                format: uuid
                nullable: true
        timestamp:
          type: string
          format: date-time
        error_id:
          type: string
          format: uuid
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````