TokenHistoryApi

new TokenHistoryApi()

Version:

TokenHistory service.

Methods

getTransfers(opts, callback)

Query received and sent transfers of tokens Query all transaction history. Transaction history is divided into KLAY Transfer (`KlayTransfer`), FT Transfer (`FtTransfer`), NFT Transfer (`NftTransfer`), and MT Transfer (`MtTransfer`). ## KlayTransfer in FT/NFT/MT transactions For transfers of FTs, NFTs, or MTs, `KlayTransfer` history will also be included in the query result. This is because FT/NFT/MT transfers are essentially execution of a corresponding contract function, and the response for the transfer includes `KlayTransfer`, which is equivalent to the transaction for sending KLAY. Since most transactions that execute contract functions do not usually send KLAY, the `value` of `KlayTransfer` that transfered NT, NFT, and MT may be zero. By using the `exclude-zero-klay=true` query, `KlayTransfer` can be excluded. ## Transaction type * You can choose KLAY, FT, NFT or MT by setting `kind` parameter to get transaction history of a certain type or a combination of types. * If you don't set the `kind` parameter, all transaction types will be returned. ## Date range * `range` is queried in the form of `range={from},{to}` * `{from}` and `{to}` will be considered Unix time in the case of a decimal number, and block number in the case of a hexadecimal number * When there is no value for `{to}`, current time or the latest block number will be used. * You can retrieve the transaction history from the past 6 months maximum. (for both Unix time and block number) ## Preset Preset is a collection of EOA and FT, NFT and MT contracts. You can use it to repetitively retrieve transaction history for certain accounts quickly and easily. * The parameter `presets` is a required parameter. * Preset needs to be created on KAS Console in advance. * You can check your Preset ID on KAS Console. For more information please visit Preset. ## Size * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100) * Returns an error when given a negative number * Uses default value (`size=100`) when `size=0` * Uses the maximum value (`size=1000`) when given a value higher than the maximum value.

Parameters:

Name	Type	Description
`opts`	Object	Optional parameters
`callback`	TokenHistoryApi~getTransfersCallback	The callback function, accepting three arguments: error, data, response data is of type: PageableTransfers

getTransfersByEoa(opts, callback)

Query received and sent transfers of tokens with EOA Query token transaction history for a certain EOA. Functionally, it is same as `GET /v2/transfer`. If the EOA received the token, `to` is same as the EOA, and if the EOA sent the token, `from` is the same as the EOA in the returned transfer object. Transaction history is divided into KLAY transfer (`KlayTransfer`), FT transfer (`FtTransfer`), NFT transfer (`NftTransfer`), MT transfer (`MtTransfer`). For FT, NFT, MT transfers, history of `KlayTransfer` will be included in the result. `KlayTransfer` included in FT, NFT, MT transfers may have a `value` of 0. For more details, please refer to `GET /v2/transfer`. ## Transaction type * You can set the `kind` parameter to query different types of transactions. * Not setting the `kind` parameter will query all types of transactions. ## Date range * `range` is queried in the form of `range={from},{to}` * `{from}` and `{to}` will be considered Unix time in the case of a decimal number, and block number in the case of a hexadecimal number * When there is no value for `{to}`, current time or the latest block number will be used. * You can retrieve the transaction history from the past 6 months maximum. (for both unix time and block number) ## Size * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100) * Returns an error when given a negative number. * Uses default value (`size=100`) when given a 0. * Uses the maximum value (`size=1000`) when given a value higher than 1000.

Parameters:

Name	Type	Description
`opts`	Object	Optional parameters
`callback`	TokenHistoryApi~getTransfersByEoaCallback	The callback function, accepting three arguments: error, data, response data is of type: PageableTransfers

getTransfersByTxHash(callback)

Query received and sent transfers of tokens with transaction hash Get transaction history by transaction hash. Transaction history is divided into KLAY transfer (`KlayTransfer`), FT transfer (`FtTransfer`), NFT transfer (`NftTransfer`), MT transfer (`MtTransfer`). For FT, NFT, MT transfers, history of `KlayTransfer` will be included in the result. `KlayTransfer` included in FT, NFT, MT transfers may have a `value` of 0. For more details, please refer to `GET /v2/transfer`.

Parameters:

Name	Type	Description
`callback`	TokenHistoryApi~getTransfersByTxHashCallback	The callback function, accepting three arguments: error, data, response data is of type: Transfers

Type Definitions

getTransfersCallback(error, data, response)

Callback function to receive the result of the getTransfers operation.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	PageableTransfers	The data returned by the service call.
`response`	String	The complete HTTP response.

getTransfersByEoaCallback(error, data, response)

Callback function to receive the result of the getTransfersByEoa operation.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	PageableTransfers	The data returned by the service call.
`response`	String	The complete HTTP response.

getTransfersByTxHashCallback(error, data, response)

Callback function to receive the result of the getTransfersByTxHash operation.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	Transfers	The data returned by the service call.
`response`	String	The complete HTTP response.