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

# List account balances

> Requires `account:read`. `debt` is a nullable decimal string populated only from the CCXT per-asset trading balance; non-trading locations return null. Internal provider data and raw exchange responses are never returned.



## OpenAPI

````yaml /openapi/portfobit-openapi.yaml get /accounts/{account_id}/balances
openapi: 3.1.0
info:
  title: Portfobit Open API
  version: 0.1.0
  description: >
    Public REST API for direct API clients, CI, scripts, service accounts,
    third-party agents, and developer integrations.

    Public REST requests use scoped Portfobit Open API keys. OAuth access tokens
    issued for the Portfobit MCP resource are not accepted by `/api/v1/*`
    endpoints.

    Portfobit is crypto-CEX-only. Financial values are decimal strings and
    timestamps are RFC 3339 UTC strings.

    The API never supports withdrawals, external-address transfers,
    cross-exchange transfers, or P2P transfers.
servers:
  - url: https://api.portfobit.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: Context
  - name: Accounts
  - name: Portfolios
  - name: Valuation
  - name: Activity
  - name: Trading
  - name: Market data
  - name: Support
paths:
  /accounts/{account_id}/balances:
    get:
      tags:
        - Accounts
      summary: List account balances
      description: >-
        Requires `account:read`. `debt` is a nullable decimal string populated
        only from the CCXT per-asset trading balance; non-trading locations
        return null. Internal provider data and raw exchange responses are never
        returned.
      operationId: listAccountBalances
      parameters:
        - $ref: '#/components/parameters/AccountId'
        - $ref: '#/components/parameters/Asset'
        - $ref: '#/components/parameters/AssetLocation'
        - $ref: '#/components/parameters/MinValue'
        - $ref: '#/components/parameters/ValueCurrency'
        - $ref: '#/components/parameters/IncludeZero'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          $ref: '#/components/responses/AccountBalancesResponse'
        '400':
          $ref: '#/components/responses/InvalidAssetLocationResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    AccountId:
      name: account_id
      in: path
      required: true
      schema:
        type: string
      description: Connected CEX account ID.
    Asset:
      name: asset
      in: query
      schema:
        type: string
    AssetLocation:
      name: asset_location
      in: query
      schema:
        type: string
        enum:
          - trading
          - earn_flexible
          - earn_locked
          - staking
          - funding
          - derivatives_linear
          - derivatives_inverse
      description: >-
        Balance location. `funding` is the Binance Funding Wallet or OKX Funding
        Account; `derivatives_linear` and `derivatives_inverse` are Binance
        USD-M and COIN-M net margin-balance locations.
    MinValue:
      name: min_value
      in: query
      schema:
        type: string
      description: Decimal-string minimum valuation.
    ValueCurrency:
      name: value_currency
      in: query
      schema:
        type: string
        default: USD
    IncludeZero:
      name: include_zero
      in: query
      schema:
        type: boolean
        default: false
    Limit:
      name: limit
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
    Offset:
      name: offset
      in: query
      schema:
        type: integer
        minimum: 0
        default: 0
  responses:
    AccountBalancesResponse:
      description: Account balance list response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AccountBalancesResponseSchema'
    InvalidAssetLocationResponse:
      description: The requested balance location is not supported.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InvalidAssetLocationResponseSchema'
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  schemas:
    AccountBalancesResponseSchema:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: array
          items:
            type: object
            required:
              - account_id
              - venue
              - asset
              - asset_location
              - free
              - used
              - total
              - debt
              - price
              - value
              - value_currency
              - as_of
            properties:
              account_id:
                type: string
              venue:
                type: string
              asset:
                type: string
              asset_location:
                type: string
                enum:
                  - trading
                  - earn_flexible
                  - earn_locked
                  - staking
                  - funding
                  - derivatives_linear
                  - derivatives_inverse
                description: >-
                  Balance location. The same asset can appear in multiple rows,
                  one per location. `funding` covers Binance Funding Wallet and
                  OKX Funding Account.
              free:
                type: string
                description: >-
                  Immediately available amount for `trading`; zero for
                  non-trading locations.
              used:
                type: string
                description: >-
                  Frozen or committed amount for `trading`; equal to `total` for
                  non-trading locations.
              total:
                type: string
              debt:
                type:
                  - string
                  - 'null'
                description: >-
                  CCXT per-asset debt for `trading`; null for non-trading
                  locations or when the provider omits it.
              price:
                type: string
              value:
                type: string
              value_currency:
                type: string
              as_of:
                type: string
                format: date-time
        meta:
          type: object
          required:
            - total
            - limit
            - offset
            - has_next
            - request_id
            - generated_at
          properties:
            total:
              type: integer
            limit:
              type: integer
            offset:
              type: integer
            has_next:
              type: boolean
            request_id:
              type: string
            generated_at:
              type: string
              format: date-time
      example:
        data:
          - account_id: acc_01H8XFK9A
            venue: binance
            asset: USDT
            asset_location: trading
            free: '900.00'
            used: '100.00'
            total: '1000.00'
            debt: '0.25'
            price: '1.00'
            value: '1000.00'
            value_currency: USD
            as_of: '2026-08-07T08:00:00Z'
        meta:
          total: 1
          limit: 50
          offset: 0
          has_next: false
          request_id: req_01J2K8B7QW
          generated_at: '2026-08-07T08:00:01Z'
    InvalidAssetLocationResponseSchema:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
              const: invalid_asset_location
            message:
              type: string
            details:
              type:
                - object
                - 'null'
        meta:
          $ref: '#/components/schemas/Meta'
      example:
        error:
          code: invalid_asset_location
          message: >-
            asset_location must be one of trading, earn_flexible, earn_locked,
            staking, funding, derivatives_linear, derivatives_inverse.
          details: null
        meta:
          request_id: req_01J2K8B7QW
          generated_at: '2026-09-03T08:00:00Z'
    ErrorEnvelope:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          $ref: '#/components/schemas/Error'
        meta:
          $ref: '#/components/schemas/Meta'
    Meta:
      type: object
      required:
        - request_id
        - generated_at
      properties:
        request_id:
          type: string
        generated_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Portfobit Open API key

````

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