xyz.groundx.caver_ext_kas.kas.tokenhistory

Class TokenHistory

java.lang.Object

xyz.groundx.caver_ext_kas.kas.tokenhistory.TokenHistory

public class TokenHistory
extends java.lang.Object

Representing an wrapping class tha connects Token history APi.

Constructor Summary

Constructors

Constructor and Description
TokenHistory(java.lang.String chainId, ApiClient client) Creates an TokenHistoryAPI instance.

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient() Getter function for ApiClient
java.lang.String	getChainId() Getter function for chain id
FtContractDetail	getFTContract(java.lang.String ftAddress) Retrieves the information of the FT contract labeled with the address of the FT contract. GET /v2/contract/ft/{ft-address}
com.squareup.okhttp.Call	getFTContractAsync(java.lang.String ftAddress, ApiCallback<FtContractDetail> callback) Retrieves the information of the FT contract labeled with the address of the FT contract asynchronously. GET /v2/contract/ft/{ft-address}
PageableFtContractDetails	getFTContractList() Retrieve information of all labeled FT contracts. It will send a request without filter options. GET /v2/contract/ft
PageableFtContractDetails	getFTContractList(TokenHistoryQueryOptions options) Retrieve information of all labeled FT contracts. GET /v2/contract/ft
com.squareup.okhttp.Call	getFTContractListAsync(ApiCallback<PageableFtContractDetails> callback) Retrieve information of all labeled FT contracts asynchronously. It will send a request without filter options. GET /v2/contract/ft
com.squareup.okhttp.Call	getFTContractListAsync(TokenHistoryQueryOptions options, ApiCallback<PageableFtContractDetails> callback) Retrieve information of all labeled FT contracts asynchronously. GET /v2/contract/ft
MtToken	getMT(java.lang.String mtAddress, java.lang.String ownerAddress, java.lang.String tokenID) Retrieve a specific MT(Multiple Token) corresponding to the given address and tokenID. GET /v2/contract/mt/{mt-address}/owner/{owner-address}/token/{token-id}
com.squareup.okhttp.Call	getMTAsync(java.lang.String mtAddress, java.lang.String ownerAddress, java.lang.String tokenID, ApiCallback<MtToken> callback) Retrieve a specific MT(Multiple Token) corresponding to the given address and tokenID asynchronously. GET /v2/contract/mt/{mt-address}/owner/{owner-address}/token/{token-id}
MtContractDetail	getMTContract(java.lang.String mtAddress) Retrieves the information of the FT contract labeled with the address of the MT(Multiple Token) contract. GET /v2/contract/mt/{mt-address}
com.squareup.okhttp.Call	getMTContractAsync(java.lang.String mtAddress, ApiCallback<MtContractDetail> callback) Retrieves the information of the FT contract labeled with the address of the MT(Multiple Token) contract asynchronously. GET /v2/contract/mt/{mt-address}
PageableMtContractDetails	getMTContractList() Retrieve information of all labeled MT(Multiple Token) contracts. It will send a request without filter options. If you want to execute this function with search options(status, type, size, cursor), use getMTContractList(TokenHistoryQueryOptions). GET /v2/contract/mt
PageableMtContractDetails	getMTContractList(TokenHistoryQueryOptions options) Retrieve information of all labeled MT(Multiple Token) contracts. You can set a search options(status, type, size, cursor) by using TokenHistoryQueryOptions. GET /v2/contract/mt
com.squareup.okhttp.Call	getMTContractListAsync(ApiCallback<PageableMtContractDetails> callback) Retrieve information of all labeled MT(Multiple Token) contracts asynchronously. It will send a request without filter options. If you want to execute this function with search options(status, type, size, cursor), use getMTContractList(TokenHistoryQueryOptions). GET /v2/contract/mt
com.squareup.okhttp.Call	getMTContractListAsync(TokenHistoryQueryOptions options, ApiCallback<PageableMtContractDetails> callback) Retrieve information of all labeled MT(Multiple Token) contracts asynchronously. You can set a search options(status, type, size, cursor) by using TokenHistoryQueryOptions. GET /v2/contract/mt
PageableMtTokensWithBalance	getMTListByOwner(java.lang.String mtAddress, java.lang.String ownerAddress) Retrieve MTs(Multiple Token) that are owned by the passed as ownerAddress. It will send a request without filter options. If you want to execute this function with search options(size, cursor), use getMTListByOwner(String, TokenHistoryQueryOptions). GET /v2/contract/mt/{mt-address}/owner/{owner-address}
PageableMtTokensWithBalance	getMTListByOwner(java.lang.String mtAddress, java.lang.String ownerAddress, TokenHistoryQueryOptions options) Retrieve MTs(Multiple Token) that are owned by the passed as ownerAddress. You can set a search options(size, cursor) by using TokenHistoryQueryOptions. GET /v2/contract/mt/{mt-address}/owner/{owner-address}
com.squareup.okhttp.Call	getMTListByOwnerAsync(java.lang.String mtAddress, java.lang.String ownerAddress, ApiCallback<PageableMtTokensWithBalance> callback) Retrieve MTs(Multiple Token) that are owned by the passed as ownerAddress asynchronously. It will send a request without filter options. If you want to execute this function with search options(size, cursor), use getMTListByOwnerAsync(String, TokenHistoryQueryOptions). GET /v2/contract/mt/{mt-address}/owner/{owner-address}
com.squareup.okhttp.Call	getMTListByOwnerAsync(java.lang.String mtAddress, java.lang.String ownerAddress, TokenHistoryQueryOptions options, ApiCallback<PageableMtTokensWithBalance> callback) Retrieve MTs(Multiple Token) that are owned by the passed as ownerAddress asynchronously. You can set a search options(size, cursor) by using TokenHistoryQueryOptions. GET /v2/contract/mt/{mt-address}/owner/{owner-address}
PageableMtTokens	getMTOwnerListByTokenId(java.lang.String mtAddress, java.lang.String tokenId) Retrieve a specific MT(Multiple Token) owner corresponding to the given tokenID. It will send a request without filter options. If you want to execute this function with search options(size, cursor), use getMTOwnerByTokenId(String, TokenHistoryQueryOptions). GET /v2/contract/mt/{mt-address}/token/{token-id}
PageableMtTokens	getMTOwnerListByTokenId(java.lang.String mtAddress, java.lang.String tokenId, TokenHistoryQueryOptions options) Retrieve a specific MT(Multiple Token) owner corresponding to the given tokenID. You can set a search options(size, cursor) by using TokenHistoryQueryOptions. GET /v2/contract/mt/{mt-address}/token/{token-id}
com.squareup.okhttp.Call	getMTOwnerListByTokenIdAsync(java.lang.String mtAddress, java.lang.String tokenId, ApiCallback<PageableMtTokens> callback) Retrieve a specific MT(Multiple Token) owner corresponding to the given tokenID asynchronously. It will send a request without filter options. If you want to execute this function with search options(size, cursor), use getMTOwnerByTokenId(String, TokenHistoryQueryOptions). GET /v2/contract/mt/{mt-address}/token/{token-id}
com.squareup.okhttp.Call	getMTOwnerListByTokenIdAsync(java.lang.String mtAddress, java.lang.String tokenId, TokenHistoryQueryOptions options, ApiCallback<PageableMtTokens> callback) Retrieve a specific MT(Multiple Token) owner corresponding to the given tokenID asynchronously. You can set a search options(size, cursor) by using TokenHistoryQueryOptions. GET /v2/contract/mt/{mt-address}/token/{token-id}
Nft	getNFT(java.lang.String nftAddress, java.lang.String tokenId) Retrieve information of a specific NFT. GET /v2/contract/nft/{nft-address}/token/{token-id}
com.squareup.okhttp.Call	getNFTAsync(java.lang.String nftAddress, java.lang.String tokenId, ApiCallback<Nft> callback) Retrieve information of a specific NFT asynchronously. GET /v2/contract/nft/{nft-address}/token/{token-id}
NftContractDetail	getNFTContract(java.lang.String nftAddress) Retrieves the information of the NFT contract labeled with the address of the NFT contract. GET /v2/contract/nft/{nftAddress}
com.squareup.okhttp.Call	getNFTContractAsync(java.lang.String nftAddress, ApiCallback<NftContractDetail> callback) Retrieves the information of the NFT contract labeled with the address of the NFT contract asynchronously. GET /v2/contract/nft/{nftAddress}
PageableNftContractDetails	getNFTContractList() Retrieve information of all labeled NFT contracts. It will send a request without filter options. GET /v2/contract/nft
PageableNftContractDetails	getNFTContractList(TokenHistoryQueryOptions options) Retrieve information of all labeled NFT contracts. GET /v2/contract/nft
com.squareup.okhttp.Call	getNFTContractListAsync(ApiCallback<PageableNftContractDetails> callback) Retrieve information of all labeled NFT contracts asynchronously. It will send a request without filter options. GET /v2/contract/nft
com.squareup.okhttp.Call	getNFTContractListAsync(TokenHistoryQueryOptions options, ApiCallback<PageableNftContractDetails> callback) Retrieve information of all labeled NFT contracts asynchronously. GET /v2/contract/nft
PageableNfts	getNFTList(java.lang.String nftAddress) Retrieves information of all NFTs issued by a specific NFT contract. It will send a request without filter options. GET /v2/contract/nft/{nft-address}/token
PageableNfts	getNFTList(java.lang.String nftAddress, TokenHistoryQueryOptions options) Retrieves information of all NFTs issued by a specific NFT contract.
com.squareup.okhttp.Call	getNFTListAsync(java.lang.String nftAddress, ApiCallback<PageableNfts> callback) Retrieves information of all NFTs issued by a specific NFT contract asynchronously. It will send a request without filter options. GET /v2/contract/nft/{nft-address}/token
com.squareup.okhttp.Call	getNFTListAsync(java.lang.String nftAddress, TokenHistoryQueryOptions options, ApiCallback<PageableNfts> callback) Retrieves information of all NFTs issued by a specific NFT contract asynchronously. GET /v2/contract/nft/{nft-address}/token
PageableNfts	getNFTListByOwner(java.lang.String nftAddress, java.lang.String ownerAddress) Among the NFTs issued from the NFT contract address, the information of the NFT owned by the EOA address received as a parameter is retrieved. It will send a request without filter options. GET /v2/contract/nft/{nft-address}/owner/{owner-address}
PageableNfts	getNFTListByOwner(java.lang.String nftAddress, java.lang.String ownerAddress, TokenHistoryQueryOptions options) Among the NFTs issued from the NFT contract address, the information of the NFT owned by the EOA address received as a parameter is retrieved. GET /v2/contract/nft/{nft-address}/owner/{owner-address}
com.squareup.okhttp.Call	getNFTListByOwnerAsync(java.lang.String nftAddress, java.lang.String ownerAddress, ApiCallback<PageableNfts> callback) Among the NFTs issued from the NFT contract address. the information of the NFT owned by the EOA address received as a parameter is retrieved asynchronously. It will send a request without filter options. GET /v2/contract/nft/{nft-address}/owner/{owner-address}
com.squareup.okhttp.Call	getNFTListByOwnerAsync(java.lang.String nftAddress, java.lang.String ownerAddress, TokenHistoryQueryOptions options, ApiCallback<PageableNfts> callback) Among the NFTs issued from the NFT contract address, the information of the NFT owned by the EOA address received as a parameter is retrieved asynchronously. GET /v2/contract/nft/{nft-address}/owner/{owner-address}
PageableNftOwnershipChanges	getNFTOwnershipHistory(java.lang.String nftAddress, java.lang.String tokenId) Retrieve the record of ownership changes for a specific NFT. It will send a request without filter options. GET /v2/contract/nft/{nft-address}/token/{token-id}/history
PageableNftOwnershipChanges	getNFTOwnershipHistory(java.lang.String nftAddress, java.lang.String tokenId, TokenHistoryQueryOptions options) Retrieve the record of ownership changes for a specific NFT. GET /v2/contract/nft/{nft-address}/token/{token-id}/history
com.squareup.okhttp.Call	getNFTOwnershipHistoryAsync(java.lang.String nftAddress, java.lang.String tokenId, ApiCallback<PageableNftOwnershipChanges> callback) Retrieve the record of ownership changes for a specific NFT asynchronously. It will send a request without filter options. GET /v2/contract/nft/{nft-address}/token/{token-id}/history
com.squareup.okhttp.Call	getNFTOwnershipHistoryAsync(java.lang.String nftAddress, java.lang.String tokenId, TokenHistoryQueryOptions options, ApiCallback<PageableNftOwnershipChanges> callback) Retrieve the record of ownership changes for a specific NFT asynchronously. GET /v2/contract/nft/{nft-address}/token/{token-id}/history
TokenApi	getTokenApi() Getter function for tokenApi
TokenContractApi	getTokenContractApi() Getter function TokenContractApi
TokenHistoryApi	getTokenHistoryApi() Getter function for TokenHistoryApi
TokenOwnershipApi	getTokenOwnershipApi() Getter function for TokenOwnershipApi
PageableTransfers	getTransferHistory(int preset) Gets transfer history list. It will send a request without filter options. GET /v2/transfer
PageableTransfers	getTransferHistory(int preset, TokenHistoryQueryOptions options) Gets transfer history list. GET /v2/transfer
PageableTransfers	getTransferHistory(java.util.List<java.lang.Integer> presets) Gets transfer history list. It will send a request without filter options. GET /v2/transfer
PageableTransfers	getTransferHistory(java.util.List<java.lang.Integer> presets, TokenHistoryQueryOptions options) Gets transfer history list. GET /v2/transfer
com.squareup.okhttp.Call	getTransferHistoryAccountAsync(java.lang.String address, ApiCallback<PageableTransfers> callback) Gets token history list with a specific EOA asynchronously. It will send a request without filter options. GET /v2/transfer/account/{address}
com.squareup.okhttp.Call	getTransferHistoryAccountAsync(java.lang.String address, TokenHistoryQueryOptions options, ApiCallback<PageableTransfers> callback) Gets token history list with a specific EOA asynchronously. GET /v2/transfer/account/{address}
com.squareup.okhttp.Call	getTransferHistoryAsync(int preset, ApiCallback<PageableTransfers> callback) Gets transfer history list asynchronously. It will send a request without filter options. GET /v2/transfer
com.squareup.okhttp.Call	getTransferHistoryAsync(int preset, TokenHistoryQueryOptions options, ApiCallback<PageableTransfers> callback) Gets transfer history list asynchronously. GET /v2/transfer
com.squareup.okhttp.Call	getTransferHistoryAsync(java.util.List<java.lang.Integer> presets, ApiCallback<PageableTransfers> callback) Gets transfer history list asynchronously. It will send a request without filter options. GET /v2/transfer
com.squareup.okhttp.Call	getTransferHistoryAsync(java.util.List<java.lang.Integer> presets, TokenHistoryQueryOptions options, ApiCallback<PageableTransfers> callback) Gets transfer history list asynchronously. GET /v2/transfer
PageableTransfers	getTransferHistoryByAccount(java.lang.String address) Gets token history list with a specific EOA. It will send a request without filter options. GET /v2/transfer/account/{address}
PageableTransfers	getTransferHistoryByAccount(java.lang.String address, TokenHistoryQueryOptions options) Gets token history list with a specific EOA. GET /v2/transfer/account/{address}
Transfers	getTransferHistoryByTxHash(java.lang.String txHash) Gets token history list with a specific transaction hash. GET /v2/transfer/tx/{transaction-hash}
com.squareup.okhttp.Call	getTransferHistoryByTxHashAsync(java.lang.String txHash, ApiCallback<Transfers> callback) Gets token history list with a specific transaction hash asynchronously. GET /v2/transfer/tx/{transaction-hash}
void	setApiClient(ApiClient apiClient) Setter function for apiClient
void	setChainId(java.lang.String chainId) Setter function for chain id
void	setTokenApi(TokenApi tokenApi) Setter function for TokenApi
void	setTokenContractApi(TokenContractApi tokenContractApi) Setter function for TokenContractApi
void	setTokenHistoryApi(TokenHistoryApi tokenHistoryApi) Setter function for TokenHistoryApi
void	setTokenOwnershipApi(TokenOwnershipApi tokenOwnershipApi) Setter function for TokenOwnershipApi

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TokenHistory

public TokenHistory(java.lang.String chainId,
                    ApiClient client)

Creates an TokenHistoryAPI instance.

Parameters:

chainId - A Klaytn network chain id.

client - The Api client for connection with KAS.

Method Detail

getTransferHistory

public PageableTransfers getTransferHistory(int preset)
                                     throws ApiException

Gets transfer history list.
It will send a request without filter options.
GET /v2/transfer

Parameters:

preset - Preset ID to be used for search. Preset ID can be checked in KAS console.

Returns:

PageableTransfers

Throws:

ApiException

getTransferHistory

public PageableTransfers getTransferHistory(java.util.List<java.lang.Integer> presets)
                                     throws ApiException

Gets transfer history list.
It will send a request without filter options.
GET /v2/transfer

Parameters:

presets - Preset IDs to be used for search. Preset ID can be checked in KAS console.

Returns:

PageableTransfers

Throws:

ApiException

getTransferHistory

public PageableTransfers getTransferHistory(int preset,
                                            TokenHistoryQueryOptions options)
                                     throws ApiException

Gets transfer history list.
GET /v2/transfer

Parameters:

preset - Preset ID to be used for search. Preset ID can be checked in KAS console.

options - Filters required when retrieving data. `kind`, `range`, `size`, and `cursor`.

Returns:

PageableTransfers

Throws:

ApiException

getTransferHistory

public PageableTransfers getTransferHistory(java.util.List<java.lang.Integer> presets,
                                            TokenHistoryQueryOptions options)
                                     throws ApiException

Gets transfer history list.
GET /v2/transfer

Parameters:

presets - Preset IDs to be used for search. Preset ID can be checked in KAS console.

options - Filters required when retrieving data. `kind`, `range`, `size`, and `cursor`.

Returns:

PageableTransfers

Throws:

ApiException

getTransferHistoryAsync

public com.squareup.okhttp.Call getTransferHistoryAsync(int preset,
                                                        ApiCallback<PageableTransfers> callback)
                                                 throws ApiException

Gets transfer history list asynchronously.
It will send a request without filter options.
GET /v2/transfer

Parameters:

preset - Preset ID to be used for search. Preset ID can be checked in KAS console.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getTransferHistoryAsync

public com.squareup.okhttp.Call getTransferHistoryAsync(java.util.List<java.lang.Integer> presets,
                                                        ApiCallback<PageableTransfers> callback)
                                                 throws ApiException

Gets transfer history list asynchronously.
It will send a request without filter options.
GET /v2/transfer

Parameters:

presets - Preset IDs to be used for search. Preset ID can be checked in KAS console.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getTransferHistoryAsync

public com.squareup.okhttp.Call getTransferHistoryAsync(int preset,
                                                        TokenHistoryQueryOptions options,
                                                        ApiCallback<PageableTransfers> callback)
                                                 throws ApiException

Gets transfer history list asynchronously.
GET /v2/transfer

Parameters:

preset - Preset ID to be used for search. Preset ID can be checked in KAS console.

options - Filters required when retrieving data. `kind`, `range`, `size`, and `cursor`.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getTransferHistoryAsync

public com.squareup.okhttp.Call getTransferHistoryAsync(java.util.List<java.lang.Integer> presets,
                                                        TokenHistoryQueryOptions options,
                                                        ApiCallback<PageableTransfers> callback)
                                                 throws ApiException

Gets transfer history list asynchronously.
GET /v2/transfer

Parameters:

presets - Preset ID to be used for search. Preset ID can be checked in KAS console.

options - Filters required when retrieving data. `kind`, `range`, `size`, and `cursor`.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getTransferHistoryByTxHash

public Transfers getTransferHistoryByTxHash(java.lang.String txHash)
                                     throws ApiException

Gets token history list with a specific transaction hash.
GET /v2/transfer/tx/{transaction-hash}

Parameters:

txHash - A transaction hash to get token history

Returns:

Transfers

Throws:

ApiException

getTransferHistoryByTxHashAsync

public com.squareup.okhttp.Call getTransferHistoryByTxHashAsync(java.lang.String txHash,
                                                                ApiCallback<Transfers> callback)
                                                         throws ApiException

Gets token history list with a specific transaction hash asynchronously.
GET /v2/transfer/tx/{transaction-hash}

Parameters:

txHash - A transaction hash to get token history

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getTransferHistoryByAccount

public PageableTransfers getTransferHistoryByAccount(java.lang.String address)
                                              throws ApiException

Gets token history list with a specific EOA.
It will send a request without filter options.
GET /v2/transfer/account/{address}

Parameters:

address - The EOA address used to search for token transfer history.

Returns:

PageableTransfers

Throws:

ApiException

getTransferHistoryByAccount

public PageableTransfers getTransferHistoryByAccount(java.lang.String address,
                                                     TokenHistoryQueryOptions options)
                                              throws ApiException

Gets token history list with a specific EOA.
GET /v2/transfer/account/{address}

Parameters:

address - The EOA address used to search for token transfer history.

options - Filters required when retrieving data. `kind`, `caFilter`, `range`, `size`, and `cursor`.

Returns:

PageableTransfers

Throws:

ApiException

getTransferHistoryAccountAsync

public com.squareup.okhttp.Call getTransferHistoryAccountAsync(java.lang.String address,
                                                               ApiCallback<PageableTransfers> callback)
                                                        throws ApiException

Gets token history list with a specific EOA asynchronously.
It will send a request without filter options.
GET /v2/transfer/account/{address}

Parameters:

address - The EOA address used to search for token transfer history.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getTransferHistoryAccountAsync

public com.squareup.okhttp.Call getTransferHistoryAccountAsync(java.lang.String address,
                                                               TokenHistoryQueryOptions options,
                                                               ApiCallback<PageableTransfers> callback)
                                                        throws ApiException

Gets token history list with a specific EOA asynchronously.
GET /v2/transfer/account/{address}

Parameters:

address - The EOA address used to search for token transfer history.

options - Filters required when retrieving data. `kind`, `caFilter`, `range`, `size`, and `cursor`.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getFTContractList

public PageableFtContractDetails getFTContractList()
                                            throws ApiException

Retrieve information of all labeled FT contracts.
It will send a request without filter options.
GET /v2/contract/ft

Returns:

PageableFtContractDetails

Throws:

ApiException

getFTContractList

public PageableFtContractDetails getFTContractList(TokenHistoryQueryOptions options)
                                            throws ApiException

Retrieve information of all labeled FT contracts.
GET /v2/contract/ft

Parameters:

options - Filters required when retrieving data. `status`, `type`, `size`, and `cursor`.

Returns:

PageableFtContractDetails

Throws:

ApiException

getFTContractListAsync

public com.squareup.okhttp.Call getFTContractListAsync(ApiCallback<PageableFtContractDetails> callback)
                                                throws ApiException

Retrieve information of all labeled FT contracts asynchronously.
It will send a request without filter options.
GET /v2/contract/ft

Parameters:

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getFTContractListAsync

public com.squareup.okhttp.Call getFTContractListAsync(TokenHistoryQueryOptions options,
                                                       ApiCallback<PageableFtContractDetails> callback)
                                                throws ApiException

Retrieve information of all labeled FT contracts asynchronously.
GET /v2/contract/ft

Parameters:

options - Filters required when retrieving data. `status`, `type`, `size`, and `cursor`.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getFTContract

public FtContractDetail getFTContract(java.lang.String ftAddress)
                               throws ApiException

Retrieves the information of the FT contract labeled with the address of the FT contract.
GET /v2/contract/ft/{ft-address}

Parameters:

ftAddress - The FT contract address to retrieve contract information.

Returns:

FtContractDetail

Throws:

ApiException

getFTContractAsync

public com.squareup.okhttp.Call getFTContractAsync(java.lang.String ftAddress,
                                                   ApiCallback<FtContractDetail> callback)
                                            throws ApiException

Retrieves the information of the FT contract labeled with the address of the FT contract asynchronously.
GET /v2/contract/ft/{ft-address}

Parameters:

ftAddress - The FT contract address to retrieve contract information.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getNFTContractList

public PageableNftContractDetails getNFTContractList()
                                              throws ApiException

Retrieve information of all labeled NFT contracts.
It will send a request without filter options.
GET /v2/contract/nft

Returns:

PageableNftContractDetails

Throws:

ApiException

getNFTContractList

public PageableNftContractDetails getNFTContractList(TokenHistoryQueryOptions options)
                                              throws ApiException

Retrieve information of all labeled NFT contracts.
GET /v2/contract/nft

Parameters:

options - Filters required when retrieving data. `status`, `type`, `size`, and `cursor`.

Returns:

PageableNftContractDetails

Throws:

ApiException

getNFTContractListAsync

public com.squareup.okhttp.Call getNFTContractListAsync(ApiCallback<PageableNftContractDetails> callback)
                                                 throws ApiException

Retrieve information of all labeled NFT contracts asynchronously.
It will send a request without filter options.
GET /v2/contract/nft

Parameters:

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getNFTContractListAsync

public com.squareup.okhttp.Call getNFTContractListAsync(TokenHistoryQueryOptions options,
                                                        ApiCallback<PageableNftContractDetails> callback)
                                                 throws ApiException

Retrieve information of all labeled NFT contracts asynchronously.
GET /v2/contract/nft

Parameters:

options - Filters required when retrieving data. `status`, `type`, `size`, and `cursor`.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getNFTContract

public NftContractDetail getNFTContract(java.lang.String nftAddress)
                                 throws ApiException

Retrieves the information of the NFT contract labeled with the address of the NFT contract.
GET /v2/contract/nft/{nftAddress}

Parameters:

nftAddress - The NFT contract address to retrieve contract information.

Returns:

NftContractDetail

Throws:

ApiException

getNFTContractAsync

public com.squareup.okhttp.Call getNFTContractAsync(java.lang.String nftAddress,
                                                    ApiCallback<NftContractDetail> callback)
                                             throws ApiException

Retrieves the information of the NFT contract labeled with the address of the NFT contract asynchronously.
GET /v2/contract/nft/{nftAddress}

Parameters:

nftAddress - The NFT contract address to retrieve contract information.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getNFTList

public PageableNfts getNFTList(java.lang.String nftAddress)
                        throws ApiException

Retrieves information of all NFTs issued by a specific NFT contract.
It will send a request without filter options.
GET /v2/contract/nft/{nft-address}/token

Parameters:

nftAddress - The NFT contract address to search issued NFTs.

Returns:

PageableNfts

Throws:

ApiException

getNFTList

public PageableNfts getNFTList(java.lang.String nftAddress,
                               TokenHistoryQueryOptions options)
                        throws ApiException

Retrieves information of all NFTs issued by a specific NFT contract.

Parameters:

nftAddress - The NFT contract address to search issued NFTs.

options - Filters required when retrieving data. `size`, and `cursor`.

Returns:

PageableNfts

Throws:

ApiException

getNFTListAsync

public com.squareup.okhttp.Call getNFTListAsync(java.lang.String nftAddress,
                                                ApiCallback<PageableNfts> callback)
                                         throws ApiException

Retrieves information of all NFTs issued by a specific NFT contract asynchronously.
It will send a request without filter options.
GET /v2/contract/nft/{nft-address}/token

Parameters:

nftAddress - The NFT contract address to search issued NFTs.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getNFTListAsync

public com.squareup.okhttp.Call getNFTListAsync(java.lang.String nftAddress,
                                                TokenHistoryQueryOptions options,
                                                ApiCallback<PageableNfts> callback)
                                         throws ApiException

Retrieves information of all NFTs issued by a specific NFT contract asynchronously.
GET /v2/contract/nft/{nft-address}/token

Parameters:

nftAddress - The NFT contract address to search issued NFTs.

options - Filters required when retrieving data. `size`, and `cursor`.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getNFTListByOwner

public PageableNfts getNFTListByOwner(java.lang.String nftAddress,
                                      java.lang.String ownerAddress)
                               throws ApiException

Among the NFTs issued from the NFT contract address,
the information of the NFT owned by the EOA address received as a parameter is retrieved.
It will send a request without filter options.
GET /v2/contract/nft/{nft-address}/owner/{owner-address}

Parameters:

nftAddress - The NFT contract address to be searched issued NFTs

ownerAddress - The EOA address to be searched NFTs

Returns:

PageableNfts

Throws:

ApiException

getNFTListByOwner

public PageableNfts getNFTListByOwner(java.lang.String nftAddress,
                                      java.lang.String ownerAddress,
                                      TokenHistoryQueryOptions options)
                               throws ApiException

Among the NFTs issued from the NFT contract address,
the information of the NFT owned by the EOA address received as a parameter is retrieved.
GET /v2/contract/nft/{nft-address}/owner/{owner-address}

Parameters:

nftAddress - The NFT contract address to be searched issued NFTs

ownerAddress - The EOA address to be searched NFTs

options - Filters required when retrieving data. `size`, and `cursor`.

Returns:

PageableNfts

Throws:

ApiException

getNFTListByOwnerAsync

public com.squareup.okhttp.Call getNFTListByOwnerAsync(java.lang.String nftAddress,
                                                       java.lang.String ownerAddress,
                                                       ApiCallback<PageableNfts> callback)
                                                throws ApiException

Among the NFTs issued from the NFT contract address.
the information of the NFT owned by the EOA address received as a parameter is retrieved asynchronously.
It will send a request without filter options.
GET /v2/contract/nft/{nft-address}/owner/{owner-address}

Parameters:

nftAddress - The NFT contract address to be searched issued NFTs

ownerAddress - The EOA address to be searched NFTs

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getNFTListByOwnerAsync

public com.squareup.okhttp.Call getNFTListByOwnerAsync(java.lang.String nftAddress,
                                                       java.lang.String ownerAddress,
                                                       TokenHistoryQueryOptions options,
                                                       ApiCallback<PageableNfts> callback)
                                                throws ApiException

Among the NFTs issued from the NFT contract address,
the information of the NFT owned by the EOA address received as a parameter is retrieved asynchronously.
GET /v2/contract/nft/{nft-address}/owner/{owner-address}

Parameters:

nftAddress - The NFT contract address to be searched issued NFTs

ownerAddress - The EOA address to be searched NFTs

options - Filters required when retrieving data. `size`, and `cursor`.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getNFT

public Nft getNFT(java.lang.String nftAddress,
                  java.lang.String tokenId)
           throws ApiException

Retrieve information of a specific NFT.
GET /v2/contract/nft/{nft-address}/token/{token-id}

Parameters:

nftAddress - The NFT contract address to be searched.

tokenId - The NFT id to be searched.

Returns:

Nft

Throws:

ApiException

getNFTAsync

public com.squareup.okhttp.Call getNFTAsync(java.lang.String nftAddress,
                                            java.lang.String tokenId,
                                            ApiCallback<Nft> callback)
                                     throws ApiException

Retrieve information of a specific NFT asynchronously.
GET /v2/contract/nft/{nft-address}/token/{token-id}

Parameters:

nftAddress - The NFT contract address to be searched.

tokenId - The NFT id to be searched.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getNFTOwnershipHistory

public PageableNftOwnershipChanges getNFTOwnershipHistory(java.lang.String nftAddress,
                                                          java.lang.String tokenId)
                                                   throws ApiException

Retrieve the record of ownership changes for a specific NFT.
It will send a request without filter options.
GET /v2/contract/nft/{nft-address}/token/{token-id}/history

Parameters:

nftAddress - The NFT contract address to be searched.

tokenId - The NFT id to be searched.

Returns:

PageableNftOwnershipChanges

Throws:

ApiException

getNFTOwnershipHistory

public PageableNftOwnershipChanges getNFTOwnershipHistory(java.lang.String nftAddress,
                                                          java.lang.String tokenId,
                                                          TokenHistoryQueryOptions options)
                                                   throws ApiException

Retrieve the record of ownership changes for a specific NFT.
GET /v2/contract/nft/{nft-address}/token/{token-id}/history

Parameters:

nftAddress - The NFT contract address to be searched.

tokenId - The NFT id to be searched.

options - Filters required when retrieving data. `size`, and `cursor`.

Returns:

PageableNftOwnershipChanges

Throws:

ApiException

getNFTOwnershipHistoryAsync

public com.squareup.okhttp.Call getNFTOwnershipHistoryAsync(java.lang.String nftAddress,
                                                            java.lang.String tokenId,
                                                            ApiCallback<PageableNftOwnershipChanges> callback)
                                                     throws ApiException

Retrieve the record of ownership changes for a specific NFT asynchronously.
It will send a request without filter options.
GET /v2/contract/nft/{nft-address}/token/{token-id}/history

Parameters:

nftAddress - The NFT contract address to be searched.

tokenId - The NFT id to be searched.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getNFTOwnershipHistoryAsync

public com.squareup.okhttp.Call getNFTOwnershipHistoryAsync(java.lang.String nftAddress,
                                                            java.lang.String tokenId,
                                                            TokenHistoryQueryOptions options,
                                                            ApiCallback<PageableNftOwnershipChanges> callback)
                                                     throws ApiException

Retrieve the record of ownership changes for a specific NFT asynchronously.
GET /v2/contract/nft/{nft-address}/token/{token-id}/history

Parameters:

nftAddress - The NFT contract address to be searched.

tokenId - The NFT id to be searched.

options - Filters required when retrieving data. `size`, and `cursor`.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getMTListByOwner

public PageableMtTokensWithBalance getMTListByOwner(java.lang.String mtAddress,
                                                    java.lang.String ownerAddress)
                                             throws ApiException

Retrieve MTs(Multiple Token) that are owned by the passed as ownerAddress.
It will send a request without filter options.
If you want to execute this function with search options(size, cursor), use getMTListByOwner(String, TokenHistoryQueryOptions).
GET /v2/contract/mt/{mt-address}/owner/{owner-address}

Parameters:

mtAddress - The MT contract address.

ownerAddress - The owner address to retrieve MTs.

Returns:

PageableMtTokensWithBalance

Throws:

ApiException

getMTListByOwner

public PageableMtTokensWithBalance getMTListByOwner(java.lang.String mtAddress,
                                                    java.lang.String ownerAddress,
                                                    TokenHistoryQueryOptions options)
                                             throws ApiException

Retrieve MTs(Multiple Token) that are owned by the passed as ownerAddress.
You can set a search options(size, cursor) by using TokenHistoryQueryOptions.
GET /v2/contract/mt/{mt-address}/owner/{owner-address}

Parameters:

mtAddress - The MT contract address.

ownerAddress - The owner address to retrieve MTs.

options - Filters required when retrieving data. `size`, `cursor`.

Returns:

PageableMtTokensWithBalance

Throws:

ApiException

getMTListByOwnerAsync

public com.squareup.okhttp.Call getMTListByOwnerAsync(java.lang.String mtAddress,
                                                      java.lang.String ownerAddress,
                                                      ApiCallback<PageableMtTokensWithBalance> callback)
                                               throws ApiException

Retrieve MTs(Multiple Token) that are owned by the passed as ownerAddress asynchronously.
It will send a request without filter options.
If you want to execute this function with search options(size, cursor), use getMTListByOwnerAsync(String, TokenHistoryQueryOptions).
GET /v2/contract/mt/{mt-address}/owner/{owner-address}

Parameters:

mtAddress - The MT contract address.

ownerAddress - The owner address to retrieve MTs.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getMTListByOwnerAsync

public com.squareup.okhttp.Call getMTListByOwnerAsync(java.lang.String mtAddress,
                                                      java.lang.String ownerAddress,
                                                      TokenHistoryQueryOptions options,
                                                      ApiCallback<PageableMtTokensWithBalance> callback)
                                               throws ApiException

Retrieve MTs(Multiple Token) that are owned by the passed as ownerAddress asynchronously.
You can set a search options(size, cursor) by using TokenHistoryQueryOptions.
GET /v2/contract/mt/{mt-address}/owner/{owner-address}

Parameters:

mtAddress - The MT contract address.

ownerAddress - The owner address to retrieve MTs.

options - Filters required when retrieving data. `size`, `cursor`.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getMT

public MtToken getMT(java.lang.String mtAddress,
                     java.lang.String ownerAddress,
                     java.lang.String tokenID)
              throws ApiException

Retrieve a specific MT(Multiple Token) corresponding to the given address and tokenID.
GET /v2/contract/mt/{mt-address}/owner/{owner-address}/token/{token-id}

Parameters:

mtAddress - The MT contract address.

ownerAddress - The owner address.

tokenID - The token id.

Returns:

MtToken

Throws:

ApiException

getMTAsync

public com.squareup.okhttp.Call getMTAsync(java.lang.String mtAddress,
                                           java.lang.String ownerAddress,
                                           java.lang.String tokenID,
                                           ApiCallback<MtToken> callback)
                                    throws ApiException

Retrieve a specific MT(Multiple Token) corresponding to the given address and tokenID asynchronously.
GET /v2/contract/mt/{mt-address}/owner/{owner-address}/token/{token-id}

Parameters:

mtAddress - The MT contract address.

ownerAddress - The owner address.

tokenID - The token id.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getMTOwnerListByTokenId

public PageableMtTokens getMTOwnerListByTokenId(java.lang.String mtAddress,
                                                java.lang.String tokenId)
                                         throws ApiException

Retrieve a specific MT(Multiple Token) owner corresponding to the given tokenID.
It will send a request without filter options.
If you want to execute this function with search options(size, cursor), use getMTOwnerByTokenId(String, TokenHistoryQueryOptions).
GET /v2/contract/mt/{mt-address}/token/{token-id}

Parameters:

mtAddress - The MT contract address.

tokenId - The token id.

Returns:

PageableMtTokens

Throws:

ApiException

getMTOwnerListByTokenId

public PageableMtTokens getMTOwnerListByTokenId(java.lang.String mtAddress,
                                                java.lang.String tokenId,
                                                TokenHistoryQueryOptions options)
                                         throws ApiException

Retrieve a specific MT(Multiple Token) owner corresponding to the given tokenID.
You can set a search options(size, cursor) by using TokenHistoryQueryOptions.
GET /v2/contract/mt/{mt-address}/token/{token-id}

Parameters:

mtAddress - The MT contract address.

tokenId - The token id.

options - Filters required when retrieving data. `size`, `cursor`.

Returns:

PageableMtTokens

Throws:

ApiException

getMTOwnerListByTokenIdAsync

public com.squareup.okhttp.Call getMTOwnerListByTokenIdAsync(java.lang.String mtAddress,
                                                             java.lang.String tokenId,
                                                             ApiCallback<PageableMtTokens> callback)
                                                      throws ApiException

Retrieve a specific MT(Multiple Token) owner corresponding to the given tokenID asynchronously.
It will send a request without filter options.
If you want to execute this function with search options(size, cursor), use getMTOwnerByTokenId(String, TokenHistoryQueryOptions).
GET /v2/contract/mt/{mt-address}/token/{token-id}

Parameters:

mtAddress - The MT contract address.

tokenId - The token id.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getMTOwnerListByTokenIdAsync

public com.squareup.okhttp.Call getMTOwnerListByTokenIdAsync(java.lang.String mtAddress,
                                                             java.lang.String tokenId,
                                                             TokenHistoryQueryOptions options,
                                                             ApiCallback<PageableMtTokens> callback)
                                                      throws ApiException

Retrieve a specific MT(Multiple Token) owner corresponding to the given tokenID asynchronously.
You can set a search options(size, cursor) by using TokenHistoryQueryOptions.
GET /v2/contract/mt/{mt-address}/token/{token-id}

Parameters:

mtAddress - The MT contract address.

tokenId - The token id.

options - Filters required when retrieving data. `size`, `cursor`.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getMTContractList

public PageableMtContractDetails getMTContractList()
                                            throws ApiException

Retrieve information of all labeled MT(Multiple Token) contracts.
It will send a request without filter options.
If you want to execute this function with search options(status, type, size, cursor), use getMTContractList(TokenHistoryQueryOptions).
GET /v2/contract/mt

Returns:

PageableMtContractDetails

Throws:

ApiException

getMTContractList

public PageableMtContractDetails getMTContractList(TokenHistoryQueryOptions options)
                                            throws ApiException

Retrieve information of all labeled MT(Multiple Token) contracts.
You can set a search options(status, type, size, cursor) by using TokenHistoryQueryOptions.
GET /v2/contract/mt

Parameters:

options - Filters required when retrieving data. `status`, `type`, `size`, `cursor`.

Returns:

PageableMtContractDetails

Throws:

ApiException

getMTContractListAsync

public com.squareup.okhttp.Call getMTContractListAsync(ApiCallback<PageableMtContractDetails> callback)
                                                throws ApiException

Retrieve information of all labeled MT(Multiple Token) contracts asynchronously.
It will send a request without filter options.
If you want to execute this function with search options(status, type, size, cursor), use getMTContractList(TokenHistoryQueryOptions).
GET /v2/contract/mt

Parameters:

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getMTContractListAsync

public com.squareup.okhttp.Call getMTContractListAsync(TokenHistoryQueryOptions options,
                                                       ApiCallback<PageableMtContractDetails> callback)
                                                throws ApiException

Retrieve information of all labeled MT(Multiple Token) contracts asynchronously.
You can set a search options(status, type, size, cursor) by using TokenHistoryQueryOptions.
GET /v2/contract/mt

Parameters:

options - Filters required when retrieving data. `status`, `type`, `size`, `cursor`.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getMTContract

public MtContractDetail getMTContract(java.lang.String mtAddress)
                               throws ApiException

Retrieves the information of the FT contract labeled with the address of the MT(Multiple Token) contract.
GET /v2/contract/mt/{mt-address}

Parameters:

mtAddress - The MT contract address.

Returns:

MtContractDetail

Throws:

ApiException

getMTContractAsync

public com.squareup.okhttp.Call getMTContractAsync(java.lang.String mtAddress,
                                                   ApiCallback<MtContractDetail> callback)
                                            throws ApiException

Retrieves the information of the FT contract labeled with the address of the MT(Multiple Token) contract asynchronously.
GET /v2/contract/mt/{mt-address}

Parameters:

mtAddress - The MT contract address.

callback - The callback function to handle response.

Returns:

Call

Throws:

ApiException

getTokenApi

public TokenApi getTokenApi()

Getter function for tokenApi

Returns:

TokenApi

getTokenContractApi

public TokenContractApi getTokenContractApi()

Getter function TokenContractApi

Returns:

TokenContractApi

getTokenHistoryApi

public TokenHistoryApi getTokenHistoryApi()

Getter function for TokenHistoryApi

Returns:

TokenHistoryApi

getTokenOwnershipApi

public TokenOwnershipApi getTokenOwnershipApi()

Getter function for TokenOwnershipApi

Returns:

TokenOwnershipApi

getChainId

public java.lang.String getChainId()

Getter function for chain id

Returns:

String

getApiClient

public ApiClient getApiClient()

Getter function for ApiClient

Returns:

ApiClient

setTokenApi

public void setTokenApi(TokenApi tokenApi)

Setter function for TokenApi

Parameters:

tokenApi - Token API rest-client object.

setTokenContractApi

public void setTokenContractApi(TokenContractApi tokenContractApi)

Setter function for TokenContractApi

Parameters:

tokenContractApi - Token contract API rest-client object.

setTokenHistoryApi

public void setTokenHistoryApi(TokenHistoryApi tokenHistoryApi)

Setter function for TokenHistoryApi

Parameters:

tokenHistoryApi - Token history API rest-client object.

setTokenOwnershipApi

public void setTokenOwnershipApi(TokenOwnershipApi tokenOwnershipApi)

Setter function for TokenOwnershipApi

Parameters:

tokenOwnershipApi - Token owner API rest-client object.

setChainId

public void setChainId(java.lang.String chainId)

Setter function for chain id

Parameters:

chainId - The klaytn network chain id.

setApiClient

public void setApiClient(ApiClient apiClient)

Setter function for apiClient

Parameters:

apiClient - The ApiClient for connecting with KAS.