> ## Documentation Index
> Fetch the complete documentation index at: https://vastai-80aa3a82-auto-openapi-preview-pr-5002.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Earnings Summary

> Returns an all-time, date-range-independent aggregate of the authenticated user's earnings.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/v1/user/earnings/summary
openapi: 3.1.0
info:
  title: Vast.ai API
  description: >-
    Vast.ai REST API for managing GPU cloud instances, machine operations, and
    AI/ML workflows.


    ## AI Agent Quick-Start


    Install the CLI skill for your agent (Claude Code, Cursor, Windsurf, etc.):
      npx skills add vast-ai/vast-cli

    CLI reference:
    https://raw.githubusercontent.com/vast-ai/vast-cli/master/vastai/SKILL.md

    SDK reference:
    https://raw.githubusercontent.com/vast-ai/vast-cli/master/vastai_sdk/SKILL.md


    ## Auth

    All endpoints require `Authorization: Bearer $VAST_API_KEY`.

    Get your key at: https://cloud.vast.ai/manage-keys/


    ## Key Quirks

    - `gpu_ram` in CLI = GB; in REST API = MB (CLI auto-converts)

    - SSH keys must be registered BEFORE creating an instance (VM: no recovery;
    Docker: can add post-create)

    - `onstart` field is limited to 4048 characters -- gzip+base64 for longer
    scripts

    - `POST /api/v0/asks/{id}/` (create instance) returns `new_contract` as the
    instance ID, not `id`

    - Poll trap: if `actual_status` becomes `exited`, `unknown`, or `offline` it
    will never reach `running` -- destroy and retry
  version: 1.0.0
  contact:
    name: Vast.ai Support
    url: https://discord.gg/vast
  license:
    name: Vast.ai Terms of Service
    url: https://vast.ai/terms/
servers:
  - url: https://console.vast.ai
    description: Production server
security:
  - BearerAuth: []
paths:
  /api/v1/user/earnings/summary:
    get:
      tags:
        - Accounts
      summary: Get Earnings Summary
      description: >-
        Returns an all-time, date-range-independent aggregate of the
        authenticated user's earnings.
      operationId: getEarningsSummary
      responses:
        '200':
          description: >-
            Success: {"success": true, "summary": {"gpu_earn": float,
            "sto_earn": float, "bwu_earn": float, "bwd_earn": float, "sla_earn":
            float, "referral_earn": float, "referral_count": int, "total_earn":
            float, "reliability": float|null}}
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always true
                  summary:
                    type: object
                    description: >-
                      Aggregate earnings object with gpu_earn, sto_earn,
                      bwu_earn, bwd_earn, sla_earn, referral_earn,
                      referral_count, total_earn, and reliability fields
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key must be provided in the Authorization header

````