> ## 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-information",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# Get address information
> Returns the current state of any account on the TON blockchain. Includes the balance (in nanotons), smart contract code and data (if deployed), account status, and a reference to the last transaction. This is the primary endpoint for checking if an address exists and what's deployed there.
## OpenAPI
````yaml get /api/v2/getAddressInformation
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/getAddressInformation:
get:
tags:
- Accounts
summary: Get address information
description: >-
Returns the current state of any account on the TON blockchain. Includes
the balance (in nanotons), smart contract code and data (if deployed),
account status, and a reference to the last transaction. This is the
primary endpoint for checking if an address exists and what's deployed
there.
operationId: getAddressInformation_get
parameters:
- $ref: '#/components/parameters/address'
- $ref: '#/components/parameters/seqnoOptional'
responses:
'200':
description: The complete current state of the requested account.
content:
application/json:
schema:
$ref: '#/components/schemas/AddressInformationResponse'
'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:
AddressInformationResponse:
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/AddressInformation'
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.
AddressInformation:
type: object
additionalProperties: false
properties:
'@type':
type: string
enum:
- raw.fullAccountState
default: raw.fullAccountState
description: >-
TonLib type identifier for full account state responses. Refer to
the [TonLib type
reference](/ecosystem/api/toncenter/v2-tonlib-types) for a full
list.
balance:
$ref: '#/components/schemas/Int256'
description: >-
The account balance in nanotons (the smallest unit of TON). 1 TON =
1,000,000,000 nanotons (10^9), so divide by 10^9 to get the
human-readable TON amount. Refer to the [units and decimals
guide](/ecosystem/wallet-apps/deep-links#read-more) for more
context. If this field appears on a Jetton wallet, the balance is in
the token's base units. Divide by 10^decimals, where `decimals` is
defined by the Jetton master contract. Refer to the [Jetton
overview](/standard/tokens/jettons/overview) for details on how
Jetton decimals work.
extra_currencies:
type: array
items:
$ref: '#/components/schemas/ExtraCurrencyBalance'
description: >-
Array of non-TON currency balances held by this account. Each entry
contains a currency ID (integer) and balance amount (decimal
string). Empty array if the account holds no extra currencies.
last_transaction_id:
$ref: '#/components/schemas/InternalTransactionId'
description: >-
Reference to the most recent transaction. Use as starting point for
getTransactions.
block_id:
$ref: '#/components/schemas/TonBlockIdExt'
description: Full block identifier where this event occurred.
code:
$ref: '#/components/schemas/Bytes'
description: Smart contract code in BoC format, base64 encoded.
data:
$ref: '#/components/schemas/Bytes'
description: >-
Raw transaction or contract data in BoC (Bag of Cells) format,
base64 encoded.
frozen_hash:
$ref: '#/components/schemas/TonHash'
description: Hash of the frozen contract state. Only present for frozen accounts.
sync_utime:
type: integer
format: int64
description: Unix timestamp of the block from which this data was read.
state:
$ref: '#/components/schemas/AccountStateEnum'
description: 'Account state: uninit, active, or frozen.'
suspended:
type: boolean
description: >-
Returns `true` if the account has been suspended by a governance
decision; otherwise `false`.
required:
- '@type'
- balance
- extra_currencies
- code
- data
- last_transaction_id
- block_id
- frozen_hash
- sync_utime
- state
description: >-
Raw account state including balance, code, data, and status. The code
and data fields contain the smart contract in BoC format.
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.
ExtraCurrencyBalance:
type: object
additionalProperties: false
properties:
'@type':
type: string
enum:
- extraCurrency
default: extraCurrency
description: >-
TonLib type identifier for extra currency balance entries. Refer to
the [TonLib type
reference](/ecosystem/api/toncenter/v2-tonlib-types) for a full
list.
id:
type: integer
format: int32
description: >-
A 32-bit integer identifying the extra currency. Currency IDs are
defined at the blockchain configuration level and stored in
`ConfigParam 7` of the masterchain. Refer to the [extra currency
minting
documentation](https://docs.ton.org/v3/documentation/infra/minter-flow)
for details.
amount:
$ref: '#/components/schemas/Int256'
description: Currency balance amount as a decimal string.
required:
- '@type'
- id
- amount
InternalTransactionId:
type: object
additionalProperties: false
description: >-
A reference to a specific transaction. The combination of `lt` (logical
time) and `hash` uniquely identifies any transaction. Use these values
for pagination and lookups.
properties:
'@type':
type: string
enum:
- internal.transactionId
default: internal.transactionId
description: >-
TonLib type identifier for transaction ID references. Refer to the
[TonLib type reference](/ecosystem/api/toncenter/v2-tonlib-types)
for a full list.
lt:
type: string
description: >-
Logical time of this transaction. A globally unique counter that
orders all events on the blockchain.
x-usrv-cpp-type: std::int64_t
hash:
$ref: '#/components/schemas/TonHash'
description: SHA-256 hash of this transaction, encoded in base64.
required:
- '@type'
- lt
- hash
TonBlockIdExt:
type: object
additionalProperties: false
properties:
'@type':
type: string
enum:
- ton.blockIdExt
default: ton.blockIdExt
description: >-
TonLib type identifier for full block identifiers. Refer to the
[TonLib type reference](/ecosystem/api/toncenter/v2-tonlib-types)
for a full list.
workchain:
type: integer
description: 'Workchain ID: `-1` for masterchain, `0` for basechain.'
shard:
type: string
x-usrv-cpp-type: std::int64_t
description: >-
Shard identifier as a signed 64-bit integer string. Masterchain uses
`-9223372036854775808`.
seqno:
type: integer
description: >-
Block sequence number within its workchain and shard. For the
masterchain (workchain `-1`), this equals the global block height.
For basechain shards (workchain `0`), this is the sequence number
local to that specific shard, not a global height.
root_hash:
$ref: '#/components/schemas/TonHash'
description: Merkle root hash of the block state tree.
file_hash:
$ref: '#/components/schemas/TonHash'
description: >-
Hash of the serialized block file. Together with `root_hash`,
uniquely identifies a block.
required:
- '@type'
- workchain
- shard
- seqno
- root_hash
- file_hash
description: >-
A complete block identifier with cryptographic hashes. Contains
`workchain`, `shard`, `seqno` (position) plus `root_hash` and
`file_hash` (verification).
Bytes:
type: string
x-usrv-cpp-type: ton_http::types::bytes
description: >-
Binary data encoded as base64. Used for serialized cells (BoC format),
message bodies, and smart contract code/data.
TonHash:
type: string
x-usrv-cpp-type: ton_http::types::ton_hash
description: >-
A 256-bit hash value. Accepts either hex format (64 characters) or
base64 format (44 characters). Used for block hashes, transaction
hashes, and cryptographic proofs.
AccountStateEnum:
type: string
enum:
- uninitialized
- active
- frozen
description: >-
The lifecycle state of an account: `uninitialized` (no contract
deployed), `active` (contract working normally), or `frozen` (suspended
due to zero balance). Refer to the [account lifecycle states
documentation](/foundations/status) for details.
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.
````