The Accounts API from TOP Group (The Open Platform) — 22 operation(s) for accounts.
openapi: 3.0.0
info:
title: REST api to TON blockchain explorer Accounts API
version: 2.0.0
description: Provide access to indexed TON blockchain
contact:
name: Support
email: support@tonkeeper.com
servers:
- url: https://tonapi.io
- url: https://testnet.tonapi.io
- url: http://localhost:8081
tags:
- name: Accounts
externalDocs:
description: Additional documentation
url: https://docs.tonconsole.com/tonapi/rest-api/accounts
paths:
/v2/accounts/_bulk:
post:
description: Get human-friendly information about several accounts without low-level details.
operationId: getAccounts
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/currencyQuery'
requestBody:
$ref: '#/components/requestBodies/AccountIDs'
responses:
'200':
description: a list of accounts
content:
application/json:
schema:
$ref: '#/components/schemas/Accounts'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}:
get:
description: Get human-friendly information about an account without low-level details.
operationId: getAccount
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: account
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/dns/backresolve:
get:
description: Get account's domains
operationId: accountDnsBackResolve
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: account's domains
content:
application/json:
schema:
$ref: '#/components/schemas/DomainNames'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/jettons:
get:
description: Get all Jettons balances by owner address
operationId: getAccountJettonsBalances
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/currenciesQuery'
- $ref: '#/components/parameters/supportedExtensions'
- $ref: '#/components/parameters/limitQuery'
- $ref: '#/components/parameters/offsetQuery'
responses:
'200':
description: account jettons balances
content:
application/json:
schema:
$ref: '#/components/schemas/JettonsBalances'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/jettons/{jetton_id}:
get:
description: Get Jetton balance by owner address
operationId: getAccountJettonBalance
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/jettonIDParameter'
- $ref: '#/components/parameters/currenciesQuery'
- $ref: '#/components/parameters/supportedExtensions'
responses:
'200':
description: account jetton balance
content:
application/json:
schema:
$ref: '#/components/schemas/JettonBalance'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/jettons/history:
get:
description: Get the transfer jettons history for account
operationId: getAccountJettonsHistory
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- name: before_lt
in: query
description: omit this parameter to get last events
required: false
schema:
type: integer
format: int64
example: 25758317000002
x-js-format: bigint
- name: limit
in: query
required: true
schema:
type: integer
example: 100
maximum: 1000
minimum: 1
responses:
'200':
description: account jettons history
content:
application/json:
schema:
$ref: '#/components/schemas/JettonOperations'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/jettons/{jetton_id}/history:
get:
deprecated: true
description: Please use `getJettonAccountHistoryByID`` instead
operationId: getAccountJettonHistoryByID
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/jettonIDParameter'
- $ref: '#/components/parameters/i18n'
- name: before_lt
in: query
description: omit this parameter to get last events
required: false
schema:
type: integer
format: int64
example: 25758317000002
x-js-format: bigint
- name: limit
in: query
required: true
schema:
type: integer
example: 100
maximum: 1000
minimum: 1
- name: start_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
- name: end_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
responses:
'200':
description: account jetton history
content:
application/json:
schema:
$ref: '#/components/schemas/AccountEvents'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/nfts:
get:
description: Get all NFT items by owner address
operationId: getAccountNftItems
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/collectionQuery'
- $ref: '#/components/parameters/limitQuery'
- $ref: '#/components/parameters/offsetQuery'
- in: query
name: indirect_ownership
required: false
description: Selling nft items in TON implemented usually via transfer items to special selling account. This option enables including items which owned not directly.
schema:
type: boolean
default: false
responses:
'200':
description: account nft items
content:
application/json:
schema:
$ref: '#/components/schemas/NftItems'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/events:
get:
description: Get events for an account. Each event is built on top of a trace which is a series of transactions caused by one inbound message. TonAPI looks for known patterns inside the trace and splits the trace into actions, where a single action represents a meaningful high-level operation like a Jetton Transfer or an NFT Purchase. Actions are expected to be shown to users. It is advised not to build any logic on top of actions because actions can be changed at any time.
operationId: getAccountEvents
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/i18n'
- $ref: '#/components/parameters/initiatorQuery'
- name: subject_only
in: query
description: filter actions where requested account is not real subject (for example sender or receiver jettons)
schema:
type: boolean
default: false
required: false
- name: after_lt
in: query
description: omit this parameter to get last events
required: false
schema:
type: integer
format: int64
example: 25758317000002
x-js-format: bigint
- name: before_lt
in: query
description: omit this parameter to get last events
required: false
schema:
type: integer
format: int64
example: 25758317000002
x-js-format: bigint
- name: limit
in: query
required: true
schema:
type: integer
example: 20
maximum: 100
minimum: 1
- name: start_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
- name: end_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
- name: sort_order
in: query
schema:
type: string
description: used to sort the result-set in ascending or descending order by lt.
default: desc
enum:
- desc
- asc
responses:
'200':
description: account's events
content:
application/json:
schema:
$ref: '#/components/schemas/AccountEvents'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/events/{event_id}:
get:
description: Get event for an account by event_id
operationId: getAccountEvent
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/eventIDParameter'
- $ref: '#/components/parameters/i18n'
- name: subject_only
in: query
description: filter actions where requested account is not real subject (for example sender or receiver jettons)
schema:
type: boolean
default: false
required: false
responses:
'200':
description: account's event
content:
application/json:
schema:
$ref: '#/components/schemas/AccountEvent'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/traces:
get:
description: Get traces for account
operationId: getAccountTraces
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- name: before_lt
in: query
description: omit this parameter to get last events
required: false
schema:
type: integer
format: int64
example: 25758317000002
x-js-format: bigint
- name: limit
in: query
schema:
type: integer
maximum: 1000
default: 100
example: 100
minimum: 1
responses:
'200':
description: account's traces
content:
application/json:
schema:
$ref: '#/components/schemas/TraceIDs'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/subscriptions:
get:
description: Get all subscriptions by wallet address
operationId: getAccountSubscriptions
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: account's subscriptions
content:
application/json:
schema:
$ref: '#/components/schemas/Subscriptions'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/reindex:
post:
description: Update internal cache for a particular account
operationId: reindexAccount
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: success
default:
$ref: '#/components/responses/Error'
/v2/accounts/search:
get:
description: Search by account domain name
operationId: searchAccounts
tags:
- Accounts
parameters:
- name: name
in: query
required: true
schema:
type: string
minLength: 3
maxLength: 15
responses:
'200':
description: found accounts
content:
application/json:
schema:
$ref: '#/components/schemas/FoundAccounts'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/dns/expiring:
get:
description: Get expiring account .ton dns
operationId: getAccountDnsExpiring
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/periodQuery'
responses:
'200':
description: account's expiring .ton dns
content:
application/json:
schema:
$ref: '#/components/schemas/DnsExpiring'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/publickey:
get:
description: Get public key by account id
operationId: getAccountPublicKey
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: account's public key
content:
application/json:
schema:
type: object
required:
- public_key
properties:
public_key:
type: string
example: NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODQ3...
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/multisigs:
get:
description: Get account's multisigs
operationId: getAccountMultisigs
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: account's multisigs
content:
application/json:
schema:
$ref: '#/components/schemas/Multisigs'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/diff:
get:
description: Get account's balance change
operationId: getAccountDiff
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- name: start_date
in: query
required: true
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
- name: end_date
in: query
required: true
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
responses:
'200':
description: account's balance change
content:
application/json:
schema:
type: object
required:
- balance_change
properties:
balance_change:
type: integer
format: int64
example: 1000000000
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/defi/assets:
get:
description: 'Return DeFi assets locked in custom smart contracts: currently returns TON Whales staking and EVAA lending positions.
'
operationId: getAccountDefiAssets
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
responses:
'200':
description: account's DeFi assets
content:
application/json:
schema:
$ref: '#/components/schemas/DefiAssets'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/extra-currency/{id}/history:
get:
description: Get the transfer history of extra currencies for an account.
operationId: getAccountExtraCurrencyHistoryByID
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/ecIDParameter'
- $ref: '#/components/parameters/i18n'
- name: before_lt
in: query
description: omit this parameter to get last events
required: false
schema:
type: integer
format: int64
example: 25758317000002
x-js-format: bigint
- name: limit
in: query
required: true
schema:
type: integer
example: 100
maximum: 1000
minimum: 1
- name: start_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
- name: end_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
responses:
'200':
description: account extra currency history
content:
application/json:
schema:
$ref: '#/components/schemas/AccountEvents'
default:
$ref: '#/components/responses/Error'
/v2/jettons/{jetton_id}/accounts/{account_id}/history:
get:
description: Get the transfer jetton history for account and jetton
operationId: getJettonAccountHistoryByID
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/accountIDParameter'
- $ref: '#/components/parameters/jettonIDParameter'
- name: before_lt
in: query
description: omit this parameter to get last events
required: false
schema:
type: integer
format: int64
example: 25758317000002
x-js-format: bigint
- name: limit
in: query
required: true
schema:
type: integer
example: 100
maximum: 1000
minimum: 1
- name: start_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
- name: end_date
in: query
required: false
schema:
type: integer
format: int64
maximum: 2114380800
example: 1668436763
responses:
'200':
description: account jetton history
content:
application/json:
schema:
$ref: '#/components/schemas/JettonOperations'
default:
$ref: '#/components/responses/Error'
/v2/accounts/{account_id}/events/emulate:
post:
description: Emulate sending message to retrieve account-specific events
operationId: emulateMessageToAccountEvent
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/i18n'
- $ref: '#/components/parameters/accountIDParameter'
- name: ignore_signature_check
in: query
required: false
schema:
type: boolean
requestBody:
$ref: '#/components/requestBodies/Boc'
responses:
'200':
description: emulated message to account
content:
application/json:
schema:
$ref: '#/components/schemas/AccountEvent'
default:
$ref: '#/components/responses/Error'
components:
schemas:
SmartContractAction:
type: object
required:
- executor
- contract
- gram_attached
- operation
properties:
executor:
$ref: '#/components/schemas/AccountAddress'
contract:
$ref: '#/components/schemas/AccountAddress'
ton_attached:
type: integer
description: amount in nanograms
format: int64
example: 123456789
x-js-format: bigint
deprecated: true
gram_attached:
type: integer
description: amount in nanograms
format: int64
example: 123456789
x-js-format: bigint
operation:
type: string
example: NftTransfer or 0x35d95a12
payload:
type: string
refund:
$ref: '#/components/schemas/Refund'
WithdrawXTRAction:
type: object
required:
- user
- amount
properties:
user:
$ref: '#/components/schemas/AccountAddress'
amount:
type: string
x-js-format: bigint
example: '123000000000'
NftApprovedBy:
type: array
items:
type: string
example: getgems
enum:
- getgems
- tonkeeper
DomainRenewAction:
type: object
required:
- domain
- contract_address
- renewer
properties:
domain:
type: string
example: vasya.ton
contract_address:
type: string
format: address
example: 0:da6b1b6663a0e4d18cc8574ccd9db5296e367dd9324706f3bbd9eb1cd2caf0bf
renewer:
$ref: '#/components/schemas/AccountAddress'
DefiAssetType:
type: string
enum:
- staking
- lending_supply
- lending_borrow
- liquid_staking
- liquid_pool
- yield_token
DefiLiquidPoolAssets:
type: object
required:
- asset0
- asset1
properties:
asset0:
$ref: '#/components/schemas/DefiLockedAsset'
asset1:
$ref: '#/components/schemas/DefiLockedAsset'
Multisig:
type: object
required:
- address
- seqno
- threshold
- signers
- proposers
- orders
properties:
address:
type: string
format: address
example: 0:da6b1b6663a0e4d18cc8574ccd9db5296e367dd9324706f3bbd9eb1cd2caf0bf
seqno:
type: string
threshold:
type: integer
format: int32
signers:
type: array
items:
type: string
format: address
example: 0:da6b1b6663a0e4d18cc8574ccd9db5296e367dd9324706f3bbd9eb1cd2caf0bf
proposers:
type: array
items:
type: string
format: address
example: 0:da6b1b6663a0e4d18cc8574ccd9db5296e367dd9324706f3bbd9eb1cd2caf0bf
orders:
type: array
items:
$ref: '#/components/schemas/MultisigOrder'
EncryptedComment:
type: object
required:
- encryption_type
- cipher_text
properties:
encryption_type:
type: string
example: simple
cipher_text:
type: string
example: A6A0BD6608672B...CE3AF8DB
AddExtensionAction:
type: object
required:
- wallet
- extension
properties:
wallet:
$ref: '#/components/schemas/AccountAddress'
extension:
type: string
format: address
example: 0:10C1073837B93FDAAD594284CE8B8EFF7B9CF25427440EB2FC682762E1471365
ExtraCurrencyTransferAction:
type: object
required:
- sender
- recipient
- amount
- currency
properties:
sender:
$ref: '#/components/schemas/AccountAddress'
recipient:
$ref: '#/components/schemas/AccountAddress'
amount:
type: string
x-js-format: bigint
example: '1000000000'
description: amount in quanta of tokens
comment:
type: string
example: "Hi! This is your salary. \nFrom accounting with love."
encrypted_comment:
$ref: '#/components/schemas/EncryptedComment'
currency:
$ref: '#/components/schemas/EcPreview'
OraclePriceFeed:
type: object
required:
- id
- display_symbol
properties:
id:
type: string
example: e62df6c8b4a85fe1a67f1c4d1f1e1d4335c04d1d7e2c50e0d7da7ad911f2d4
display_symbol:
type: string
example: GRAM/USD
rate:
type: number
format: double
example: 5.24
NftItem:
type: object
required:
- address
- index
- verified
- metadata
- approved_by
- trust
properties:
address:
type: string
format: address
example: 0:E93E7D444180608B8520C00DC664383A387356FB6E16FDDF99DBE5E1415A574B
index:
type: integer
format: int64
example: 58
owner:
$ref: '#/components/schemas/AccountAddress'
collection:
type: object
required:
- address
- name
- description
properties:
address:
type: string
format: address
example: 0:E93E7D444180608B8520C00DC664383A387356FB6E16FDDF99DBE5E1415A574B
name:
type: string
example: TON Diamonds
description:
type: string
example: Best collection in TON network
verified:
type: boolean
description: Collection master contract confirmed that this item is part of collection
example: true
metadata:
type: object
additionalProperties: true
example: {}
sale:
$ref: '#/components/schemas/Sale'
previews:
type: array
items:
$ref: '#/components/schemas/ImagePreview'
dns:
type: string
example: crypto.ton
approved_by:
allOf:
- $ref: '#/components/schemas/NftApprovedBy'
deprecated: true
description: Please use trust field
include_cnft:
type: boolean
example: false
trust:
$ref: '#/components/schemas/TrustType'
code_hash:
type: string
description: Hash of the NFT item account code cell (hex)
data_hash:
type: string
description: Hash of the NFT item account data cell (hex)
EcPreview:
type: object
required:
- id
- symbol
- decimals
- image
properties:
id:
type: integer
example: 239
format: int32
symbol:
type: string
example: FMS
decimals:
type: integer
example: 5
image:
type: string
example: https://cache.tonapi.io/images/extra.jpg
AuctionBidAction:
type: object
required:
- amount
- bidder
- auction
- auction_type
properties:
auction_type:
type: string
enum:
- DNS.ton
- DNS.tg
- NUMBER.tg
- getgems
amount:
$ref: '#/components/schemas/Price'
nft:
$ref: '#/components/schemas/NftItem'
bidder:
$ref: '#/components/schemas/AccountAddress'
auction:
$ref: '#/components/schemas/AccountAddress'
JettonMintAction:
type: object
required:
- amount
- jetton
- recipient
- recipients_wallet
properties:
recipient:
$ref: '#/components/schemas/AccountAddress'
recipients_wallet:
type: string
format: address
example: 0:E93E7D444180608B8520C00DC664383A387356FB6E16FDDF99DBE5E1415A574B
amount:
type: string
x-js-format: bigint
example: '1000000000'
description: amount in quanta of tokens
jetton:
$ref: '#/components/schemas/JettonPreview'
BuyXTRAction:
type: object
required:
- recipient
- amount
properties:
recipient:
$ref: '#/components/schemas/AccountAddress'
amount:
type: string
x-js-format: bigint
example: '123000000000'
WithdrawTokenStakeRequestAction:
type: object
required:
- staker
- protocol
properties:
staker:
$ref: '#/components/schemas/AccountAddress'
protocol:
$ref: '#/components/schemas/Protocol'
stake_meta:
$ref: '#/components/schemas/Price'
SetSignatureAllowedAction:
type: object
required:
- wallet
- allowed
properties:
wallet:
$ref: '#/components/schemas/AccountAddress'
allowed:
type: boolean
DepositTokenStakeAction:
type: object
required:
- staker
- protocol
properties:
staker:
$ref: '#/components/schemas/AccountAddress'
protocol:
$ref: '#/components/schemas/Protocol'
stake_meta:
$ref: '#/components/schemas/Price'
UnSubscriptionAction:
type: object
required:
- subscriber
- subscription
- beneficiary
- admin
properties:
subscriber:
$ref: '#/components/schemas/AccountAddress'
subscription:
type: string
format: address
example: 0:da6b1b6663a0e4d18cc8574ccd9db5296e367dd9324706f3bbd9eb1cd2caf0bf
beneficiary:
$ref: '#/components/schemas/AccountAddress'
admin:
$ref: '#/components/schemas/AccountAddress'
Metadata:
type: object
required:
- encrypted_binary
properties:
encrypted_binary:
type: string
description: hex encoded bytes
decryption_key:
type: string
description: hex encoded bytes
example: dead.....beef
TokenRates:
type: object
properties:
prices:
type: object
additionalProperties:
type: number
example:
GRAM: 1.3710752873163712
diff_24h:
type: object
additionalProperties:
type: string
example:
GRAM: -1.28%
diff_7d:
type: object
additionalProperties:
type: string
example:
GRAM: -2.74%
diff_30d:
type: object
additionalProperties:
type: string
example:
GRAM: -0.56%
FlawedJettonTransferAction:
type: object
required:
- sent_amount
- received_amount
- jetton
- senders_wallet
- recipients_wallet
properties:
sender:
$ref: '#/components/schemas/AccountAddress'
recipient:
$ref: '#/components/schemas/AccountAddress'
senders_wallet:
type: string
format: address
example: 0:E93E7D444180608B8520C00DC664383A387356FB6E16FDDF99DBE5E1415A574B
recipients_wallet:
type: string
format: address
example: 0:E93E7D444180608B8520C00DC664383A387356FB6E16FDDF99DBE5E1415A574B
sent_amount:
type: string
x-js-format: bigint
example: '1000000000'
description: sent amount in quanta of tokens
received_amount:
type: string
x-js-format: bigint
example: '1000000000'
description: actually received amount in quanta of tokens
comment:
type: string
example: "Hi! This is your salary. \nFrom accounting with love."
encrypted_comment:
$ref: '#/components/schemas/EncryptedComment'
refund:
$ref: '#/components/schemas/Refund'
jetton:
$ref: '#/components/schemas/JettonPreview'
TraceID:
type: object
required:
- id
- utime
properties:
id:
type: string
example: 55e8809519cd3c49098c9ee45afdafcea7a894a74d0f628d94a115a50e045122
utime:
type: integer
format: int64
example: 1645544908
ContractDeployAction:
type: object
required:
- address
- interfaces
properties:
address:
t
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/top-group/refs/heads/main/openapi/top-group-accounts-api-openapi.yml