TokenApi

TokenApi

new TokenApi()

Version:
  • 1.0

Token service.

Methods

getMtTokensByContractAddressAndOwnerAddress(opts, callback)

Get token data for MT data by EOA Selecting an MT contract and an EOA will fetch data of MTs by EOA created by MT contract.<p></p> ## Size<p></p> * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default (`size=100`) when given a 0<br> * Uses the maximum value (`size=1000`) when given a value higher than 1000<br>

Parameters:
Name Type Description
opts Object

Optional parameters

callback TokenApi~getMtTokensByContractAddressAndOwnerAddressCallback

The callback function, accepting three arguments: error, data, response data is of type: PageableMtTokensWithBalance

getMtTokensByContractAddressAndOwnerAddressAndTokenId(callback)

Get data of MT contracts for certain EOAs Query data of certain MTs.

Parameters:
Name Type Description
callback TokenApi~getMtTokensByContractAddressAndOwnerAddressAndTokenIdCallback

The callback function, accepting three arguments: error, data, response data is of type: MtToken

getMtTokensByContractAddressAndTokenId(opts, callback)

Query list of all owners for certain MTs Selecting an MT contract and a token ID will data of the EOA that owns the tokens.<p></p> ## Size<p></p> * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default (`size=100`) when given a 0<br> * Uses the maximum value (`size=1000`) when given a value higher than 1000<br>

Parameters:
Name Type Description
opts Object

Optional parameters

callback TokenApi~getMtTokensByContractAddressAndTokenIdCallback

The callback function, accepting three arguments: error, data, response data is of type: PageableMtTokens

getMtsByContractAddress(opts, callback)

Query data of all tokens for certain MT contracts Selecting an MT contract will fetch all data of tokens issued by the contract.<p></p> ## Sort<p></p> * The items in the response will be listed in lexicographical order of the token IDs. <p></p><br> ## Size<p></p> * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default (`size=100`) when given a 0<br> * Uses the maximum value (`size=1000`) when given a value higher than 1000<br>

Parameters:
Name Type Description
opts Object

Optional parameters

callback TokenApi~getMtsByContractAddressCallback

The callback function, accepting three arguments: error, data, response data is of type: PageableMts

getNftById(callback)

Query token data for certain NFTs Fetch data for certain NFTs

Parameters:
Name Type Description
callback TokenApi~getNftByIdCallback

The callback function, accepting three arguments: error, data, response data is of type: Nft

getNftsByContractAddress(opts, callback)

Query all token data for certain NFT contracts Selecting an NFT contract will fetch data of all NFTs created by this NFT contract.<p></p> ## Size<p></p> * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default (`size=100`) when given a 0<br> * Uses the maximum value (`size=1000`) when given a value higher than 1000<br>

Parameters:
Name Type Description
opts Object

Optional parameters

callback TokenApi~getNftsByContractAddressCallback

The callback function, accepting three arguments: error, data, response data is of type: PageableNfts

getNftsByOwnerAddress(opts, callback)

Get token data for NFT data by EOA Selecting an NFT contract and an EOA will fetch data of the NFTs by EOA created by the NFT contract.<p></p> ## Size<p></p> * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default (`size=100`) when given a 0<br> * Uses the maximum value (`size=1000`) when given a value higher than 1000<br>

Parameters:
Name Type Description
opts Object

Optional parameters

callback TokenApi~getNftsByOwnerAddressCallback

The callback function, accepting three arguments: error, data, response data is of type: PageableNfts

Type Definitions

getMtTokensByContractAddressAndOwnerAddressCallback(error, data, response)

Callback function to receive the result of the getMtTokensByContractAddressAndOwnerAddress operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableMtTokensWithBalance

The data returned by the service call.

response String

The complete HTTP response.

getMtTokensByContractAddressAndOwnerAddressAndTokenIdCallback(error, data, response)

Callback function to receive the result of the getMtTokensByContractAddressAndOwnerAddressAndTokenId operation.

Parameters:
Name Type Description
error String

Error message, if any.

data MtToken

The data returned by the service call.

response String

The complete HTTP response.

getMtTokensByContractAddressAndTokenIdCallback(error, data, response)

Callback function to receive the result of the getMtTokensByContractAddressAndTokenId operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableMtTokens

The data returned by the service call.

response String

The complete HTTP response.

getMtsByContractAddressCallback(error, data, response)

Callback function to receive the result of the getMtsByContractAddress operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableMts

The data returned by the service call.

response String

The complete HTTP response.

getNftByIdCallback(error, data, response)

Callback function to receive the result of the getNftById operation.

Parameters:
Name Type Description
error String

Error message, if any.

data Nft

The data returned by the service call.

response String

The complete HTTP response.

getNftsByContractAddressCallback(error, data, response)

Callback function to receive the result of the getNftsByContractAddress operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableNfts

The data returned by the service call.

response String

The complete HTTP response.

getNftsByOwnerAddressCallback(error, data, response)

Callback function to receive the result of the getNftsByOwnerAddress operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableNfts

The data returned by the service call.

response String

The complete HTTP response.

TokenApi

new TokenApi(apiClientopt)

Constructs a new TokenApi.

Parameters:
Name Type Attributes Description
apiClient ApiClient <optional>

Optional API client implementation to use, default to ApiClient#instance if unspecified.

Methods

getMtTokensByContractAddressAndOwnerAddress(opts, callback)

Get token data for MT data by EOA Selecting an MT contract and an EOA will fetch data of MTs by EOA created by MT contract.<p></p> ## Size<p></p> * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default (`size=100`) when given a 0<br> * Uses the maximum value (`size=1000`) when given a value higher than 1000<br>

Parameters:
Name Type Description
opts Object

Optional parameters

callback TokenApi~getMtTokensByContractAddressAndOwnerAddressCallback

The callback function, accepting three arguments: error, data, response data is of type: PageableMtTokensWithBalance

getMtTokensByContractAddressAndOwnerAddressAndTokenId(callback)

Get data of MT contracts for certain EOAs Query data of certain MTs.

Parameters:
Name Type Description
callback TokenApi~getMtTokensByContractAddressAndOwnerAddressAndTokenIdCallback

The callback function, accepting three arguments: error, data, response data is of type: MtToken

getMtTokensByContractAddressAndTokenId(opts, callback)

Query list of all owners for certain MTs Selecting an MT contract and a token ID will data of the EOA that owns the tokens.<p></p> ## Size<p></p> * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default (`size=100`) when given a 0<br> * Uses the maximum value (`size=1000`) when given a value higher than 1000<br>

Parameters:
Name Type Description
opts Object

Optional parameters

callback TokenApi~getMtTokensByContractAddressAndTokenIdCallback

The callback function, accepting three arguments: error, data, response data is of type: PageableMtTokens

getMtsByContractAddress(opts, callback)

Query data of all tokens for certain MT contracts Selecting an MT contract will fetch all data of tokens issued by the contract.<p></p> ## Sort<p></p> * The items in the response will be listed in lexicographical order of the token IDs. <p></p><br> ## Size<p></p> * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default (`size=100`) when given a 0<br> * Uses the maximum value (`size=1000`) when given a value higher than 1000<br>

Parameters:
Name Type Description
opts Object

Optional parameters

callback TokenApi~getMtsByContractAddressCallback

The callback function, accepting three arguments: error, data, response data is of type: PageableMts

getNftById(callback)

Query token data for certain NFTs Fetch data for certain NFTs

Parameters:
Name Type Description
callback TokenApi~getNftByIdCallback

The callback function, accepting three arguments: error, data, response data is of type: Nft

getNftsByContractAddress(opts, callback)

Query all token data for certain NFT contracts Selecting an NFT contract will fetch data of all NFTs created by this NFT contract.<p></p> ## Size<p></p> * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default (`size=100`) when given a 0<br> * Uses the maximum value (`size=1000`) when given a value higher than 1000<br>

Parameters:
Name Type Description
opts Object

Optional parameters

callback TokenApi~getNftsByContractAddressCallback

The callback function, accepting three arguments: error, data, response data is of type: PageableNfts

getNftsByOwnerAddress(opts, callback)

Get token data for NFT data by EOA Selecting an NFT contract and an EOA will fetch data of the NFTs by EOA created by the NFT contract.<p></p> ## Size<p></p> * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default (`size=100`) when given a 0<br> * Uses the maximum value (`size=1000`) when given a value higher than 1000<br>

Parameters:
Name Type Description
opts Object

Optional parameters

callback TokenApi~getNftsByOwnerAddressCallback

The callback function, accepting three arguments: error, data, response data is of type: PageableNfts

Type Definitions

getMtTokensByContractAddressAndOwnerAddressCallback(error, data, response)

Callback function to receive the result of the getMtTokensByContractAddressAndOwnerAddress operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableMtTokensWithBalance

The data returned by the service call.

response String

The complete HTTP response.

getMtTokensByContractAddressAndOwnerAddressAndTokenIdCallback(error, data, response)

Callback function to receive the result of the getMtTokensByContractAddressAndOwnerAddressAndTokenId operation.

Parameters:
Name Type Description
error String

Error message, if any.

data MtToken

The data returned by the service call.

response String

The complete HTTP response.

getMtTokensByContractAddressAndTokenIdCallback(error, data, response)

Callback function to receive the result of the getMtTokensByContractAddressAndTokenId operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableMtTokens

The data returned by the service call.

response String

The complete HTTP response.

getMtsByContractAddressCallback(error, data, response)

Callback function to receive the result of the getMtsByContractAddress operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableMts

The data returned by the service call.

response String

The complete HTTP response.

getNftByIdCallback(error, data, response)

Callback function to receive the result of the getNftById operation.

Parameters:
Name Type Description
error String

Error message, if any.

data Nft

The data returned by the service call.

response String

The complete HTTP response.

getNftsByContractAddressCallback(error, data, response)

Callback function to receive the result of the getNftsByContractAddress operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableNfts

The data returned by the service call.

response String

The complete HTTP response.

getNftsByOwnerAddressCallback(error, data, response)

Callback function to receive the result of the getNftsByOwnerAddress operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableNfts

The data returned by the service call.

response String

The complete HTTP response.