> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ton.org/llms.txt
> Use this file to discover all available pages before exploring further.
## Submitting Feedback
If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:
POST https://docs.ton.org/feedback
```json
{
"path": "/ecosystem/api/toncenter/v2/accounts/get-address-balance",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# Get address balance
> Returns the TON balance of an account in nanotons. 1 TON = 1,000,000,000 nanotons. A lightweight endpoint that returns only the balance without contract code, data, or other account details. Returns "0" for addresses that have never received any funds.
## OpenAPI
````yaml get /api/v2/getAddressBalance
openapi: 3.1.1
info:
title: TON HTTP API C++
description: >
This API enables HTTP access to TON blockchain - getting accounts and
wallets information, looking up blocks and transactions, sending messages to
the blockchain, calling get methods of smart contracts, and more.
In addition to REST API, all methods are available through a JSON-RPC
endpoint with `method` equal to method name and `params` passed as a
dictionary.
The response contains a JSON object, which always has a boolean field `ok`
and either `error` or `result`. If `ok` equals true, the request was
successful and the result of the query can be found in the `result` field.
In case of an unsuccessful request, `ok` equals false and the error is
explained in the `error`.
API Key should be sent either as `api_key` query parameter or `X-API-Key`
header
version: 2.1.1
servers:
- url: https://toncenter.com
description: TON Mainnet
- url: https://testnet.toncenter.com
description: TON Testnet
security: []
tags:
- name: Accounts
description: Information about accounts
- name: Transactions
description: Fetching and locating transactions
- name: Blocks
description: Information about blocks
- name: Run method
description: Run get-method of smart contracts
- name: Send
description: Send data to blockchain
- name: Utils
description: Some useful methods
- name: Configuration
description: Information about blockchain config
- name: RPC
description: JSON-RPC and POST endpoints
paths:
/api/v2/getAddressBalance:
get:
tags:
- Accounts
summary: Get address balance
description: >-
Returns the TON balance of an account in nanotons. 1 TON = 1,000,000,000
nanotons. A lightweight endpoint that returns only the balance without
contract code, data, or other account details. Returns "0" for addresses
that have never received any funds.
operationId: getAddressBalance_get
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/seqnoOptional'
responses:
'200':
description: Returns the account balance in nanotons.
content:
application/json:
schema:
$ref: '#/components/schemas/AddressBalanceResponse'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'422':
$ref: '#/components/responses/422_address'
'429':
$ref: '#/components/responses/429'
'504':
$ref: '#/components/responses/504'
security:
- APIKeyHeader: []
- APIKeyQuery: []
components:
parameters:
address:
name: address
in: query
required: true
schema:
$ref: '#/components/schemas/TonAddr'
description: The account address to query.
seqnoOptional:
name: seqno
in: query
description: >-
Query state at a specific block height. If omitted, returns the current
state. Use this to look up historical data at a specific point in time.
required: false
schema:
type: integer
format: int32
schemas:
AddressBalanceResponse:
type: object
additionalProperties: false
required:
- ok
- result
properties:
ok:
type: boolean
default: true
description: >-
Returns `true` if the request succeeded; otherwise `false`. See the
`error` field for details.
result:
$ref: '#/components/schemas/Int256'
description: Response data. Present only when `ok` is `true`.
'@extra':
type: string
description: >-
Optional request ID that can be passed in the request and received
back in the response. Useful for matching async responses.
TonAddr:
type: string
x-usrv-cpp-type: ton_http::types::ton_addr
description: >-
Account address in [raw](/foundations/addresses/formats#raw-format)
format (e.g., `0:ca6e321c...`) or
[user-friendly](/foundations/addresses/formats#user-friendly-format)
format (e.g., `EQDKbjIcfM...`). All formats are automatically detected.
Int256:
type: string
x-usrv-cpp-type: ton_http::types::int256
description: >-
A large integer represented as a string to avoid precision loss. Used
for balances and other values that may exceed JavaScript's safe integer
limit.
responses:
'401':
description: API key does not exist. Check for typos or generate a new key.
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- ok
- code
- error
properties:
ok:
type: boolean
const: false
description: Always `false` for error responses.
code:
type: integer
const: 401
description: HTTP status code `401`.
error:
type: string
enum:
- API key does not exist
'@extra':
type: string
description: Extra data passed through from the request.
example:
ok: false
code: 401
error: API key does not exist
'403':
description: >-
API key is not allowed for this network (e.g. testnet key used on
mainnet).
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- ok
- code
- error
properties:
ok:
type: boolean
const: false
description: Always `false` for error responses.
code:
type: integer
const: 403
description: HTTP status code `403`.
error:
type: string
enum:
- Network not allowed
'@extra':
type: string
description: Extra data passed through from the request.
example:
ok: false
code: 403
error: Network not allowed
'429':
description: >-
Rate limit exceeded. Back off and retry, or use an API key for higher
limits.
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- ok
- code
- error
properties:
ok:
type: boolean
const: false
description: Always `false` for error responses.
code:
type: integer
const: 429
description: HTTP status code `429`.
error:
type: string
enum:
- Ratelimit exceeded
'@extra':
type: string
description: Extra data passed through from the request.
example:
ok: false
code: 429
error: Ratelimit exceeded
'504':
description: Timeout waiting for liteserver response.
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- ok
- code
- error
properties:
ok:
type: boolean
const: false
description: Always `false` for error responses.
code:
type: integer
const: 504
description: HTTP status code `504`.
error:
type: string
enum:
- LITE_SERVER_NETWORK timeout
'@extra':
type: string
description: Extra data passed through from the request.
example:
ok: false
code: 504
error: LITE_SERVER_NETWORK timeout
422_address:
description: Invalid address or `seqno` parameter.
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- ok
- code
- error
properties:
ok:
type: boolean
const: false
description: Always `false` for error responses.
code:
type: integer
const: 422
description: HTTP status code `422`.
error:
type: string
enum:
- empty address
- failed to parse address
- failed to parse seqno
- seqno should be positive
'@extra':
type: string
description: Extra data passed through from the request.
example:
ok: false
code: 422
error: empty address
securitySchemes:
APIKeyHeader:
type: apiKey
in: header
name: X-API-Key
description: >-
API key header of the form `X-API-Key: `, where `` is the
API key. Requests without a key are limited to 1 RPS. Refer to the
[authentication guide](/ecosystem/api/toncenter/v2-authentication) for
details.
APIKeyQuery:
type: apiKey
in: query
name: api_key
description: >-
API key query parameter of the form `?api_key=`, where ``
is the API key. Equivalent to the header method. Refer to the
[authentication guide](/ecosystem/api/toncenter/v2-authentication) for
details.
````