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

# Get v1balance

> Agent sessions read their bound account; a different accountId returns not found. Browser owner sessions retain accountId selection. Base chains only.



## OpenAPI

````yaml /openapi/platform.json get /v1/balance
openapi: 3.1.0
info:
  title: GOL Platform API
  description: >-
    Versioned GOL developer and consumer API. Consumer routes are mounted when
    their runtime integrations are configured.
  version: 0.8.0-rc.1
servers:
  - url: http://localhost:4100
    description: Local development
security: []
tags:
  - name: system
  - name: authentication
  - name: projects
  - name: api-keys
  - name: audit
  - name: gas-executions
  - name: gas-policies
  - name: webhooks
paths:
  /v1/balance:
    get:
      tags:
        - Balance
      description: >-
        Agent sessions read their bound account; a different accountId returns
        not found. Browser owner sessions retain accountId selection. Base
        chains only.
      operationId: getBalance
      parameters:
        - name: accountId
          in: query
          required: false
          schema:
            type: string
        - name: focusChainRef
          in: query
          required: false
          schema:
            type: string
            enum:
              - eip155:8453
              - eip155:84532
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnifiedBalance'
        '400':
          description: invalid_request response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerError'
        '401':
          description: unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerError'
        '403':
          description: forbidden response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerError'
        '404':
          description: not_found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerError'
        '429':
          description: rate_limited response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerError'
        '500':
          description: internal_error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerError'
      security:
        - bearerAuth: []
components:
  schemas:
    UnifiedBalance:
      type: object
      properties:
        totalFiat:
          type: number
        change24h:
          type: number
        stablecoinFiat:
          type: number
        holdings:
          type: array
          items:
            $ref: '#/components/schemas/ValuedHolding'
        tokens:
          type: array
          items:
            $ref: '#/components/schemas/TokenBalance'
        status:
          type: string
          enum:
            - ready
            - building
            - degraded
        asOf:
          format: date-time
          type: string
      required:
        - totalFiat
        - change24h
        - stablecoinFiat
        - holdings
        - tokens
        - status
        - asOf
    ConsumerError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - forbidden
                - not_found
                - rate_limited
                - service_unavailable
                - internal_error
                - capability_unavailable
                - conflict
            message:
              type: string
            correlationId:
              type: string
          required:
            - code
            - message
            - correlationId
      required:
        - error
    ValuedHolding:
      type: object
      properties:
        assetRef:
          type: string
          pattern: '^eip155:(8453|84532)/(erc20|slip44):'
        symbol:
          type: string
        amount:
          type: number
        priceUsd:
          type: number
        fiat:
          type: number
        priceAdvisory:
          type: boolean
      required:
        - assetRef
        - symbol
        - amount
        - priceUsd
        - fiat
        - priceAdvisory
    TokenBalance:
      type: object
      properties:
        symbol:
          type: string
        name:
          type: string
        chain:
          type: string
        chainId:
          type: integer
          enum:
            - 8453
            - 84532
        tokenAddress:
          pattern: ^0x[0-9a-fA-F]{40}$
          type: string
        decimals:
          type: integer
        amount:
          type: number
        fiat:
          type: number
        price:
          type: number
        change24h:
          type: number
        isStablecoin:
          type: boolean
        peg:
          oneOf:
            - type: object
              properties:
                symbol:
                  type: string
                status:
                  type: string
                  enum:
                    - unknown
                asOf:
                  format: date-time
                  type: string
              required:
                - symbol
                - status
                - asOf
            - type: 'null'
        spendable:
          type: boolean
        source:
          type: string
          enum:
            - discovered
            - imported
        amountRaw:
          type: string
        unrecognized:
          type: boolean
      required:
        - symbol
        - name
        - chain
        - chainId
        - tokenAddress
        - decimals
        - amount
        - fiat
        - price
        - change24h
        - isStablecoin
        - peg
        - spendable
        - source
        - amountRaw
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Opaque owner, CLI, or agent session token. Agent tokens are accepted
        only where marked.

````

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