---
updatedAt: 2026-05-20T09:39:17.000Z
agentTools:
  projectIndex: https://developer.bitlabs.ai/llms.txt
---

# Get user balance

Get User Balance returns the balance of the user.


# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "2.0.160",
    "title": "BitLabs Client API",
    "description": "BitLabs' public API to be integrated by our own products as well as publishers who desire maximum customization.\n",
    "contact": {
      "name": "BitLabs",
      "email": "contact@bitlabs.ai",
      "url": "https://bitlabs.ai"
    }
  },
  "servers": [
    {
      "url": "https://api.bitlabs.ai"
    }
  ],
  "security": [
    {
      "HeaderApiToken": [],
      "HeaderUserId": []
    },
    {
      "QueryApiToken": [],
      "QueryUserId": []
    },
    {
      "HeaderBearerToken": []
    }
  ],
  "tags": [
    {
      "name": "Internal - Not for publishers",
      "description": "Internal endpoints not to be used by publisher API integrations. Incorrect usage might lead to errors and bad\nuser experience.\n"
    }
  ],
  "paths": {
    "/v1/client/balance": {
      "get": {
        "summary": "Get user balance",
        "operationId": "getUserBalance",
        "description": "Get User Balance returns the balance of the user.\n",
        "tags": [
          "Internal - Not for publishers"
        ],
        "security": [
          {
            "HeaderBearerToken": []
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "data": {
                      "$ref": "#/components/schemas/Balance"
                    }
                  }
                }
              }
            }
          },
          "406": {
            "$ref": "#/components/responses/VpnBlock"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "HeaderApiToken": {
        "type": "apiKey",
        "name": "X-Api-Token",
        "in": "header",
        "description": "ApiToken of your BitLabs app."
      },
      "HeaderUserId": {
        "type": "apiKey",
        "name": "X-User-Id",
        "in": "header",
        "description": "Unique identifier of the user you are sending to BitLabs. These are passed back to you in callbacks to allow\nyou to identify your users. If possible, use UUIDs, numerical IDs or ASCII strings to avoid formatting issues.\nDo NOT use JWT or other sensitive tokens to identify your users. We only support up to 65 character long ids.\n"
      },
      "QueryApiToken": {
        "type": "apiKey",
        "name": "token",
        "in": "query",
        "description": "ApiToken of your BitLabs app."
      },
      "QueryUserId": {
        "type": "apiKey",
        "name": "uid",
        "in": "query",
        "description": "Unique identifier of the user you are sending to BitLabs. These are passed back to you in callbacks to allow\nyou to identify your users. If possible, use UUIDs, numerical IDs or ASCII strings to avoid formatting issues.\nDo NOT use JWT or other sensitive tokens to identify your users. We only support up to 65 character long ids.\n"
      },
      "HeaderBearerToken": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Enter the token with the `Bearer ` prefix, e.g. \"Bearer abcde12345\".\n"
      }
    },
    "responses": {
      "VpnBlock": {
        "description": "VPN detected",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "data": {
                  "type": "object"
                }
              }
            },
            "example": {
              "error": {
                "details": {
                  "http": "406 Not Acceptable",
                  "msg": "vpn detected"
                }
              }
            }
          }
        }
      }
    },
    "schemas": {
      "Balance": {
        "type": "object",
        "required": [
          "balance"
        ],
        "properties": {
          "balance": {
            "type": "string"
          }
        }
      }
    }
  }
}
```