Indexer API

Getting Started

The TON Indexer API provides a powerful way to access indexed blockchain data from the TON network. By storing blockchain data in PostgreSQL, this API allows for efficient queries and retrieval of historical information.

Get Masterchain Info

Returns first and last blocks information, can be used as a start point for blockchain search process

GET/api/v3/masterchainInfo

Authorization

APIKeyHeaderAPIKeyQuery

Response

200404

Successful Response

Body

application/json

last*Block

first*Block

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/masterchainInfo', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "last": {
    "workchain": 0,
    "shard": "text",
    "seqno": 0,
    "root_hash": "text",
    "file_hash": "text",
    "global_id": 0,
    "version": 0,
    "after_merge": false,
    "before_split": false,
    "after_split": false,
    "want_merge": false,
    "want_split": false,
    "key_block": false,
    "vert_seqno_incr": false,
    "flags": 0,
    "gen_utime": "text",
    "start_lt": "text",
    "end_lt": "text",
    "validator_list_hash_short": 0,
    "gen_catchain_seqno": 0,
    "min_ref_mc_seqno": 0,
    "prev_key_block_seqno": 0,
    "vert_seqno": 0,
    "master_ref_seqno": 0,
    "rand_seed": "text",
    "created_by": "text",
    "tx_count": 0,
    "masterchain_block_ref": {
      "workchain": 0,
      "shard": "text",
      "seqno": 0
    },
    "prev_blocks": [
      {
        "workchain": 0,
        "shard": "text",
        "seqno": 0
      }
    ]
  },
  "first": {
    "workchain": 0,
    "shard": "text",
    "seqno": 0,
    "root_hash": "text",
    "file_hash": "text",
    "global_id": 0,
    "version": 0,
    "after_merge": false,
    "before_split": false,
    "after_split": false,
    "want_merge": false,
    "want_split": false,
    "key_block": false,
    "vert_seqno_incr": false,
    "flags": 0,
    "gen_utime": "text",
    "start_lt": "text",
    "end_lt": "text",
    "validator_list_hash_short": 0,
    "gen_catchain_seqno": 0,
    "min_ref_mc_seqno": 0,
    "prev_key_block_seqno": 0,
    "vert_seqno": 0,
    "master_ref_seqno": 0,
    "rand_seed": "text",
    "created_by": "text",
    "tx_count": 0,
    "masterchain_block_ref": {
      "workchain": 0,
      "shard": "text",
      "seqno": 0
    },
    "prev_blocks": [
      {
        "workchain": 0,
        "shard": "text",
        "seqno": 0
      }
    ]
  }
}

Get Blocks

Returns blocks by specified filters.

GET/api/v3/blocks

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

blocks*Blocks

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/blocks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "blocks": [
    {
      "workchain": 0,
      "shard": "text",
      "seqno": 0,
      "root_hash": "text",
      "file_hash": "text",
      "global_id": 0,
      "version": 0,
      "after_merge": false,
      "before_split": false,
      "after_split": false,
      "want_merge": false,
      "want_split": false,
      "key_block": false,
      "vert_seqno_incr": false,
      "flags": 0,
      "gen_utime": "text",
      "start_lt": "text",
      "end_lt": "text",
      "validator_list_hash_short": 0,
      "gen_catchain_seqno": 0,
      "min_ref_mc_seqno": 0,
      "prev_key_block_seqno": 0,
      "vert_seqno": 0,
      "master_ref_seqno": 0,
      "rand_seed": "text",
      "created_by": "text",
      "tx_count": 0,
      "masterchain_block_ref": {
        "workchain": 0,
        "shard": "text",
        "seqno": 0
      },
      "prev_blocks": [
        {
          "workchain": 0,
          "shard": "text",
          "seqno": 0
        }
      ]
    }
  ]
}

Get Shards By Masterchain Block

Returns one masterchain block (with seqno equal to argument) and some number of shard blocks (with masterchain_block_ref.seqno equal to argument)

GET/api/v3/masterchainBlockShardState

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200404422

Successful Response

Body

application/json

blocks*Blocks

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/masterchainBlockShardState?seqno=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404422

{
  "blocks": [
    {
      "workchain": 0,
      "shard": "text",
      "seqno": 0,
      "root_hash": "text",
      "file_hash": "text",
      "global_id": 0,
      "version": 0,
      "after_merge": false,
      "before_split": false,
      "after_split": false,
      "want_merge": false,
      "want_split": false,
      "key_block": false,
      "vert_seqno_incr": false,
      "flags": 0,
      "gen_utime": "text",
      "start_lt": "text",
      "end_lt": "text",
      "validator_list_hash_short": 0,
      "gen_catchain_seqno": 0,
      "min_ref_mc_seqno": 0,
      "prev_key_block_seqno": 0,
      "vert_seqno": 0,
      "master_ref_seqno": 0,
      "rand_seed": "text",
      "created_by": "text",
      "tx_count": 0,
      "masterchain_block_ref": {
        "workchain": 0,
        "shard": "text",
        "seqno": 0
      },
      "prev_blocks": [
        {
          "workchain": 0,
          "shard": "text",
          "seqno": 0
        }
      ]
    }
  ]
}

Get Address Book

Generates and returns a user-friendly address book for a given contract address list.

GET/api/v3/addressBook

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

Other propertiesAddressBookEntry

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/addressBook?address=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Get Masterchain Block Shards

Returns all workchain blocks, that appeared after previous masterchain block.

Note: this method is not equivalent with /api/v2/shards.

GET/api/v3/masterchainBlockShards

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

blocks*Blocks

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/masterchainBlockShards?seqno=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "blocks": [
    {
      "workchain": 0,
      "shard": "text",
      "seqno": 0,
      "root_hash": "text",
      "file_hash": "text",
      "global_id": 0,
      "version": 0,
      "after_merge": false,
      "before_split": false,
      "after_split": false,
      "want_merge": false,
      "want_split": false,
      "key_block": false,
      "vert_seqno_incr": false,
      "flags": 0,
      "gen_utime": "text",
      "start_lt": "text",
      "end_lt": "text",
      "validator_list_hash_short": 0,
      "gen_catchain_seqno": 0,
      "min_ref_mc_seqno": 0,
      "prev_key_block_seqno": 0,
      "vert_seqno": 0,
      "master_ref_seqno": 0,
      "rand_seed": "text",
      "created_by": "text",
      "tx_count": 0,
      "masterchain_block_ref": {
        "workchain": 0,
        "shard": "text",
        "seqno": 0
      },
      "prev_blocks": [
        {
          "workchain": 0,
          "shard": "text",
          "seqno": 0
        }
      ]
    }
  ]
}

Get Transactions

Returns transactions by specified filters.

GET/api/v3/transactions

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

transactions*Transactions

address_book*Address Book

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/transactions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "transactions": [
    {
      "account": "text",
      "hash": "text",
      "lt": "text",
      "now": 0,
      "orig_status": "uninit",
      "end_status": "uninit",
      "total_fees": "text",
      "prev_trans_hash": "text",
      "prev_trans_lt": "text",
      "block_ref": {
        "workchain": 0,
        "shard": "text",
        "seqno": 0
      },
      "in_msg": {
        "hash": "text",
        "source": "text",
        "destination": "text",
        "value": "text",
        "fwd_fee": "text",
        "ihr_fee": "text",
        "created_lt": "text",
        "created_at": "text",
        "opcode": "text",
        "ihr_disabled": false,
        "bounce": false,
        "bounced": false,
        "import_fee": "text",
        "message_content": {
          "hash": "text",
          "body": "text",
          "decoded": {
            "comment": "text"
          }
        },
        "init_state": {
          "hash": "text",
          "body": "text"
        }
      },
      "out_msgs": [
        {
          "hash": "text",
          "source": "text",
          "destination": "text",
          "value": "text",
          "fwd_fee": "text",
          "ihr_fee": "text",
          "created_lt": "text",
          "created_at": "text",
          "opcode": "text",
          "ihr_disabled": false,
          "bounce": false,
          "bounced": false,
          "import_fee": "text",
          "message_content": {
            "hash": "text",
            "body": "text",
            "decoded": {
              "comment": "text"
            }
          },
          "init_state": {
            "hash": "text",
            "body": "text"
          }
        }
      ],
      "account_state_before": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "account_state_after": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "mc_block_seqno": 0
    }
  ]
}

Get Transactions By Masterchain Block

Returns transactions from masterchain block and from all shards.

GET/api/v3/transactionsByMasterchainBlock

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

transactions*Transactions

address_book*Address Book

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/transactionsByMasterchainBlock?seqno=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "transactions": [
    {
      "account": "text",
      "hash": "text",
      "lt": "text",
      "now": 0,
      "orig_status": "uninit",
      "end_status": "uninit",
      "total_fees": "text",
      "prev_trans_hash": "text",
      "prev_trans_lt": "text",
      "block_ref": {
        "workchain": 0,
        "shard": "text",
        "seqno": 0
      },
      "in_msg": {
        "hash": "text",
        "source": "text",
        "destination": "text",
        "value": "text",
        "fwd_fee": "text",
        "ihr_fee": "text",
        "created_lt": "text",
        "created_at": "text",
        "opcode": "text",
        "ihr_disabled": false,
        "bounce": false,
        "bounced": false,
        "import_fee": "text",
        "message_content": {
          "hash": "text",
          "body": "text",
          "decoded": {
            "comment": "text"
          }
        },
        "init_state": {
          "hash": "text",
          "body": "text"
        }
      },
      "out_msgs": [
        {
          "hash": "text",
          "source": "text",
          "destination": "text",
          "value": "text",
          "fwd_fee": "text",
          "ihr_fee": "text",
          "created_lt": "text",
          "created_at": "text",
          "opcode": "text",
          "ihr_disabled": false,
          "bounce": false,
          "bounced": false,
          "import_fee": "text",
          "message_content": {
            "hash": "text",
            "body": "text",
            "decoded": {
              "comment": "text"
            }
          },
          "init_state": {
            "hash": "text",
            "body": "text"
          }
        }
      ],
      "account_state_before": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "account_state_after": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "mc_block_seqno": 0
    }
  ]
}

Get Transactions By Message

Returns transactions whose inbound/outbound message has the specified hash. This endpoint returns list of Transaction objects since collisions of message hashes can occur.

GET/api/v3/transactionsByMessage

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

transactions*Transactions

address_book*Address Book

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/transactionsByMessage?direction=in&msg_hash=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "transactions": [
    {
      "account": "text",
      "hash": "text",
      "lt": "text",
      "now": 0,
      "orig_status": "uninit",
      "end_status": "uninit",
      "total_fees": "text",
      "prev_trans_hash": "text",
      "prev_trans_lt": "text",
      "block_ref": {
        "workchain": 0,
        "shard": "text",
        "seqno": 0
      },
      "in_msg": {
        "hash": "text",
        "source": "text",
        "destination": "text",
        "value": "text",
        "fwd_fee": "text",
        "ihr_fee": "text",
        "created_lt": "text",
        "created_at": "text",
        "opcode": "text",
        "ihr_disabled": false,
        "bounce": false,
        "bounced": false,
        "import_fee": "text",
        "message_content": {
          "hash": "text",
          "body": "text",
          "decoded": {
            "comment": "text"
          }
        },
        "init_state": {
          "hash": "text",
          "body": "text"
        }
      },
      "out_msgs": [
        {
          "hash": "text",
          "source": "text",
          "destination": "text",
          "value": "text",
          "fwd_fee": "text",
          "ihr_fee": "text",
          "created_lt": "text",
          "created_at": "text",
          "opcode": "text",
          "ihr_disabled": false,
          "bounce": false,
          "bounced": false,
          "import_fee": "text",
          "message_content": {
            "hash": "text",
            "body": "text",
            "decoded": {
              "comment": "text"
            }
          },
          "init_state": {
            "hash": "text",
            "body": "text"
          }
        }
      ],
      "account_state_before": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "account_state_after": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "mc_block_seqno": 0
    }
  ]
}

Get Adjacent Transactions

Returns parent and/or children for specified transaction.

GET/api/v3/adjacentTransactions

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

transactions*Transactions

address_book*Address Book

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/adjacentTransactions?hash=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "transactions": [
    {
      "account": "text",
      "hash": "text",
      "lt": "text",
      "now": 0,
      "orig_status": "uninit",
      "end_status": "uninit",
      "total_fees": "text",
      "prev_trans_hash": "text",
      "prev_trans_lt": "text",
      "block_ref": {
        "workchain": 0,
        "shard": "text",
        "seqno": 0
      },
      "in_msg": {
        "hash": "text",
        "source": "text",
        "destination": "text",
        "value": "text",
        "fwd_fee": "text",
        "ihr_fee": "text",
        "created_lt": "text",
        "created_at": "text",
        "opcode": "text",
        "ihr_disabled": false,
        "bounce": false,
        "bounced": false,
        "import_fee": "text",
        "message_content": {
          "hash": "text",
          "body": "text",
          "decoded": {
            "comment": "text"
          }
        },
        "init_state": {
          "hash": "text",
          "body": "text"
        }
      },
      "out_msgs": [
        {
          "hash": "text",
          "source": "text",
          "destination": "text",
          "value": "text",
          "fwd_fee": "text",
          "ihr_fee": "text",
          "created_lt": "text",
          "created_at": "text",
          "opcode": "text",
          "ihr_disabled": false,
          "bounce": false,
          "bounced": false,
          "import_fee": "text",
          "message_content": {
            "hash": "text",
            "body": "text",
            "decoded": {
              "comment": "text"
            }
          },
          "init_state": {
            "hash": "text",
            "body": "text"
          }
        }
      ],
      "account_state_before": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "account_state_after": {
        "hash": "text",
        "balance": "text",
        "account_status": "uninit",
        "frozen_hash": "text",
        "code_hash": "text",
        "data_hash": "text"
      },
      "mc_block_seqno": 0
    }
  ]
}

Get Messages

Returns messages by specified filters.

GET/api/v3/messages

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

messages*Messages

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/messages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "messages": [
    {
      "hash": "text",
      "source": "text",
      "destination": "text",
      "value": "text",
      "fwd_fee": "text",
      "ihr_fee": "text",
      "created_lt": "text",
      "created_at": "text",
      "opcode": "text",
      "ihr_disabled": false,
      "bounce": false,
      "bounced": false,
      "import_fee": "text",
      "message_content": {
        "hash": "text",
        "body": "text",
        "decoded": {
          "comment": "text"
        }
      },
      "init_state": {
        "hash": "text",
        "body": "text"
      }
    }
  ]
}

Get Nft Collections

Returns NFT collections.

GET/api/v3/nft/collections

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

nft_collections*Nft Collections

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/nft/collections', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "nft_collections": [
    {
      "address": "text",
      "owner_address": "text",
      "last_transaction_lt": "text",
      "next_item_index": "text",
      "code_hash": "text",
      "data_hash": "text"
    }
  ]
}

Get Nft Items

Returns NFT items.

GET/api/v3/nft/items

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

nft_items*Nft Items

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/nft/items', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "nft_items": [
    {
      "address": "text",
      "collection_address": "text",
      "owner_address": "text",
      "init": false,
      "index": "text",
      "last_transaction_lt": "text",
      "code_hash": "text",
      "data_hash": "text",
      "collection": {
        "address": "text",
        "owner_address": "text",
        "last_transaction_lt": "text",
        "next_item_index": "text",
        "code_hash": "text",
        "data_hash": "text"
      }
    }
  ]
}

Get Nft Transfers

Returns NFT transfers by specified filters.

GET/api/v3/nft/transfers

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

nft_transfers*Nft Transfers

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/nft/transfers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "nft_transfers": [
    {
      "query_id": "text",
      "nft_address": "text",
      "transaction_hash": "text",
      "transaction_lt": "text",
      "transaction_now": 0,
      "old_owner": "text",
      "new_owner": "text",
      "response_destination": "text",
      "custom_payload": "text",
      "forward_amount": "text",
      "forward_payload": "text"
    }
  ]
}

Get Jetton Masters

Returns Jetton masters by specified filters.

GET/api/v3/jetton/masters

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

jetton_masters*Jetton Masters

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/jetton/masters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "jetton_masters": [
    {
      "address": "text",
      "total_supply": "text",
      "mintable": false,
      "admin_address": "text",
      "last_transaction_lt": "text",
      "jetton_wallet_code_hash": "text",
      "code_hash": "text",
      "data_hash": "text"
    }
  ]
}

Get Jetton Wallets

Returns Jetton wallets by specified filters.

GET/api/v3/jetton/wallets

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

jetton_wallets*Jetton Wallets

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/jetton/wallets', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "jetton_wallets": [
    {
      "address": "text",
      "balance": "text",
      "owner": "text",
      "jetton": "text",
      "last_transaction_lt": "text",
      "code_hash": "text",
      "data_hash": "text"
    }
  ]
}

Get Jetton Transfers

Returns Jetton transfers by specified filters.

GET/api/v3/jetton/transfers

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

jetton_transfers*Jetton Transfers

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/jetton/transfers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "jetton_transfers": [
    {
      "query_id": "text",
      "source": "text",
      "destination": "text",
      "amount": "text",
      "source_wallet": "text",
      "jetton_master": "text",
      "transaction_hash": "text",
      "transaction_lt": "text",
      "transaction_now": 0,
      "response_destination": "text",
      "custom_payload": "text",
      "forward_ton_amount": "text",
      "forward_payload": "text"
    }
  ]
}

Get Jetton Burns

Returns Jetton burns by specified filters.

GET/api/v3/jetton/burns

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

jetton_burns*Jetton Burns

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/jetton/burns', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "jetton_burns": [
    {
      "query_id": "text",
      "owner": "text",
      "jetton_wallet": "text",
      "jetton_master": "text",
      "transaction_hash": "text",
      "transaction_lt": "text",
      "transaction_now": 0,
      "amount": "text",
      "response_destination": "text",
      "custom_payload": "text"
    }
  ]
}

Send Message

Send external message in boc base64 format to TON network. Returns message hash in hex format.

External messages are sent from the outside to the smart contracts to make them perform certain actions. For instance, a wallet smart contract expects to receive external messages signed by the wallet's owner.

POST/api/v3/message

Authorization

APIKeyHeaderAPIKeyQuery

Body

application/json

boc*Boc

Response

200422

Successful Response

Body

application/json

message_hash*Message Hash

Hash of sent message in hex format

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/message', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "boc": "text"
    }),
});
const data = await response.json();

Response

200422

{
  "message_hash": "text"
}

Run Get Method

Run get method of smart contract. Stack supports only num, cell and slice types:

[
    {
        "type": "num",
        "value": "0x12a"
    },
    {
        "type": "cell",
        "value": "te6..." // base64 encoded boc with cell
    },
    {
        "type": "slice",
        "value": "te6..." // base64 encoded boc with slice
    }
]

POST/api/v3/runGetMethod

Authorization

APIKeyHeaderAPIKeyQuery

Body

application/json

address*Address

Contract address in any format

method*Method

Method name to run

stack*Stack

stack arguments

Response

200422

Successful Response

Body

application/json

gas_used*Gas Used

exit_code*Exit Code

stack*Stack

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/runGetMethod', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": "text",
      "method": "text",
      "stack": [
        {
          "type": "cell",
          "value": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200422

{
  "gas_used": 0,
  "exit_code": 0,
  "stack": [
    {
      "type": "cell",
      "value": []
    }
  ]
}

Get Account Information

Get smart contract information.

GET/api/v3/account

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

balance*Balance

code*Code

stringnull

data*Data

stringnull

last_transaction_lt*Last Transaction Lt

stringnull

last_transaction_hash*Last Transaction Hash

stringnull

frozen_hash*Frozen Hash

stringnull

status*AccountStatus

uninitfrozenactivenonexist

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/account?address=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "balance": "text",
  "code": "text",
  "data": "text",
  "last_transaction_lt": "text",
  "last_transaction_hash": "text",
  "frozen_hash": "text",
  "status": "uninit"
}

Estimate Fee

Estimate fees required for query processing.

Body, init_code and init_data accepted in base64 encoded format.

POST/api/v3/estimateFee

Authorization

APIKeyHeaderAPIKeyQuery

Body

application/json

address*Address

body*Body

init_codeInit Code

stringnull

init_dataInit Data

stringnull

ignore_chksigIgnore Chksig

Response

200422

Successful Response

Body

application/json

source_fees*Fee

destination_fees*Destination Fees

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/estimateFee', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "address": "text",
      "body": "text"
    }),
});
const data = await response.json();

Response

200422

{
  "source_fees": {
    "in_fwd_fee": 0,
    "storage_fee": 0,
    "gas_fee": 0,
    "fwd_fee": 0
  },
  "destination_fees": [
    {
      "in_fwd_fee": 0,
      "storage_fee": 0,
      "gas_fee": 0,
      "fwd_fee": 0
    }
  ]
}

Get Wallet Information

Get wallet smart contract information. The following wallets are supported: v1r1, v1r2, v1r3, v2r1, v2r2, v3r1, v3r2, v4r1, v4r2. In case the account is not a wallet error code 409 is returned.

GET/api/v3/wallet

Authorization

APIKeyHeaderAPIKeyQuery

Query parameters

Response

200422

Successful Response

Body

application/json

balance*Balance

wallet_type*Wallet Type

stringnull

seqno*Seqno

integernull

wallet_id*Wallet Id

integernull

last_transaction_lt*Last Transaction Lt

stringnull

last_transaction_hash*Last Transaction Hash

stringnull

status*AccountStatus

uninitfrozenactivenonexist

Request

JavaScriptCurlPython

const response = await fetch('/api/v3/wallet?address=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "balance": "text",
  "wallet_type": "text",
  "seqno": 0,
  "wallet_id": 0,
  "last_transaction_lt": "text",
  "last_transaction_hash": "text",
  "status": "uninit"
}