> ## 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 Total Earnings

> Get user total earnings data including referral counts, referral credits, and machine earnings if the user is a host.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/v0/user/earnings
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/v0/user/earnings:
    get:
      tags:
        - Accounts
      summary: Get Total Earnings
      description: >-
        Get user total earnings data including referral counts, referral
        credits, and machine earnings if the user is a host.
      operationId: getTotalEarnings
      responses:
        '200':
          description: >-
            Success: {"referral_count": int, "referral_credits": float,
            optionally "machine_earnings": float, "sla_earnings": float,
            "sla_collateral": int}
          content:
            application/json:
              schema:
                type: object
                properties:
                  referral_count:
                    type: integer
                    description: Total number of referred users
                  referral_credits:
                    type: number
                    description: Total referral earnings in dollars
                  machine_earnings:
                    type: number
                    description: Total machine earnings in dollars (host users only)
                  sla_earnings:
                    type: number
                    description: Total SLA earnings in dollars (host users only)
                  sla_collateral:
                    type: number
                    description: SLA collateral amount (host users only)
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key must be provided in the Authorization header

````