TON Index GO

Package docs Code generated by swaggo/swag.

@summary Get Account States @description Query account states @id api_v3_get_account_states @tags accounts @Accept json @Produce json @success 200 {object} index.AccountStatesResponse @failure 400 {object} index.RequestError @param address query []string true "List of addresses in any form to get address book.

@summary Get Actions @description Get actions by specified filter.

@summary Address Book @description Query address book @id api_v3_get_address_book @tags accounts @Accept json @Produce json @success 200 {object} index.AddressBook @failure 400 {object} index.RequestError @param address query []string true "List of addresses in any form to get address book.

@summary Get Adjacent Transactions @description Get parent and/or children for specified transaction.

@summary Get blocks @description Returns blocks by specified filters.

@summary Get Events @description Get events by specified filter.

@summary Get Jetton Burns @description Get Jetton burns by specified filters @id api_v3_get_jetton_burns @tags jettons @Accept json @Produce json @success 200 {object} index.JettonBurnsResponse @failure 400 {object} index.RequestError @param address query []string false "Address of jetton wallet owner in any form.

@summary Get Jetton Masters @description Get Jetton masters by specified filters @id api_v3_get_jetton_masters @tags jettons @Accept json @Produce json @success 200 {object} index.JettonMastersResponse @failure 400 {object} index.RequestError @param address query []string false "Jetton Master address in any form.

@summary Get Jetton Transfers @description Get Jetton transfers by specified filters @id api_v3_get_jetton_transfers @tags jettons @Accept json @Produce json @success 200 {object} index.JettonTransfersResponse @failure 400 {object} index.RequestError @param owner_address query []string false "Address of jetton wallet owner in any form.

@summary Get Jetton Wallets @description Get Jetton wallets by specified filters @id api_v3_get_jetton_wallets @tags jettons @Accept json @Produce json @success 200 {object} index.JettonWalletsResponse @failure 400 {object} index.RequestError @param address query []string false "Jetton wallet address in any form.

@summary Get Masterchain Info @description Get first and last indexed block @id api_v3_get_masterchain_info @tags blockchain @Accept json @Produce json @success 200 {object} index.MasterchainInfo @failure 400 {object} index.RequestError @router /api/v3/masterchainInfo [get] @security APIKeyHeader @security APIKeyQuery.

@summary Get messages @description Get messages by specified filters.

@summary Get NFT collections @description Get NFT collections by specified filters @id api_v3_get_nft_collections @tags nfts @Accept json @Produce json @success 200 {object} index.NFTCollectionsResponse @failure 400 {object} index.RequestError @param collection_address query []string false "Collection address in any form.

@summary Get NFT items @description Get NFT items by specified filters @id api_v3_get_nft_items @tags nfts @Accept json @Produce json @success 200 {object} index.NFTItemsResponse @failure 400 {object} index.RequestError @param address query []string false "NFT item address in any form.

@summary Get NFT Transfers @description Get transfers of NFT items by specified filters @id api_v3_get_nft_transfers @tags nfts @Accept json @Produce json @success 200 {object} index.NFTTransfersResponse @failure 400 {object} index.RequestError @param owner_address query []string false "Address of NFT owner in any form.

@summary Get masterchain block shard state @description Get masterchain block shard state.

@summary Get masterchain block shard state @description Returns all worchain blocks, that appeared after previous masterchain block.

// @summary Test method // // @description Test method // // @id api_v3_get_test_method // @tags _debug // @Accept json // @Produce json // @success 200 {object} index.MessagesResponse // @failure 400 {object} index.RequestError // @param my_hash query []string false "Hash" collectionFormat(multi) // @param my_addr query []string false "Address" collectionFormat(multi) // @param my_shard query []string false "ShardId" collectionFormat(multi) // @router /api/v3/__testMethod [get] // @security APIKeyHeader // @security APIKeyQuery.

@summary Get Top Accounts By Balance @description Get list of accounts sorted descending by balance.

@summary Get transactions @description Get transactions by specified filter.

@summary Get transactions by Masterchain block @description Returns transactions from masterchain block and from all shards.

@summary Get transactions by message @description Get transactions whose inbound/outbound message has the specified hash.

@summary Get Address Information @description Get smart contract information.

@summary Get Wallet Information @description Get wallet smart contract information.

@summary Get Wallet States @description Query wallet information @id api_v3_get_wallet_states @tags accounts @Accept json @Produce json @success 200 {object} index.WalletStatesResponse @failure 400 {object} index.RequestError @param address query []string true "List of addresses in any form to get address book.

@summary Estimate Fee @description Estimate fees required for query processing.

@summary Run Get-Method @description Run get method of smart contract.

@summary Send Message @description Send an external message to the TON network.