Get balance for the account.
# OpenAPI definition ```json { "openapi": "3.1.0", "servers": [ { "url": "https://api.tatum.io" } ], "info": { "version": "1.2", "title": "Virtual Accounts" }, "tags": [ { "name": "Account" } ], "paths": { "/v3/ledger/account/{id}/balance": { "get": { "description": "/v3/ledger/account/{id}/balance
\nGet balance for the account.
", "operationId": "getAccountBalance", "parameters": [ { "description": "Account ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string", "example": "5e68c66581f2ee32bc354087" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountBalance" } } }, "description": "OK" }, "400": { "$ref": "#/components/responses/Error400" }, "401": { "$ref": "#/components/responses/Error401" }, "403": { "description": "Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error403AccountNotExists" } } } }, "500": { "$ref": "#/components/responses/Error500" } }, "security": [ { "X-API-Key": [] } ], "x-codeSamples": [], "summary": "Get account balance", "tags": [ "Account" ] } } }, "components": { "securitySchemes": { "X-API-Key": { "type": "apiKey", "name": "x-api-key", "in": "header", "description": "Your **API key** is used to identify your account & your plan, including the number of API calls per second and total monthly calls you have.\n\nEach key is for individual use only.\n\nIf you don't have a key already you can [Sign up for a Free Tatum account](https://co.tatum.io/signup) to get two keys (testnet and mainnet), allowing up to 5 API calls per second and 1,000,000 Credits.\n\nFor testing purposes, you can use the following key which only works inside docs and has limited functionality (e.g. you cannot create virtual accounts or notification subscriptions with it):\n* t-66a730ccccfd17001c479705-2f597d14ad7543f289a03418\n\nFor more details on limits and plans, [click here](https://docs.tatum.io/docs/plans-limits).\n" } }, "responses": { "Error400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": "validation.failed", "description": "validation.failed", "type": "string" }, "message": { "example": "Request validation failed. Please see data for additional information.", "description": "Request validation failed. Please see data for additional information.", "type": "string" }, "statusCode": { "example": 400, "description": "400", "type": "number" }, "data": { "type": "array", "items": { "type": "object", "required": [ "target" ], "properties": { "target": { "type": "object", "additionalProperties": true, "description": "Request object present in the body of the HTTP request", "example": { "property": 12345 } }, "value": { "type": "number", "description": "Value of the target object which validation is wrong. Can be of any data type, example here is using type number.", "example": 12345 }, "property": { "type": "string", "description": "Property name of the target object which validation is wrong", "example": "property1" }, "constraints": { "type": "object", "additionalProperties": true, "description": "Object of failed constraints for the target object. Key is the constraint, value is detailed description of the failed constraint.", "example": { "min": "property1 must not be less than 50000" } } } } } }, "required": [ "errorCode", "message", "statusCode", "data" ], "type": "object" } } } }, "Error401": { "description": "Unauthorized. Not valid or inactive subscription key present in the HTTP Header.", "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "errorCode": { "example": "subscription.not.active", "description": "subscription.not.active", "type": "string" }, "message": { "example": "Subscription not active anymore.", "description": "Subscription not active anymore.", "type": "string" }, "statusCode": { "example": 401, "description": "401", "type": "number" } }, "required": [ "errorCode", "message", "statusCode" ], "type": "object" }, { "properties": { "errorCode": { "example": "subscription.invalid", "description": "subscription.invalid", "type": "string" }, "message": { "example": "Unable to find valid subscription for '${apiKey}'", "description": "Unable to find valid subscription for '${apiKey}'", "type": "string" }, "statusCode": { "example": 401, "description": "401", "type": "number" } }, "required": [ "errorCode", "message", "statusCode" ], "type": "object" } ] } } } }, "Error500": { "description": "Internal server error. There was an error on the server during the processing of the request.", "content": { "application/json": { "schema": { "properties": { "message": { "example": "Internal server error", "description": "Internal server error", "type": "string" }, "statusCode": { "example": 500, "description": "500", "type": "number" } }, "required": [ "statusCode", "message" ], "type": "object" } } } } }, "schemas": { "Error403AccountNotExists": { "properties": { "errorCode": { "description": "account.not.exists", "example": "account.not.exists", "type": "string" }, "message": { "description": "No such account.", "example": "No such account.", "type": "string" }, "statusCode": { "description": "403", "example": 403, "type": "number" } }, "required": [ "errorCode", "message", "statusCode" ], "type": "object" }, "AccountBalance": { "properties": { "accountBalance": { "description": "All assets on the account, both available and blocked", "example": "1000000", "type": "string" }, "availableBalance": { "description": "The account balance minus the blocked assets; use the available balance to determine how much a customer can send or withdraw from their virtual account", "example": "1000000", "type": "string" } }, "type": "object", "required": [ "accountBalance", "availableBalance" ] } } } } ```