> ## Documentation Index > Fetch the complete documentation index at: https://docs.hifi.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a wallet balance > Retrieve the balance of a wallet for a specific currency. Use `GAS` to retrieve the chain's native gas token balance. Returns a not-eligible error if the currency is not supported on the wallet's chain. ## OpenAPI ````yaml https://production.hifi.com/api/v3/openapi.json get /v3/users/{userId}/wallets/{walletId}/balance openapi: 3.0.0 info: title: Hifi API version: 3.0.0 description: API documentation for HIFI servers: - url: https://production.hifi.com description: Production server - url: https://sandbox.hifi.com description: Sandbox server security: - bearerAuth: [] tags: - name: Common description: Common endpoints - name: User description: User endpoints - name: Counter Party description: Counter party endpoints - name: Crypto Transfer description: Crypto transfer and batch transfer endpoints - name: Wallet description: Wallet and wallet offer endpoints - name: External Account description: External bank account endpoints (under a counter party) - name: External Wallet description: External wallet endpoints (under a counter party) - name: External Card description: External card endpoints (under a counter party) - name: Token Swap description: Token swap endpoints - name: Bridge description: Bridge endpoints - name: Virtual Account description: Virtual account endpoints - name: Compliance description: Compliance and compliance link endpoints - name: Webhook Endpoint description: Webhook endpoint endpoints - name: File description: File upload endpoints - name: Onramp description: Onramp (fiat to crypto) endpoints - name: Offramp description: Offramp (crypto to fiat) endpoints - name: Orchestration Address description: Orchestration (liquidation) address endpoints - name: KYC Link description: Hosted and custom KYC/KYB link endpoints - name: Transfer Approval description: Transfer approval endpoints - name: Corridor description: Supported fiat/crypto transfer corridor endpoints - name: Migration description: v2-to-v3 ID mapping endpoints paths: /v3/users/{userId}/wallets/{walletId}/balance: get: tags: - Wallet summary: Retrieve a wallet balance description: | Retrieve the balance of a wallet for a specific currency. Use `GAS` to retrieve the chain's native gas token balance. Returns a not-eligible error if the currency is not supported on the wallet's chain. operationId: v3GetWalletBalance parameters: - $ref: '#/components/parameters/UserIdPathParameter' - $ref: '#/components/parameters/WalletIdPathParameter' - $ref: '#/components/parameters/WalletBalanceCurrencyQueryParameter' responses: '200': $ref: '#/components/responses/GetWalletBalanceResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponse' '500': $ref: '#/components/responses/InternalServerErrorResponse' components: parameters: UserIdPathParameter: name: userId in: path schema: type: string pattern: ^user_[A-Za-z0-9]+$ description: ID of the user. required: true WalletIdPathParameter: name: walletId in: path required: true schema: type: string description: Public ID of the wallet (prefixed with `wlt_`) example: wlt_1aLcs3Kf9dQ2mNpXwZ7bV WalletBalanceCurrencyQueryParameter: name: currency in: query required: true schema: type: string enum: - USDC - USDT - USDG - SOL - RLUSD - USDHIFI - PYUSD - PYUSD0 - USDCX - GAS description: >- Currency to return the balance for. Use `GAS` for the chain's native gas token. responses: GetWalletBalanceResponse: description: Wallet balance retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/WalletBalanceObject' example: balance: '1000000' displayBalance: '1.00' tokenInfo: tokenAddress: '0x3c499c542cef5e3811e1192ce70d8cc03d5c3359' standard: ERC20 name: USD Coin symbol: USDC decimals: 6 BadRequestResponse: description: Bad Request — the request was malformed or failed validation. content: application/json: schema: $ref: '#/components/schemas/ApiError' example: type: VALIDATION_ERROR message: One or more fields are invalid or missing. fields: - code: invalid_value message: Must be a valid email address field: email UnauthorizedResponse: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Unauthorized' NotFoundResponse: description: Not Found content: application/json: schema: $ref: '#/components/schemas/NotFound' InternalServerErrorResponse: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/InternalServerError' schemas: WalletBalanceObject: type: object description: Balance of a wallet for a given currency. properties: balance: type: string description: Balance in the token's smallest unit. example: '1000000' displayBalance: type: string description: Human-readable balance in whole token units. example: '1.00' tokenInfo: $ref: '#/components/schemas/WalletBalanceTokenInfo' ApiError: type: object description: >- Standard v3 error shape, returned by validation failures and business-logic errors alike. properties: type: type: string description: >- Machine-readable error type, e.g. VALIDATION_ERROR, ACTION_NOT_ALLOWED, RESOURCE_CONFLICT. example: VALIDATION_ERROR message: type: string description: Human-readable error message. example: One or more fields are invalid or missing. fields: type: array description: >- Present on field-level validation errors. One entry per problem field. items: type: object properties: code: type: string description: Error code related to the field issue. message: type: string description: Error message for the specific issue. field: type: string description: The name of the field that has an issue. Unauthorized: type: object properties: type: type: string description: Unauthorized enum example: UNAUTHORIZED message: type: string description: Unauthorized message example: Authentication required NotFound: type: object properties: type: type: string example: RESOURCE_NOT_FOUND description: The error type, e.g., RESOURCE_NOT_FOUND message: type: string description: A descriptive error message fields: type: array description: List of specific field errors items: type: object properties: code: type: string description: Error code related to the field issue message: type: string description: Error message for the specific issue field: type: string description: The name of the field that has an issue InternalServerError: type: object properties: type: type: string example: INTERNAL_SERVER_ERROR description: Internal server error enum message: type: string example: An internal server error occurred description: Internal server error message WalletBalanceTokenInfo: type: object description: >- Metadata for the token the balance is denominated in. Null when no token balance exists. nullable: true properties: tokenAddress: type: string description: On-chain contract address of the token. example: '0x3c499c542cef5e3811e1192ce70d8cc03d5c3359' standard: type: string description: Token standard. example: ERC20 name: type: string example: USD Coin symbol: type: string example: USDC decimals: type: integer example: 6 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````