openapi: 3.0.3 info: title: Chainstack TON Node API version: 1.0.0 description: Chainstack-managed RPC node API for the TON blockchain. Endpoints follow the canonical JSON-RPC over HTTPS interface for the network. Authenticate against your Chainstack node's per-node URL (e.g. https://nd-XXX-XXX-XXX.p2pify.com/). Merged from the Chainstack Developer Portal per-method fragments at https://github.com/chainstack/dev-portal/tree/main/openapi/ton_node_api. contact: name: Chainstack API Support email: support@chainstack.com license: name: Chainstack Terms url: https://chainstack.com/terms-of-service/ servers: - url: https://{node_id}.p2pify.com/{api_key} description: Chainstack-managed node endpoint variables: node_id: default: nd-000-000-000 description: Your Chainstack node identifier api_key: default: description: Per-node access key tags: - name: V2 - name: V3 paths: /detectAddress: get: tags: - V2 summary: detectAddress operationId: detectAddress parameters: - name: address in: query required: true description: The address to detect schema: type: string default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 responses: '200': description: Information about the detected address content: application/json: schema: type: object properties: raw_form: type: string description: The raw form of the address bounceable: type: object properties: b64: type: string description: The bounceable address in base64 format b64url: type: string description: The bounceable address in base64url format non_bounceable: type: object properties: b64: type: string description: The non-bounceable address in base64 format b64url: type: string description: The non-bounceable address in base64url format given_type: type: string description: The type of the given address test_only: type: boolean description: Whether the address is for testnet only /estimateFee: post: tags: - V2 summary: estimateFee operationId: estimateFee requestBody: required: true content: application/json: schema: type: object properties: address: type: string description: The address to send the message from default: EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs body: type: string description: The body of the message in base64 format default: te6cckEBAQEAAgAAAEysuc0= init_code: type: string description: Optional init code in base64 format for contract deployment init_data: type: string description: Optional init data in base64 format for contract deployment ignore_chksig: type: boolean description: Whether to ignore the signature check default: true required: - address - body responses: '200': description: The estimated fee for the message content: application/json: schema: type: object properties: ok: type: boolean description: Whether the operation was successful result: type: object properties: '@type': type: string description: The type of the result source_fees: type: object properties: '@type': type: string in_fwd_fee: type: integer description: The incoming forward fee storage_fee: type: integer description: The storage fee gas_fee: type: integer description: The gas fee fwd_fee: type: integer description: The forward fee destination_fees: type: array items: type: object description: Array of destination fees '@extra': type: string description: Extra information /getAddressBalance: get: tags: - V2 summary: getAddressBalance operationId: getAddressBalance parameters: - name: address in: query required: true description: The address to get the balance for schema: type: string default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 responses: '200': description: The balance of the specified address content: application/json: schema: type: object properties: balance: type: string description: The balance of the address in nanotons /getAddressInformation: get: tags: - V2 summary: getAddressInformation operationId: getAddressInformation parameters: - name: address in: query required: true description: The address to get information for schema: type: string default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 responses: '200': description: Information about the specified address content: application/json: schema: type: object properties: balance: type: string description: The balance of the address state: type: string description: The state of the address code: type: string description: The code of the address data: type: string description: The data of the address last_transaction_id: type: object properties: lt: type: string description: The logical time of the last transaction hash: type: string description: The hash of the last transaction error: type: object id: type: integer /getAddressState: get: tags: - V2 summary: getAddressState operationId: getAddressState parameters: - name: address in: query required: true description: The address to get the state for schema: type: string default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 responses: '200': description: The current state of the specified address content: application/json: schema: type: object properties: state: type: string description: The current state of the address enum: - active - uninitialized - frozen /getBlockHeader: get: tags: - V2 summary: getBlockHeader operationId: getBlockHeader parameters: - name: workchain in: query required: true description: The workchain ID schema: type: integer default: -1 example: -1 - name: shard in: query required: true description: The shard ID schema: type: string default: '-9223372036854775808' example: '-9223372036854775808' - name: seqno in: query required: true description: The sequence number of the block schema: type: integer default: 39064874 example: 39064874 responses: '200': description: The header of the specified block content: application/json: schema: type: object properties: id: type: object properties: workchain: type: integer description: The workchain ID of the block shard: type: string description: The shard ID of the block seqno: type: integer description: The sequence number of the block root_hash: type: string description: The root hash of the block file_hash: type: string description: The file hash of the block global_id: type: integer description: The global ID of the block version: type: integer description: The version of the block after_merge: type: boolean description: Whether the block was created after a merge before_split: type: boolean description: Whether the block was created before a split after_split: type: boolean description: Whether the block was created after a split want_merge: type: boolean description: Whether the block wants to merge want_split: type: boolean description: Whether the block wants to split validator_list_hash_short: type: integer description: The short hash of the validator list catchain_seqno: type: integer description: The sequence number in the catchain min_ref_mc_seqno: type: integer description: The minimum referenced masterchain sequence number is_key_block: type: boolean description: Whether the block is a key block prev_key_block_seqno: type: integer description: The sequence number of the previous key block start_lt: type: string description: The start logical time of the block end_lt: type: string description: The end logical time of the block gen_utime: type: integer description: The generation time of the block vert_seqno: type: integer description: The vertical sequence number of the block /getBlockTransactions: get: tags: - V2 summary: getBlockTransactions operationId: getBlockTransactions parameters: - name: workchain in: query required: true description: The workchain ID schema: type: integer default: -1 example: -1 - name: shard in: query required: true description: The shard ID schema: type: string default: '-9223372036854775808' example: '-9223372036854775808' - name: seqno in: query required: true description: The sequence number of the block schema: type: integer default: 39064874 example: 39064874 - name: count in: query required: false description: The maximum number of transactions to return schema: type: integer default: 40 example: 40 responses: '200': description: Transactions from the specified block content: application/json: schema: type: object properties: id: type: object properties: workchain: type: integer description: The workchain ID of the block shard: type: string description: The shard ID of the block seqno: type: integer description: The sequence number of the block root_hash: type: string description: The root hash of the block file_hash: type: string description: The file hash of the block transactions: type: array items: type: object properties: account: type: string description: The account address involved in the transaction hash: type: string description: The transaction hash lt: type: string description: The logical time of the transaction incomplete: type: boolean description: Indicates if the returned list is incomplete /getBlockTransactionsExt: get: tags: - V2 summary: getBlockTransactionsExt operationId: getBlockTransactionsExt parameters: - name: workchain in: query required: true description: The workchain ID schema: type: integer default: -1 example: -1 - name: shard in: query required: true description: The shard ID schema: type: string default: '-9223372036854775808' example: '-9223372036854775808' - name: seqno in: query required: true description: The sequence number of the block schema: type: integer default: 39064874 example: 39064874 - name: count in: query required: false description: The maximum number of transactions to return schema: type: integer default: 40 example: 40 responses: '200': description: Extended transaction information from the specified block content: application/json: schema: type: object properties: id: type: object properties: workchain: type: integer description: The workchain ID of the block shard: type: string description: The shard ID of the block seqno: type: integer description: The sequence number of the block root_hash: type: string description: The root hash of the block file_hash: type: string description: The file hash of the block transactions: type: array items: type: object properties: account: type: string description: The account address involved in the transaction hash: type: string description: The transaction hash lt: type: string description: The logical time of the transaction transaction: type: object description: Detailed transaction information incomplete: type: boolean description: Indicates if the returned list is incomplete /getConfigParam: get: tags: - V2 summary: getConfigParam operationId: getConfigParam parameters: - name: config_id in: query required: true description: The ID of the configuration parameter to retrieve schema: type: integer default: 5 example: 5 responses: '200': description: The requested configuration parameter content: application/json: schema: type: object properties: config_id: type: integer description: The ID of the configuration parameter value: type: object description: The value of the configuration parameter additionalProperties: true /getConsensusBlock: get: tags: - V2 summary: getConsensusBlock operationId: getConsensusBlock responses: '200': description: Information about the latest consensus block content: application/json: schema: type: object properties: consensus_block: type: integer description: The sequence number of the latest consensus block timestamp: type: integer description: The Unix timestamp of the latest consensus block timestamp_string: type: string description: The human-readable timestamp of the latest consensus block /getExtendedAddressInformation: get: tags: - V2 summary: getExtendedAddressInformation operationId: getExtendedAddressInformation parameters: - name: address in: query required: true description: The address to get extended information for schema: type: string default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 responses: '200': description: Extended information about the specified address content: application/json: schema: type: object properties: address: type: string description: The address in human-readable form balance: type: string description: The balance of the address in nanotons state: type: string description: The state of the address (active, uninitialized, etc.) last_transaction_id: type: object properties: lt: type: string description: The logical time of the last transaction hash: type: string description: The hash of the last transaction block_id: type: object properties: workchain: type: integer description: The workchain ID shard: type: string description: The shard ID seqno: type: integer description: The sequence number code_hash: type: string description: The hash of the contract code data_hash: type: string description: The hash of the contract data acc_type: type: integer description: The account type acc_type_name: type: string description: The human-readable account type name /getMasterchainBlockSignatures: get: tags: - V2 summary: getMasterchainBlockSignatures operationId: getMasterchainBlockSignatures parameters: - name: seqno in: query required: true description: The sequence number of the masterchain block schema: type: integer default: 39064874 example: 39064874 responses: '200': description: Signatures of the specified masterchain block content: application/json: schema: type: object properties: signatures: type: array items: type: object properties: node_id: type: string description: The ID of the validator node r: type: string description: The 'r' component of the signature s: type: string description: The 's' component of the signature validator_set_hash: type: string description: The hash of the validator set catchain_seqno: type: integer description: The sequence number in the catchain /getMasterchainInfo: get: tags: - V2 summary: getMasterchainInfo operationId: getMasterchainInfo responses: '200': description: Information about the current state of the TON masterchain content: application/json: schema: type: object properties: last: type: object properties: seqno: type: integer description: The sequence number of the last masterchain block shard: type: string description: The shard identifier of the last masterchain block workchain: type: integer description: The workchain identifier of the last masterchain block fileHash: type: string description: The file hash of the last masterchain block rootHash: type: string description: The root hash of the last masterchain block init: type: object properties: fileHash: type: string description: The file hash of the initial masterchain block rootHash: type: string description: The root hash of the initial masterchain block stateRootHash: type: string description: The state root hash of the masterchain version: type: integer description: The version of the masterchain /getShardBlockProof: get: tags: - V2 summary: getShardBlockProof operationId: getShardBlockProof parameters: - name: workchain in: query required: true description: The workchain ID schema: type: integer default: -1 example: -1 - name: shard in: query required: true description: The shard ID schema: type: string default: '-9223372036854775808' example: '-9223372036854775808' - name: seqno in: query required: true description: The sequence number of the block schema: type: integer default: 39064874 example: 39064874 responses: '200': description: Proof of the specified shard block content: application/json: schema: type: object properties: masterchain_block_root_hash: type: string description: The root hash of the masterchain block masterchain_block_seq_no: type: integer description: The sequence number of the masterchain block links: type: array items: type: object properties: from: type: string description: The source block hash to: type: string description: The destination block hash dest_proof: type: string description: The proof of the destination block proof: type: string description: The proof of the link block_header: type: string description: The header of the shard block /getTokenData: get: tags: - V2 summary: getTokenData operationId: getTokenData parameters: - name: address in: query required: true description: The address of the token contract schema: type: string default: EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs example: EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs responses: '200': description: Data about the specified token content: application/json: schema: type: object properties: name: type: string description: The name of the token symbol: type: string description: The symbol of the token decimals: type: integer description: The number of decimal places for the token totalSupply: type: string description: The total supply of the token mintable: type: boolean description: Whether the token is mintable burnable: type: boolean description: Whether the token is burnable address: type: string description: The address of the token contract /getTransactions: get: tags: - V2 summary: getTransactions operationId: getTransactions parameters: - name: address in: query required: true description: The address to get transactions for schema: type: string default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 - name: limit in: query required: false description: The maximum number of transactions to return schema: type: integer default: 10 example: 10 - name: to_lt in: query required: false description: The logical time to start the search from (0 means from the latest) schema: type: integer default: 0 example: 0 - name: archival in: query required: false description: Whether to use archival node for the query schema: type: boolean default: false example: false responses: '200': description: Transaction history for the specified address content: application/json: schema: type: array items: type: object properties: transaction_id: type: object properties: lt: type: string description: The logical time of the transaction hash: type: string description: The hash of the transaction utime: type: integer description: Unix timestamp of the transaction fee: type: string description: The fee for the transaction in nanotons storage_fee: type: string description: The storage fee for the transaction in nanotons other_fee: type: string description: Other fees for the transaction in nanotons transaction_type: type: string description: The type of the transaction compute: type: object description: Computation details of the transaction action: type: object description: Action details of the transaction in_msg: type: object description: Details of the incoming message out_msgs: type: array description: Details of the outgoing messages /getWalletInformation: get: tags: - V2 summary: getWalletInformation operationId: getWalletInformation parameters: - name: address in: query required: true description: The address to get wallet information for schema: type: string default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 responses: '200': description: Wallet information for the specified address content: application/json: schema: type: object properties: wallet: type: boolean description: Indicates if the address is a wallet balance: type: string description: The balance of the wallet in nanotons account_state: type: string description: The state of the account (active, uninitialized, etc.) wallet_type: type: string description: The type of the wallet contract seqno: type: integer description: The current sequence number of the wallet last_transaction_id: type: object properties: lt: type: string description: The logical time of the last transaction hash: type: string description: The hash of the last transaction /jsonRPC: post: tags: - V2 summary: Jsonrpc Handler description: All methods in the API are available through JSON-RPC protocol ([spec](https://www.jsonrpc.org/specification)). operationId: jsonrpc_handler_jsonRPC_post requestBody: content: application/json: schema: $ref: '#/components/schemas/TonRequestJsonRPC' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DeprecatedTonResponseJsonRPC' '422': description: Validation Error '504': description: Lite Server Timeout security: - APIKeyHeader: [] - APIKeyQuery: [] /lookupBlock: get: tags: - V2 summary: lookupBlock operationId: lookupBlock parameters: - name: workchain in: query required: true description: The workchain ID schema: type: integer default: -1 example: -1 - name: shard in: query required: true description: The shard ID schema: type: string default: '-9223372036854775808' example: '-9223372036854775808' - name: seqno in: query required: true description: The sequence number of the block schema: type: integer default: 39064874 example: 39064874 responses: '200': description: Information about the specified block content: application/json: schema: type: object properties: id: type: object properties: workchain: type: integer description: The workchain ID of the block shard: type: string description: The shard ID of the block seqno: type: integer description: The sequence number of the block root_hash: type: string description: The root hash of the block file_hash: type: string description: The file hash of the block status: type: integer description: The status of the block global_id: type: integer description: The global ID of the block version: type: integer description: The version of the block after_merge: type: boolean description: Whether the block was created after a merge before_split: type: boolean description: Whether the block was created before a split want_merge: type: boolean description: Whether the block wants to merge want_split: type: boolean description: Whether the block wants to split gen_utime: type: integer description: The generation time of the block start_lt: type: string description: The start logical time of the block end_lt: type: string description: The end logical time of the block /packAddress: get: tags: - V2 summary: packAddress operationId: packAddress parameters: - name: address in: query required: true description: The raw address to pack schema: type: string default: 0:ed1691307050047117b998b561d8de82d31fbf84910ced6eb5fc92e7485ef8a7 example: 0:ed1691307050047117b998b561d8de82d31fbf84910ced6eb5fc92e7485ef8a7 responses: '200': description: The packed (user-friendly) address content: application/json: schema: type: object properties: address: type: string description: The packed address in user-friendly format /runGetMethod: post: tags: - V2 summary: runGetMethod operationId: runGetMethod requestBody: required: true content: application/json: schema: type: object properties: address: type: string description: The address of the smart contract default: EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs method: type: string description: The name of the get method to execute default: get_wallet_address stack: type: array description: The stack of parameters for the method items: type: array items: type: string default: - - tvm.Slice - te6cckEBAQEAJAAAQ4AbUzrTQYTUv8s/I9ds2TSZgRjyrgl2S2LKcZMEFcxj6PARy3rF responses: '200': description: The result of executing the get method content: application/json: schema: type: object properties: exit_code: type: integer description: The exit code of the method execution stack: type: array description: The resulting stack after method execution items: type: array items: type: string gas_used: type: integer description: The amount of gas used for the execution /sendBoc: post: tags: - V2 summary: sendBoc operationId: sendBoc requestBody: required: true content: application/json: schema: type: object properties: boc: type: string description: The serialized bag-of-cells in base64 format default: te6ccgEBAgEAqwAB4YgBVbC7Hu+g3htYXzst8L5ucV76NMzeBK3URJKebN2Y1kwADRfFu/r0HxgrOp/Iml8Li5x4gR10J5XYFS8z0fMWJ6JPeUF5xNSLrSDGFIqhJqkW1SEYQF8Dw5p4dI3oaFs4LCmpoxdkfKw0AAAAGAAcAQBoQgAwwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAL68= required: - boc responses: '200': description: The result of sending the BoC content: application/json: schema: type: object properties: ok: type: boolean description: Whether the operation was successful result: type: object nullable: true properties: '@type': type: string description: The type of the result '@extra': type: string description: Extra information /sendBocReturnHash: post: tags: - V2 summary: sendBocReturnHash operationId: sendBocReturnHash requestBody: required: true content: application/json: schema: type: object properties: boc: type: string description: The serialized bag-of-cells in base64 format default: te6ccgEBAgEAqwAB4YgBVbC7Hu+g3htYXzst8L5ucV76NMzeBK3URJKebN2Y1kwADRfFu/r0HxgrOp/Iml8Li5x4gR10J5XYFS8z0fMWJ6JPeUF5xNSLrSDGFIqhJqkW1SEYQF8Dw5p4dI3oaFs4LCmpoxdkfKw0AAAAGAAcAQBoQgAwwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAL68= required: - boc responses: '200': description: The result of sending the BoC with the message hash content: application/json: schema: type: object properties: ok: type: boolean description: Whether the operation was successful result: type: object properties: '@type': type: string description: The type of the result hash: type: string description: The hash of the sent message '@extra': type: string description: Extra information /sendQuery: post: tags: - V2 summary: sendQuery operationId: sendQuery requestBody: required: true content: application/json: schema: type: object properties: address: type: string description: The destination address for the message default: EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs body: type: string description: The body of the message in base64 format default: te6cckEBAQEAAgAAAEysuc0= init_code: type: string description: Optional init code in base64 format for contract deployment init_data: type: string description: Optional init data in base64 format for contract deployment required: - address - body responses: '200': description: The result of sending the query content: application/json: schema: type: object properties: ok: type: boolean description: Whether the operation was successful result: type: object nullable: true properties: '@type': type: string description: The type of the result '@extra': type: string description: Extra information /shards: get: tags: - V2 summary: Shards operationId: shards parameters: - name: seqno in: query required: true description: The sequence number of the masterchain block schema: type: integer default: 39064874 example: 39064874 responses: '200': description: Information about shards for the specified masterchain block content: application/json: schema: type: object properties: shards: type: array items: type: object properties: workchain: type: integer description: The workchain ID shard: type: string description: The shard ID seqno: type: integer description: The sequence number of the shard block root_hash: type: string description: The root hash of the shard block file_hash: type: string description: The file hash of the shard block /tryLocateResultTx: get: tags: - V2 summary: tryLocateResultTx operationId: tryLocateResultTx parameters: - name: source in: query required: true description: The source address of the original transaction schema: type: string default: UQAX2d4C2d48JeA-0y2_peGabRVumnKY22xPvkuEayC3zTI1 example: UQAX2d4C2d48JeA-0y2_peGabRVumnKY22xPvkuEayC3zTI1 - name: destination in: query required: true description: The destination address of the original transaction schema: type: string default: UQBP4mzpDIywL1SV-Wp9ZuBBlzprR9eXQgSYGEXiUEHm73vA example: UQBP4mzpDIywL1SV-Wp9ZuBBlzprR9eXQgSYGEXiUEHm73vA - name: created_lt in: query required: true description: The logical time when the original transaction was created schema: type: string default: '47597573000002' example: '47597573000002' responses: '200': description: Information about the located result transaction content: application/json: schema: type: object properties: block: type: object properties: workchain: type: integer description: The workchain ID of the block containing the result transaction shard: type: string description: The shard ID of the block containing the result transaction seqno: type: integer description: The sequence number of the block containing the result transaction root_hash: type: string description: The root hash of the block containing the result transaction file_hash: type: string description: The file hash of the block containing the result transaction transaction_id: type: object properties: lt: type: string description: The logical time of the result transaction hash: type: string description: The hash of the result transaction /tryLocateSourceTx: get: tags: - V2 summary: tryLocateSourceTx operationId: tryLocateSourceTx parameters: - name: source in: query required: true description: The source address of the result transaction schema: type: string default: UQAX2d4C2d48JeA-0y2_peGabRVumnKY22xPvkuEayC3zTI1 example: UQAX2d4C2d48JeA-0y2_peGabRVumnKY22xPvkuEayC3zTI1 - name: destination in: query required: true description: The destination address of the result transaction schema: type: string default: UQBP4mzpDIywL1SV-Wp9ZuBBlzprR9eXQgSYGEXiUEHm73vA example: UQBP4mzpDIywL1SV-Wp9ZuBBlzprR9eXQgSYGEXiUEHm73vA - name: created_lt in: query required: true description: The logical time when the result transaction was created schema: type: string default: '47597573000002' example: '47597573000002' responses: '200': description: Information about the located source transaction content: application/json: schema: type: object properties: block: type: object properties: workchain: type: integer description: The workchain ID of the block containing the source transaction shard: type: string description: The shard ID of the block containing the source transaction seqno: type: integer description: The sequence number of the block containing the source transaction root_hash: type: string description: The root hash of the block containing the source transaction file_hash: type: string description: The file hash of the block containing the source transaction transaction_id: type: object properties: lt: type: string description: The logical time of the source transaction hash: type: string description: The hash of the source transaction /tryLocateTx: get: tags: - V2 summary: tryLocateTx operationId: tryLocateTx parameters: - name: source in: query required: true description: The source address of the transaction schema: type: string default: UQAX2d4C2d48JeA-0y2_peGabRVumnKY22xPvkuEayC3zTI1 example: UQAX2d4C2d48JeA-0y2_peGabRVumnKY22xPvkuEayC3zTI1 - name: destination in: query required: true description: The destination address of the transaction schema: type: string default: UQBP4mzpDIywL1SV-Wp9ZuBBlzprR9eXQgSYGEXiUEHm73vA example: UQBP4mzpDIywL1SV-Wp9ZuBBlzprR9eXQgSYGEXiUEHm73vA - name: created_lt in: query required: true description: The logical time when the transaction was created schema: type: string default: '47597573000002' example: '47597573000002' responses: '200': description: Information about the located transaction content: application/json: schema: type: object properties: block: type: object properties: workchain: type: integer description: The workchain ID of the block containing the transaction shard: type: string description: The shard ID of the block containing the transaction seqno: type: integer description: The sequence number of the block containing the transaction root_hash: type: string description: The root hash of the block containing the transaction file_hash: type: string description: The file hash of the block containing the transaction transaction_id: type: object properties: lt: type: string description: The logical time of the transaction hash: type: string description: The hash of the transaction /unpackAddress: get: tags: - V2 summary: unpackAddress operationId: unpackAddress parameters: - name: address in: query required: true description: The user-friendly address to unpack schema: type: string default: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 example: EQDtFpEwcFAEcRe5mLVh2N6C0x-_hJEM7W61_JLnSF74p4q2 responses: '200': description: The unpacked (raw) address content: application/json: schema: type: object properties: address: type: string description: The unpacked address in raw format /getAccountInfo: get: summary: Get Account Information description: Retrieves information about a specific account on the TON blockchain operationId: getAccountInfo tags: - V3 parameters: - name: address in: query description: The address of the account to retrieve information for required: true schema: type: string default: Ef-1JetbPF9ubc1ga-57oHoOyDA1IShJt-BVlJnA9rrVTfrB example: Ef-1JetbPF9ubc1ga-57oHoOyDA1IShJt-BVlJnA9rrVTfrB responses: '200': description: Successful response content: application/json: schema: type: object properties: address: type: string description: The account address balance: type: string description: The account balance in nanotons last_activity: type: integer description: The timestamp of the last account activity status: type: string description: The status of the account (e.g., active, frozen) code_hash: type: string description: The hash of the account's code data_hash: type: string description: The hash of the account's data /getAccountStates: get: summary: Get Account States description: Query account states with historical data operationId: getAccountStates tags: - V3 parameters: - name: account_address in: query description: Account address to query schema: type: string default: EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs - name: include_boc in: query description: Include account state BoC in response schema: type: boolean default: false - name: limit in: query description: Maximum number of states to return schema: type: integer default: 10 - name: offset in: query description: Number of states to skip schema: type: integer default: 0 - name: sort in: query description: Sort order schema: type: string enum: - asc - desc default: desc responses: '200': description: Successful response content: application/json: schema: type: object properties: account_states: type: array items: type: object properties: account: type: string description: Account address hash: type: string description: State hash balance: type: string description: Account balance in nanotons account_status: type: string description: Account status (active, uninit, frozen) last_trans_lt: type: integer description: Last transaction logical time last_trans_hash: type: string description: Last transaction hash frozen_hash: type: string description: Frozen hash if account is frozen code_hash: type: string description: Code cell hash data_hash: type: string description: Data cell hash code_boc: type: string description: Code BoC if include_boc is true data_boc: type: string description: Data BoC if include_boc is true address_book: type: object description: Address book mapping /getActions: get: summary: Get Actions description: Retrieves decoded actions from transactions operationId: getActions tags: - V3 parameters: - name: action_id in: query description: Action ID to filter by schema: type: string - name: trace_id in: query description: Trace ID to get actions for schema: type: string - name: tx_hash in: query description: Transaction hash to get actions for schema: type: string default: BhLJTdV2R6Vr5c3BAOjH8nFpnMYOuPcJvRlagGSKU88= - name: tx_lt in: query description: Transaction logical time schema: type: integer - name: account in: query description: Filter by account address schema: type: string - name: action_type in: query description: Filter by action type (e.g., JettonTransfer, NftItemTransfer) schema: type: string - name: start_utime in: query description: Start of the time range (unix timestamp) schema: type: integer - name: end_utime in: query description: End of the time range (unix timestamp) schema: type: integer - name: limit in: query description: Maximum number of actions to return schema: type: integer default: 10 - name: offset in: query description: Number of actions to skip schema: type: integer default: 0 - name: sort in: query description: Sort order schema: type: string enum: - asc - desc default: desc responses: '200': description: Successful response content: application/json: schema: type: object properties: actions: type: array items: type: object properties: action_id: type: string description: Unique identifier for the action trace_id: type: string description: Trace ID this action belongs to tx_hash: type: string description: Transaction hash type: type: string description: Type of action (e.g., JettonTransfer, TonTransfer) status: type: string description: Action status value: type: object description: Action-specific value data start_lt: type: integer description: Logical time at action start start_utime: type: integer description: Unix timestamp at action start end_lt: type: integer description: Logical time at action end end_utime: type: integer description: Unix timestamp at action end address_book: type: object description: Address book mapping addresses to user-friendly names /getAddressBookInfo: get: summary: Get Address Book Information description: Retrieves information about an address from the address book operationId: getAddressBookInfo tags: - V3 parameters: - name: address in: query description: The address to look up in the address book required: true schema: type: string default: 0:ed1691307050047117b998b561d8de82d31fbf84910ced6eb5fc92e7485ef8a7 responses: '200': description: Successful response content: application/json: schema: type: object properties: name: type: string description: The name associated with the address description: type: string description: A description of the address or associated entity icon: type: string description: URL of an icon associated with the address website: type: string description: Website associated with the address address: type: string description: The queried address /getAdjacentTransactions: get: summary: Get Adjacent Transactions description: Retrieves a list of transactions adjacent to a specific transaction operationId: getAdjacentTransactions tags: - V3 parameters: - name: hash in: query description: The hash of the reference transaction required: true schema: type: string default: a9d39a7f1e5f849835496b052885ed2ac07d54d5e0e11f2b17c3b00e3295a2b0 - name: direction in: query description: The direction of adjacent transactions to retrieve required: true schema: type: string enum: - before - after - both default: both - name: limit in: query description: The maximum number of transactions to return required: false schema: type: integer default: 128 - name: offset in: query description: The number of transactions to skip before starting to return results required: false schema: type: integer default: 0 - name: sort in: query description: The sorting order of the transactions required: false schema: type: string enum: - asc - desc default: desc responses: '200': description: Successful response content: application/json: schema: type: object properties: transactions: type: array items: type: object properties: hash: type: string description: The transaction hash lt: type: string description: The logical time of the transaction account: type: string description: The account address involved in the transaction now: type: integer description: The timestamp of the transaction origStatus: type: string description: The original status of the account endStatus: type: string description: The end status of the account totalFees: type: string description: The total fees for the transaction /getBlocks: get: summary: Get Blocks description: Retrieves a list of blocks from the TON blockchain operationId: getBlocks tags: - V3 parameters: - name: limit in: query description: The maximum number of blocks to return required: false schema: type: integer default: 128 - name: offset in: query description: The number of blocks to skip before starting to return results required: false schema: type: integer default: 0 - name: sort in: query description: The sorting order of the blocks required: false schema: type: string enum: - asc - desc default: desc responses: '200': description: Successful response content: application/json: schema: type: object properties: blocks: type: array items: type: object properties: seqno: type: integer description: The sequence number of the block shard: type: string description: The shard identifier of the block workchain: type: integer description: The workchain ID of the block fileHash: type: string description: The file hash of the block rootHash: type: string description: The root hash of the block timestamp: type: integer description: The timestamp of the block /getEvents: get: summary: Get Events description: Query blockchain events with decoded actions operationId: getEvents tags: - V3 parameters: - name: account in: query description: Filter by account address schema: type: string - name: start_utime in: query description: Start of time range (unix timestamp) schema: type: integer - name: end_utime in: query description: End of time range (unix timestamp) schema: type: integer - name: limit in: query description: Maximum number of events to return schema: type: integer default: 10 - name: offset in: query description: Number of events to skip schema: type: integer default: 0 - name: sort in: query description: Sort order schema: type: string enum: - asc - desc default: desc responses: '200': description: Successful response content: application/json: schema: type: object properties: events: type: array items: type: object properties: trace_id: type: string description: Trace ID external_hash: type: string description: External message hash mc_seqno_start: type: string description: Start masterchain sequence number mc_seqno_end: type: string description: End masterchain sequence number start_lt: type: string description: Start logical time start_utime: type: integer description: Start unix timestamp end_lt: type: string description: End logical time end_utime: type: integer description: End unix timestamp trace_info: type: object description: Trace information actions: type: array description: Decoded actions is_incomplete: type: boolean description: Whether event is incomplete address_book: type: object description: Address book mapping /getJettonBurns: get: summary: Get Jetton Burns description: Retrieves a list of Jetton burn events for a specific Jetton address from the TON blockchain operationId: getJettonBurns tags: - V3 parameters: - name: address in: query description: The address of the Jetton master contract required: true schema: type: string default: EQCvxJy4eG8hyHBFsZ7eePxrRsUQSFE_jpptRAYBmcG_DOGS - name: limit in: query description: The maximum number of burn events to return required: false schema: type: integer default: 128 - name: offset in: query description: The number of burn events to skip before starting to return results required: false schema: type: integer default: 0 - name: sort in: query description: The sorting order of the burn events required: false schema: type: string enum: - asc - desc default: desc responses: '200': description: Successful response content: application/json: schema: type: object properties: burns: type: array items: type: object properties: jetton: type: object properties: address: type: string description: The address of the Jetton master contract name: type: string description: The name of the Jetton symbol: type: string description: The symbol of the Jetton burner: type: object properties: address: type: string description: The address of the account that burned the Jettons transaction: type: object properties: hash: type: string description: The hash of the transaction time: type: integer description: The timestamp of the transaction amount: type: string description: The amount of Jettons burned comment: type: string description: Any comment attached to the burn event /getJettonMasters: get: summary: Get Jetton Masters description: Retrieves a list of Jetton master contracts from the TON blockchain operationId: getJettonMasters tags: - V3 parameters: - name: limit in: query description: The maximum number of Jetton masters to return required: false schema: type: integer default: 128 - name: offset in: query description: The number of Jetton masters to skip before starting to return results required: false schema: type: integer default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: masters: type: array items: type: object properties: address: type: string description: The address of the Jetton master contract name: type: string description: The name of the Jetton symbol: type: string description: The symbol of the Jetton decimals: type: integer description: The number of decimal places for the Jetton totalSupply: type: string description: The total supply of the Jetton mintable: type: boolean description: Whether new tokens can be minted admin: type: string description: The address of the Jetton admin metadata: type: object description: Additional metadata of the Jetton contentUri: type: string description: The URI of the Jetton's content /getJettonTransfers: get: summary: Get Jetton Transfers description: Retrieves a list of Jetton transfers from the TON blockchain operationId: getJettonTransfers tags: - V3 parameters: - name: direction in: query description: The direction of transfers to retrieve required: true schema: type: string enum: - in - out - both default: both - name: limit in: query description: The maximum number of transfers to return required: false schema: type: integer default: 128 - name: offset in: query description: The number of transfers to skip before starting to return results required: false schema: type: integer default: 0 - name: sort in: query description: The sorting order of the transfers required: false schema: type: string enum: - asc - desc default: desc responses: '200': description: Successful response content: application/json: schema: type: object properties: transfers: type: array items: type: object properties: jetton: type: object properties: address: type: string description: The address of the Jetton master contract name: type: string description: The name of the Jetton symbol: type: string description: The symbol of the Jetton from: type: object properties: address: type: string description: The address of the sender to: type: object properties: address: type: string description: The address of the recipient transaction: type: object properties: hash: type: string description: The hash of the transaction time: type: integer description: The timestamp of the transaction amount: type: string description: The amount of Jettons transferred comment: type: string description: Any comment attached to the transfer /getJettonWallets: get: summary: Get Jetton Wallets description: Retrieves a list of Jetton wallets from the TON blockchain operationId: getJettonWallets tags: - V3 parameters: - name: limit in: query description: The maximum number of Jetton wallets to return required: false schema: type: integer default: 128 - name: offset in: query description: The number of Jetton wallets to skip before starting to return results required: false schema: type: integer default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: wallets: type: array items: type: object properties: address: type: string description: The address of the Jetton wallet balance: type: string description: The balance of the Jetton wallet owner: type: string description: The address of the wallet owner jetton: type: object properties: address: type: string description: The address of the Jetton master contract name: type: string description: The name of the Jetton symbol: type: string description: The symbol of the Jetton decimals: type: integer description: The number of decimal places for the Jetton /getMasterchainBlockShardState: get: summary: Get Masterchain Block Shard State description: Retrieves the shard state of a specific masterchain block operationId: getMasterchainBlockShardState tags: - V3 parameters: - name: seqno in: query description: The sequence number of the masterchain block required: true schema: type: integer default: 40467413 example: 40467413 responses: '200': description: Successful response content: application/json: schema: type: object properties: shards: type: array items: type: object properties: workchain: type: integer description: The workchain ID shard: type: string description: The shard identifier seqno: type: integer description: The sequence number of the shard block root_hash: type: string description: The root hash of the shard block file_hash: type: string description: The file hash of the shard block /getMasterchainBlockShards: get: summary: Get Masterchain Block Shards description: Retrieves the shards of a specific masterchain block operationId: getMasterchainBlockShards tags: - V3 parameters: - name: seqno in: query description: The sequence number of the masterchain block required: true schema: type: integer default: 40467413 responses: '200': description: Successful response content: application/json: schema: type: object properties: shards: type: array items: type: object properties: workchain: type: integer description: The workchain ID shard: type: string description: The shard identifier seqno: type: integer description: The sequence number of the shard block rootHash: type: string description: The root hash of the shard block fileHash: type: string description: The file hash of the shard block /getMessages: get: summary: Get Messages description: Retrieves a list of messages from the TON blockchain operationId: getMessages tags: - V3 parameters: - name: limit in: query description: The maximum number of messages to return required: false schema: type: integer default: 128 - name: offset in: query description: The number of messages to skip before starting to return results required: false schema: type: integer default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: messages: type: array items: type: object properties: hash: type: string description: The message hash source: type: string description: The source address of the message destination: type: string description: The destination address of the message value: type: string description: The value transferred in the message fwd_fee: type: string description: The forward fee for the message ihr_fee: type: string description: The IHR (Instant Hypercube Routing) fee for the message created_lt: type: string description: The logical creation time of the message body_hash: type: string description: The hash of the message body /getMetadata: get: summary: Get Metadata description: Query address metadata including names and labels operationId: getMetadata tags: - V3 parameters: - name: address in: query description: Address to get metadata for required: true schema: type: string default: EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs responses: '200': description: Successful response content: application/json: schema: type: object properties: address: type: string description: The queried address name: type: string description: Human-readable name for the address is_scam: type: boolean description: Whether the address is flagged as scam icon: type: string description: URL to the address icon is_wallet: type: boolean description: Whether the address is a wallet contract /getMultisigOrders: get: summary: Get Multisig Orders description: Get pending orders for multisig wallets operationId: getMultisigOrders tags: - V3 parameters: - name: multisig_address in: query description: Filter by multisig wallet address schema: type: string - name: order_address in: query description: Filter by order contract address schema: type: string - name: is_executed in: query description: Filter by execution status schema: type: boolean - name: limit in: query description: Maximum number of orders to return schema: type: integer default: 10 - name: offset in: query description: Number of orders to skip schema: type: integer default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: multisig_orders: type: array items: type: object properties: address: type: string description: Order contract address multisig_address: type: string description: Parent multisig wallet address order_seqno: type: integer description: Order sequence number threshold: type: integer description: Required signatures signers_num: type: integer description: Total number of signers approvals_num: type: integer description: Current approvals count approvals: type: array items: type: string description: List of approving addresses expiration_date: type: integer description: Order expiration timestamp is_executed: type: boolean description: Whether order is executed address_book: type: object description: Address book mapping /getMultisigWallets: get: summary: Get Multisig Wallets description: Get multisig wallet contracts and their configuration operationId: getMultisigWallets tags: - V3 parameters: - name: address in: query description: Multisig wallet address schema: type: string - name: proposer_address in: query description: Filter by proposer address schema: type: string - name: limit in: query description: Maximum number of wallets to return schema: type: integer default: 10 - name: offset in: query description: Number of wallets to skip schema: type: integer default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: multisig_wallets: type: array items: type: object properties: address: type: string description: Multisig wallet address seqno: type: integer description: Current sequence number threshold: type: integer description: Required number of signatures signers: type: array items: type: string description: List of signer addresses proposers: type: array items: type: string description: List of proposer addresses orders_count: type: integer description: Number of pending orders address_book: type: object description: Address book mapping /getNFTCollections: get: summary: Get NFT Collections description: Retrieves a list of NFT collections from the TON blockchain operationId: getNFTCollections tags: - V3 parameters: - name: limit in: query description: The maximum number of collections to return required: false schema: type: integer default: 128 - name: offset in: query description: The number of collections to skip before starting to return results required: false schema: type: integer default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: collections: type: array items: type: object properties: address: type: string description: The address of the NFT collection name: type: string description: The name of the NFT collection description: type: string description: The description of the NFT collection metadata: type: object description: Additional metadata of the NFT collection owner: type: string description: The owner's address of the NFT collection raw_collection_content: type: string description: The raw content of the NFT collection next_item_index: type: integer description: The index of the next item in the collection icon: type: string description: The URL of the collection's icon /getNFTItems: get: summary: Get NFT Items description: Retrieves a list of NFT items from the TON blockchain operationId: getNFTItems tags: - V3 parameters: - name: address in: query description: 'NFT item address in any form. Max: 1000.' required: false schema: type: array items: type: string - name: owner_address in: query description: 'Address of NFT item owner in any form. Max: 1000.' required: false schema: type: array items: type: string - name: collection_address in: query description: Collection address in any form required: false schema: type: array items: type: string - name: index in: query description: 'Index of item for given collection. Max: 1000.' required: false schema: type: array items: type: string - name: sort_by_last_transaction_lt in: query description: 'Sort NFT items by last transaction lt descending. Warning: results may be inconsistent during pagination with limit and offset.' required: false schema: type: boolean - name: limit in: query description: The maximum number of NFT items to return required: false schema: type: integer default: 10 - name: offset in: query description: The number of NFT items to skip before starting to return results required: false schema: type: integer default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: nft_items: type: array items: type: object properties: address: type: string auction_contract_address: type: string code_hash: type: string collection: type: object properties: address: type: string code_hash: type: string collection_content: type: object additionalProperties: {} data_hash: type: string last_transaction_lt: type: string next_item_index: type: string owner_address: type: string collection_address: type: string content: type: object additionalProperties: {} data_hash: type: string index: type: string init: type: boolean last_transaction_lt: type: string on_sale: type: boolean owner_address: type: string real_owner: type: string sale_contract_address: type: string address_book: type: object additionalProperties: {} metadata: type: object additionalProperties: {} /getNFTTransfers: get: summary: Get NFT Transfers description: Retrieves a list of NFT transfers from the TON blockchain operationId: getNFTTransfers tags: - V3 parameters: - name: direction in: query description: The direction of transfers to retrieve required: true schema: type: string enum: - in - out - both default: both - name: limit in: query description: The maximum number of transfers to return required: false schema: type: integer default: 128 - name: offset in: query description: The number of transfers to skip before starting to return results required: false schema: type: integer default: 0 - name: sort in: query description: The sorting order of the transfers required: false schema: type: string enum: - asc - desc default: desc responses: '200': description: Successful response content: application/json: schema: type: object properties: transfers: type: array items: type: object properties: nft: type: object properties: address: type: string description: The address of the NFT item collection: type: object properties: address: type: string description: The address of the collection from: type: object properties: address: type: string description: The address of the sender to: type: object properties: address: type: string description: The address of the recipient transaction: type: object properties: hash: type: string description: The hash of the transaction time: type: integer description: The timestamp of the transaction value: type: string description: The value of the transfer (if any) /getPendingTraces: get: summary: Get Pending Traces description: Get traces that are pending completion operationId: getPendingTraces tags: - V3 parameters: - name: trace_id in: query description: Filter by trace ID schema: type: string - name: limit in: query description: Maximum number of traces to return schema: type: integer default: 10 - name: offset in: query description: Number of traces to skip schema: type: integer default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: traces: type: array items: type: object properties: trace_id: type: string description: Trace ID external_hash: type: string description: External message hash mc_seqno_start: type: integer description: Start masterchain sequence number start_lt: type: integer description: Start logical time start_utime: type: integer description: Start unix timestamp state: type: string description: Trace state (pending) pending_edges: type: integer description: Number of pending message edges edges: type: integer description: Total edges nodes: type: integer description: Total nodes address_book: type: object description: Address book mapping /getPendingTransactions: get: summary: Get Pending Transactions description: Get transactions that are pending finalization operationId: getPendingTransactions tags: - V3 parameters: - name: account in: query description: Filter by account address schema: type: string - name: limit in: query description: Maximum number of transactions to return schema: type: integer default: 10 - name: offset in: query description: Number of transactions to skip schema: type: integer default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: transactions: type: array items: type: object properties: account: type: string description: Account address hash: type: string description: Transaction hash lt: type: integer description: Logical time now: type: integer description: Unix timestamp mc_block_seqno: type: integer description: Masterchain block sequence number trace_id: type: string description: Associated trace ID address_book: type: object description: Address book mapping /getTopAccountsByBalance: get: summary: Get Top Accounts by Balance description: Get accounts with the highest TON balances operationId: getTopAccountsByBalance tags: - V3 parameters: - name: limit in: query description: Maximum number of accounts to return schema: type: integer default: 10 - name: offset in: query description: Number of accounts to skip schema: type: integer default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: accounts: type: array items: type: object properties: address: type: string description: Account address balance: type: string description: Balance in nanotons account_status: type: string description: Account status last_activity: type: integer description: Last activity timestamp address_book: type: object description: Address book mapping /getTraces: get: summary: Get Traces description: Retrieves transaction traces by specified filters operationId: getTraces tags: - V3 parameters: - name: trace_id in: query description: Trace ID to filter by schema: type: string - name: tx_hash in: query description: Transaction hash to get traces for schema: type: string default: BhLJTdV2R6Vr5c3BAOjH8nFpnMYOuPcJvRlagGSKU88= - name: tx_lt in: query description: Transaction logical time schema: type: integer - name: limit in: query description: Maximum number of traces to return schema: type: integer default: 10 - name: offset in: query description: Number of traces to skip schema: type: integer default: 0 - name: sort in: query description: Sort order schema: type: string enum: - asc - desc default: desc responses: '200': description: Successful response content: application/json: schema: type: object properties: traces: type: array items: type: object properties: trace_id: type: string description: Unique identifier for the trace external_hash: type: string description: Hash of the external message that initiated the trace mc_seqno_start: type: integer description: Masterchain sequence number at trace start mc_seqno_end: type: integer description: Masterchain sequence number at trace end start_lt: type: integer description: Logical time at trace start start_utime: type: integer description: Unix timestamp at trace start end_lt: type: integer description: Logical time at trace end end_utime: type: integer description: Unix timestamp at trace end state: type: string description: Current state of the trace pending_edges: type: integer description: Number of pending message edges edges: type: integer description: Total number of message edges nodes: type: integer description: Total number of transaction nodes classification_state: type: string description: Classification state of the trace address_book: type: object description: Address book mapping addresses to user-friendly names /getTransactionsByMasterchainBlock: get: summary: Get Transactions by Masterchain Block description: Retrieves a list of transactions for a specific masterchain block operationId: getTransactionsByMasterchainBlock tags: - V3 parameters: - name: seqno in: query description: The sequence number of the masterchain block required: true schema: type: integer default: 40467413 - name: limit in: query description: The maximum number of transactions to return required: false schema: type: integer default: 128 - name: offset in: query description: The number of transactions to skip before starting to return results required: false schema: type: integer default: 0 - name: sort in: query description: The sorting order of the transactions required: false schema: type: string enum: - asc - desc default: desc responses: '200': description: Successful response content: application/json: schema: type: object properties: transactions: type: array items: type: object properties: hash: type: string description: The transaction hash lt: type: string description: The logical time of the transaction account: type: string description: The account address involved in the transaction now: type: integer description: The timestamp of the transaction origStatus: type: string description: The original status of the account endStatus: type: string description: The end status of the account totalFees: type: string description: The total fees for the transaction /getTransactionsByMessage: get: summary: Get Transactions by Message description: Retrieves a list of transactions related to a specific message operationId: getTransactionsByMessage tags: - V3 parameters: - name: direction in: query description: The direction of the message (in or out) required: true schema: type: string enum: - in - out default: out - name: msg_hash in: query description: The hash of the message required: true schema: type: string default: po4/F9OgHrJGTUCtobScZrW/gOwVPj7s3f40HV32EII= - name: limit in: query description: The maximum number of transactions to return required: false schema: type: integer default: 128 - name: offset in: query description: The number of transactions to skip before starting to return results required: false schema: type: integer default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: transactions: type: array items: type: object properties: hash: type: string description: The transaction hash lt: type: string description: The logical time of the transaction account: type: string description: The account address involved in the transaction now: type: integer description: The timestamp of the transaction origStatus: type: string description: The original status of the account endStatus: type: string description: The end status of the account totalFees: type: string description: The total fees for the transaction /getWalletInfo: get: summary: Get Wallet Information description: Retrieves information about a specific wallet on the TON blockchain operationId: getWalletInfo tags: - V3 parameters: - name: address in: query description: The address of the wallet to retrieve information for required: true schema: type: string default: 0QAvTjjA5ZBbHN3a-SYnO1qvzlgNx09OC2bhYBPAbfs3S6q7 example: 0QAvTjjA5ZBbHN3a-SYnO1qvzlgNx09OC2bhYBPAbfs3S6q7 responses: '200': description: Successful response content: application/json: schema: type: object properties: wallet: type: boolean description: Indicates if the address is a wallet balance: type: string description: The balance of the wallet in nanotons account_state: type: string description: The state of the account (e.g., active, uninitialized) wallet_type: type: string description: The type of the wallet contract seqno: type: integer description: The current sequence number of the wallet last_transaction_lt: type: string description: The logical time of the last transaction last_transaction_hash: type: string description: The hash of the last transaction /getWalletStates: get: summary: Get Wallet States description: Query wallet states for addresses operationId: getWalletStates tags: - V3 parameters: - name: address in: query description: Wallet address to query required: true schema: type: string default: EQCxE6mUtQJKFnGfaROTKOt1lZbDiiX1kCixRv7Nw2Id_sDs - name: limit in: query description: Maximum number of results schema: type: integer default: 10 - name: offset in: query description: Number of results to skip schema: type: integer default: 0 responses: '200': description: Successful response content: application/json: schema: type: object properties: wallets: type: array items: type: object properties: address: type: string description: Wallet address is_wallet: type: boolean description: Whether address is a wallet contract balance: type: string description: Balance in nanotons status: type: string description: Account status code_hash: type: string description: Code cell hash last_transaction_hash: type: string description: Last transaction hash last_transaction_lt: type: string description: Last transaction logical time address_book: type: object description: Address book mapping /sendMessage: post: summary: Send Message description: Sends an external message to the TON network operationId: sendMessage tags: - V3 requestBody: required: true content: application/json: schema: type: object properties: boc: type: string description: The serialized bag-of-cells in base64 format default: te6ccgEBAgEAqwAB4YgBVbC7Hu+g3htYXzst8L5ucV76NMzeBK3URJKebN2Y1kwADRfFu/r0HxgrOp/Iml8Li5x4gR10J5XYFS8z0fMWJ6JPeUF5xNSLrSDGFIqhJqkW1SEYQF8Dw5p4dI3oaFs4LCmpoxdkfKw0AAAAGAAcAQBoQgAwwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAL68= required: - boc example: boc: te6ccgEBAgEAqwAB4YgBVbC7Hu+g3htYXzst8L5ucV76NMzeBK3URJKebN2Y1kwADRfFu/r0HxgrOp/Iml8Li5x4gR10J5XYFS8z0fMWJ6JPeUF5xNSLrSDGFIqhJqkW1SEYQF8Dw5p4dI3oaFs4LCmpoxdkfKw0AAAAGAAcAQBoQgAwwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAL68= responses: '200': description: Successful response content: application/json: schema: type: object properties: message_hash: type: string description: Hash of the sent message /vesting: get: security: - APIKeyHeader: [] - APIKeyQuery: [] description: Get vesting contracts by specified filters tags: - V3 summary: Get Vesting Contracts operationId: api_v3_get_vesting_contracts parameters: - name: contract_address in: query description: 'Vesting contract address in any form. Max: 1000.' style: form explode: true schema: type: array items: type: string - name: wallet_address in: query description: 'Wallet address to filter by owner or sender. Max: 1000.' style: form explode: true schema: type: array items: type: string - name: check_whitelist in: query description: Check if wallet address is in whitelist. schema: type: boolean default: false - name: limit in: query description: Limit number of queried rows. Use with *offset* to batch read. schema: type: integer format: int32 minimum: 1 maximum: 1000 default: 10 - name: offset in: query description: Skip first N rows. Use with *limit* to batch read. schema: type: integer format: int32 minimum: 0 default: 0 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VestingContractsResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/RequestError' components: schemas: Body_estimate_fee_estimateFee_post: properties: address: type: string title: Address description: Address in any format body: type: string title: Body description: b64-encoded cell with message body init_code: type: string title: Init Code description: b64-encoded cell with init-code default: '' init_data: type: string title: Init Data description: b64-encoded cell with init-data default: '' ignore_chksig: type: boolean title: Ignore Chksig description: If true during test query processing assume that all chksig operations return True default: true type: object required: - address - body title: Body_estimate_fee_estimateFee_post Body_run_get_method_runGetMethod_post: properties: address: type: string title: Address description: Contract address method: anyOf: - type: string - type: integer title: Method description: Method name or method id stack: items: items: {} type: array type: array title: Stack description: 'Array of stack elements: `[[''num'',3], [''cell'', cell_object], [''slice'', slice_object]]`' seqno: type: integer title: Seqno description: Seqno of masterchain block at which moment the Get Method is to be executed type: object required: - address - method - stack title: Body_run_get_method_runGetMethod_post Body_send_boc_return_hash_sendBocReturnHash_post: properties: boc: type: string title: Boc description: b64 encoded bag of cells type: object required: - boc title: Body_send_boc_return_hash_sendBocReturnHash_post Body_send_boc_sendBoc_post: properties: boc: type: string title: Boc description: b64 encoded bag of cells type: object required: - boc title: Body_send_boc_sendBoc_post Body_send_query_sendQuery_post: properties: address: type: string title: Address description: Address in any format body: type: string title: Body description: b64-encoded boc-serialized cell with message body init_code: type: string title: Init Code description: b64-encoded boc-serialized cell with init-code default: '' init_data: type: string title: Init Data description: b64-encoded boc-serialized cell with init-data default: '' type: object required: - address - body title: Body_send_query_sendQuery_post DeprecatedTonResponseJsonRPC: properties: ok: type: boolean title: Ok result: title: Result error: type: string title: Error code: type: integer title: Code id: type: string title: Id jsonrpc: type: string title: Jsonrpc default: '2.0' type: object required: - ok - id title: DeprecatedTonResponseJsonRPC TonRequestJsonRPC: properties: method: type: string title: Method params: type: object title: Params default: {} id: type: string title: Id jsonrpc: type: string title: Jsonrpc type: object required: - method title: TonRequestJsonRPC TonResponse: properties: ok: type: boolean title: Ok result: anyOf: - type: string - items: {} type: array - type: object title: Result error: type: string title: Error code: type: integer title: Code type: object required: - ok title: TonResponse AccountBalance: type: object properties: account: type: string balance: type: string AccountState: type: object properties: account_status: type: string balance: type: string code_boc: type: string code_hash: type: string data_boc: type: string data_hash: type: string extra_currencies: type: object additionalProperties: type: string frozen_hash: type: string hash: type: string AccountStateFull: type: object properties: account_state_hash: type: string address: type: string balance: type: string code_boc: type: string code_hash: type: string contract_methods: type: array items: type: integer data_boc: type: string data_hash: type: string extra_currencies: type: object additionalProperties: type: string frozen_hash: type: string interfaces: type: array items: type: string last_transaction_hash: type: string last_transaction_lt: type: string example: '0' status: type: string AccountStatesResponse: type: object properties: accounts: type: array items: $ref: '#/components/schemas/AccountStateFull' address_book: $ref: '#/components/schemas/AddressBook' metadata: $ref: '#/components/schemas/Metadata' Action: type: object properties: accounts: type: array items: type: string action_id: type: string details: {} end_lt: type: string example: '0' end_utime: type: integer start_lt: type: string example: '0' start_utime: type: integer success: type: boolean trace_end_lt: type: string example: '0' trace_end_utime: type: integer trace_external_hash: type: string trace_external_hash_norm: type: string trace_id: type: string trace_mc_seqno_end: type: integer transactions: type: array items: type: string transactions_full: type: array items: $ref: '#/components/schemas/Transaction' type: type: string ActionPhase: type: object properties: action_list_hash: type: string msgs_created: type: integer no_funds: type: boolean result_arg: type: integer result_code: type: integer skipped_actions: type: integer spec_actions: type: integer status_change: type: string success: type: boolean tot_actions: type: integer tot_msg_size: $ref: '#/components/schemas/MsgSize' total_action_fees: type: string example: '0' total_fwd_fees: type: string example: '0' valid: type: boolean ActionsResponse: type: object properties: actions: type: array items: $ref: '#/components/schemas/Action' address_book: $ref: '#/components/schemas/AddressBook' metadata: $ref: '#/components/schemas/Metadata' AddressBook: type: object additionalProperties: $ref: '#/components/schemas/AddressBookRow' AddressBookRow: type: object properties: domain: type: string interfaces: type: array items: type: string user_friendly: type: string AddressMetadata: type: object properties: is_indexed: type: boolean token_info: type: array items: $ref: '#/components/schemas/TokenInfo' Block: type: object properties: after_merge: type: boolean after_split: type: boolean before_split: type: boolean created_by: type: string end_lt: type: string example: '0' file_hash: type: string flags: type: integer gen_catchain_seqno: type: integer gen_utime: type: string example: '0' global_id: type: integer key_block: type: boolean master_ref_seqno: type: integer masterchain_block_ref: $ref: '#/components/schemas/BlockId' min_ref_mc_seqno: type: integer prev_blocks: type: array items: $ref: '#/components/schemas/BlockId' prev_key_block_seqno: type: integer rand_seed: type: string root_hash: type: string seqno: type: integer shard: type: string example: '0' start_lt: type: string example: '0' tx_count: type: integer validator_list_hash_short: type: integer version: type: integer vert_seqno: type: integer vert_seqno_incr: type: boolean want_merge: type: boolean want_split: type: boolean workchain: type: integer BlockId: type: object properties: seqno: type: integer shard: type: string example: '0' workchain: type: integer BlocksResponse: type: object properties: blocks: type: array items: $ref: '#/components/schemas/Block' BouncePhase: type: object properties: fwd_fees: type: string example: '0' msg_fees: type: string example: '0' msg_size: $ref: '#/components/schemas/MsgSize' req_fwd_fees: type: string example: '0' type: type: string ComputePhase: type: object properties: account_activated: type: boolean exit_arg: type: integer exit_code: type: integer gas_credit: type: string example: '0' gas_fees: type: string example: '0' gas_limit: type: string example: '0' gas_used: type: string example: '0' mode: type: integer msg_state_used: type: boolean reason: type: string skipped: type: boolean success: type: boolean vm_final_state_hash: type: string vm_init_state_hash: type: string vm_steps: type: integer CreditPhase: type: object properties: credit: type: string example: '0' credit_extra_currencies: type: object additionalProperties: type: string due_fees_collected: type: string example: '0' DNSRecord: type: object properties: dns_next_resolver: type: string dns_site_adnl: type: string dns_storage_bag_id: type: string dns_wallet: type: string domain: type: string nft_item_address: type: string nft_item_owner: type: string DNSRecordsResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' records: type: array items: $ref: '#/components/schemas/DNSRecord' DecodeRequest: type: object properties: bodies: type: array items: type: string opcodes: type: array items: type: string DecodeResponse: type: object properties: bodies: type: array items: type: object additionalProperties: true opcodes: type: array items: type: string JettonBurn: type: object properties: amount: type: string custom_payload: type: string decoded_custom_payload: type: array items: type: integer jetton_master: type: string jetton_wallet: type: string owner: type: string query_id: type: string response_destination: type: string trace_id: type: string transaction_aborted: type: boolean transaction_hash: type: string transaction_lt: type: string example: '0' transaction_now: type: integer JettonBurnsResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' jetton_burns: type: array items: $ref: '#/components/schemas/JettonBurn' metadata: $ref: '#/components/schemas/Metadata' JettonMaster: type: object properties: address: type: string admin_address: type: string code_hash: type: string data_hash: type: string jetton_content: type: object additionalProperties: true jetton_wallet_code_hash: type: string last_transaction_lt: type: string example: '0' mintable: type: boolean total_supply: type: string JettonMastersResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' jetton_masters: type: array items: $ref: '#/components/schemas/JettonMaster' metadata: $ref: '#/components/schemas/Metadata' JettonTransfer: type: object properties: amount: type: string custom_payload: type: string decoded_custom_payload: type: array items: type: integer decoded_forward_payload: type: array items: type: integer destination: type: string forward_payload: type: string forward_ton_amount: type: string jetton_master: type: string query_id: type: string response_destination: type: string source: type: string source_wallet: type: string trace_id: type: string transaction_aborted: type: boolean transaction_hash: type: string transaction_lt: type: string example: '0' transaction_now: type: integer JettonTransfersResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' jetton_transfers: type: array items: $ref: '#/components/schemas/JettonTransfer' metadata: $ref: '#/components/schemas/Metadata' JettonWallet: type: object properties: address: type: string balance: type: string code_hash: type: string data_hash: type: string jetton: type: string last_transaction_lt: type: string example: '0' mintless_info: $ref: '#/components/schemas/JettonWalletMintlessInfo' owner: type: string JettonWalletMintlessInfo: type: object properties: amount: type: string custom_payload_api_uri: type: array items: type: string expire_at: type: integer start_from: type: integer JettonWalletsResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' jetton_wallets: type: array items: $ref: '#/components/schemas/JettonWallet' metadata: $ref: '#/components/schemas/Metadata' MasterchainInfo: type: object properties: first: $ref: '#/components/schemas/Block' last: $ref: '#/components/schemas/Block' Message: type: object properties: bounce: type: boolean bounced: type: boolean created_at: type: string example: '0' created_lt: type: string example: '0' decoded_opcode: type: string destination: type: string extra_flags: type: string fwd_fee: type: string example: '0' hash: type: string hash_norm: type: string ihr_disabled: type: boolean ihr_fee: type: string example: '0' import_fee: type: string example: '0' in_msg_tx_hash: type: string init_state: $ref: '#/components/schemas/MessageContent' message_content: $ref: '#/components/schemas/MessageContent' opcode: type: integer out_msg_tx_hash: type: string source: type: string value: type: string example: '0' value_extra_currencies: type: object additionalProperties: type: string MessageContent: type: object properties: body: type: string decoded: type: object hash: type: string MessagesResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' messages: type: array items: $ref: '#/components/schemas/Message' metadata: $ref: '#/components/schemas/Metadata' Metadata: type: object additionalProperties: $ref: '#/components/schemas/AddressMetadata' MsgSize: type: object properties: bits: type: string example: '0' cells: type: string example: '0' Multisig: type: object properties: address: type: string code_hash: type: string data_hash: type: string last_transaction_lt: type: string example: '0' next_order_seqno: type: string orders: type: array items: $ref: '#/components/schemas/MultisigOrder' proposers: type: array items: type: string signers: type: array items: type: string threshold: type: integer MultisigOrder: type: object properties: actions: type: array items: $ref: '#/components/schemas/index.OrderAction' address: type: string approvals_mask: type: string approvals_num: type: integer code_hash: type: string data_hash: type: string expiration_date: type: integer last_transaction_lt: type: string example: '0' multisig_address: type: string order_boc: type: string order_seqno: type: string sent_for_execution: type: boolean signers: type: array items: type: string threshold: type: integer MultisigOrderResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' orders: type: array items: $ref: '#/components/schemas/MultisigOrder' MultisigResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' multisigs: type: array items: $ref: '#/components/schemas/Multisig' NFTCollection: type: object properties: address: type: string code_hash: type: string collection_content: type: object additionalProperties: true data_hash: type: string last_transaction_lt: type: string example: '0' next_item_index: type: string owner_address: type: string NFTCollectionsResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' metadata: $ref: '#/components/schemas/Metadata' nft_collections: type: array items: $ref: '#/components/schemas/NFTCollection' NFTItem: type: object properties: address: type: string auction_contract_address: type: string code_hash: type: string collection: $ref: '#/components/schemas/NFTCollection' collection_address: type: string content: type: object additionalProperties: true data_hash: type: string index: type: string init: type: boolean last_transaction_lt: type: string example: '0' on_sale: type: boolean owner_address: type: string real_owner: type: string sale_contract_address: type: string NFTItemsResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' metadata: $ref: '#/components/schemas/Metadata' nft_items: type: array items: $ref: '#/components/schemas/NFTItem' NFTTransfer: type: object properties: custom_payload: type: string decoded_custom_payload: type: array items: type: integer decoded_forward_payload: type: array items: type: integer forward_amount: type: string forward_payload: type: string new_owner: type: string nft_address: type: string nft_collection: type: string old_owner: type: string query_id: type: string response_destination: type: string trace_id: type: string transaction_aborted: type: boolean transaction_hash: type: string transaction_lt: type: string example: '0' transaction_now: type: integer NFTTransfersResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' metadata: $ref: '#/components/schemas/Metadata' nft_transfers: type: array items: $ref: '#/components/schemas/NFTTransfer' RequestError: type: object properties: code: type: integer error: type: string SplitInfo: type: object properties: acc_split_depth: type: integer cur_shard_pfx_len: type: integer sibling_addr: type: string this_addr: type: string StoragePhase: type: object properties: status_change: type: string storage_fees_collected: type: string example: '0' storage_fees_due: type: string example: '0' TokenInfo: type: object properties: description: type: string extra: type: object additionalProperties: true image: type: string name: type: string nft_index: type: string symbol: type: string type: type: string valid: type: boolean Trace: type: object properties: actions: type: array items: $ref: '#/components/schemas/Action' end_lt: type: string example: '0' end_utime: type: integer external_hash: type: string is_incomplete: type: boolean mc_seqno_end: type: string mc_seqno_start: type: string start_lt: type: string example: '0' start_utime: type: integer trace: $ref: '#/components/schemas/TraceNode' trace_id: type: string trace_info: $ref: '#/components/schemas/TraceMeta' transactions: type: object additionalProperties: $ref: '#/components/schemas/Transaction' transactions_order: type: array items: type: string warning: type: string TraceMeta: type: object properties: classification_state: type: string messages: type: integer pending_messages: type: integer trace_state: type: string transactions: type: integer TraceNode: type: object properties: children: type: array items: $ref: '#/components/schemas/TraceNode' in_msg: $ref: '#/components/schemas/Message' in_msg_hash: type: string transaction: $ref: '#/components/schemas/Transaction' tx_hash: type: string TracesResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' metadata: $ref: '#/components/schemas/Metadata' traces: type: array items: $ref: '#/components/schemas/Trace' Transaction: type: object properties: account: type: string account_state_after: $ref: '#/components/schemas/AccountState' account_state_before: $ref: '#/components/schemas/AccountState' block_ref: $ref: '#/components/schemas/BlockId' description: $ref: '#/components/schemas/TransactionDescr' emulated: type: boolean end_status: type: string hash: type: string in_msg: $ref: '#/components/schemas/Message' lt: type: string example: '0' mc_block_seqno: type: integer now: type: integer orig_status: type: string out_msgs: type: array items: $ref: '#/components/schemas/Message' prev_trans_hash: type: string prev_trans_lt: type: string example: '0' total_fees: type: string example: '0' total_fees_extra_currencies: type: object additionalProperties: type: string trace_external_hash: type: string trace_id: type: string TransactionDescr: type: object properties: aborted: type: boolean action: $ref: '#/components/schemas/ActionPhase' bounce: $ref: '#/components/schemas/BouncePhase' compute_ph: $ref: '#/components/schemas/ComputePhase' credit_first: type: boolean credit_ph: $ref: '#/components/schemas/CreditPhase' destroyed: type: boolean installed: type: boolean is_tock: type: boolean split_info: $ref: '#/components/schemas/SplitInfo' storage_ph: $ref: '#/components/schemas/StoragePhase' type: type: string TransactionsResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' transactions: type: array items: $ref: '#/components/schemas/Transaction' V2AddressInformation: type: object properties: balance: type: string code: type: string data: type: string frozen_hash: type: string last_transaction_hash: type: string last_transaction_lt: type: string status: type: string V2EstimateFeeRequest: type: object properties: address: type: string body: type: string ignore_chksig: type: boolean init_code: type: string init_data: type: string V2EstimateFeeResult: type: object properties: destination_fees: type: array items: $ref: '#/components/schemas/V2EstimatedFee' source_fees: $ref: '#/components/schemas/V2EstimatedFee' V2EstimatedFee: type: object properties: fwd_fee: type: integer gas_fee: type: integer in_fwd_fee: type: integer storage_fee: type: integer V2RunGetMethodRequest: type: object properties: address: type: string method: type: string stack: type: array items: $ref: '#/components/schemas/V2StackEntity' V2SendMessageRequest: type: object properties: boc: type: string V2SendMessageResult: type: object properties: message_hash: type: string message_hash_norm: type: string V2StackEntity: type: object properties: type: type: string value: {} V2WalletInformation: type: object properties: balance: type: string last_transaction_hash: type: string last_transaction_lt: type: string seqno: type: integer status: type: string wallet_id: type: integer wallet_type: type: string VestingContractsResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' vesting_contracts: type: array items: $ref: '#/components/schemas/index.VestingInfo' WalletState: type: object properties: address: type: string balance: type: string code_hash: type: string extra_currencies: type: object additionalProperties: type: string is_signature_allowed: type: boolean is_wallet: type: boolean last_transaction_hash: type: string last_transaction_lt: type: string example: '0' seqno: type: integer status: type: string wallet_id: type: integer wallet_type: type: string WalletStatesResponse: type: object properties: address_book: $ref: '#/components/schemas/AddressBook' metadata: $ref: '#/components/schemas/Metadata' wallets: type: array items: $ref: '#/components/schemas/WalletState' index.OrderAction: type: object properties: body_raw: type: array items: type: integer destination: type: string error: type: string parsed: type: boolean parsed_body: {} parsed_body_type: type: string send_mode: type: integer value: type: string index.VestingInfo: type: object properties: address: type: string cliff_duration: type: integer owner_address: type: string sender_address: type: string start_time: type: integer total_amount: type: string total_duration: type: integer unlock_period: type: integer whitelist: type: array items: type: string securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-Key APIKeyQuery: type: apiKey in: query name: api_key