TokenContractApi

TokenContractApi

new TokenContractApi()

Version:
  • 1.0

TokenContract service.

Methods

getFtContractDetail(xChainId, ftAddress, callback)

getFtContractDetail Retrieve information for one (1) labeled FT contract.

Parameters:
Name Type Description
xChainId String

Klaytn network chain ID (1001 or 8217)

ftAddress String

FT contract address

callback TokenContractApi~getFtContractDetailCallback

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

getListOfMtContracts(xChainId, opts, callback)

getListOfMtContracts Lists all labeled MT contracts.

## Size

* The size query parameter is optional (minimum = 1, maximum = 1000, default = 100).
* Submitting negative values result in errors.
* Submitting zero results in a query with size=100, which is the default value.
* Submitting values greater than 1000 result in queries with size=1000, which is the maximum value.

Parameters:
Name Type Description
xChainId String

Klaytn network chain ID (1001 or 8217)

opts Object

Optional parameters

Properties
Name Type Description
status String

Labelling status [completed, processing, failed, cancelled]

type String

Contract type [KIP-37, ERC-1155]; return both if not specified

size Number

Number of items to return (min=1, max=1000, default=100)

cursor String

Offset for the next batch of items (pagination)

callback TokenContractApi~getListOfMtContractsCallback

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

getListOfNftContracts(xChainId, opts, callback)

getListOfNftContracts Retrieve information for all labeled NFT contracts.

## Size

* The size query parameter is optional (minimum = 1, maximum = 1000, default = 100).
* Submitting negative values result in errors.
* Submitting zero results in a query with size=100, which is the default value.
* Submitting values greater than 1000 result in queries with size=1000, which is the maximum value.

Parameters:
Name Type Description
xChainId String

Klaytn network chain ID (1001 or 8217)

opts Object

Optional parameters

Properties
Name Type Description
status String

Labeling status [completed, processing, failed, cancelled]

type String

Contract type [KIP-17, ERC-721]. If not set, return all types.

size Number

Maximum number of items to return (min=1, max=1000, default=100)

cursor String

Response offset

callback TokenContractApi~getListOfNftContractsCallback

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

getListofFtContracts(xChainId, opts, callback)

getListofFtContracts Retrieve information for all labeled FT contracts.

## Size

* The size query parameter is optional (minimum = 1, maximum = 1000, default = 100).
* Submitting negative values result in errors.
* Submitting zero results in a query with size=100, which is the default value.
* Submitting values greater than 1000 result in queries with size=1000, which is the maximum value.

Parameters:
Name Type Description
xChainId String

Klaytn network chain ID (1001 or 8217)

opts Object

Optional parameters

Properties
Name Type Description
status String

Labeling status [completed, processing, failed, cancelled]

type String

Contract type [KIP-7, ERC-20]. If not set, return all types.

size Number

Maximum number of items to return (min=1, max=1000, default=100)

cursor String

Response offset

callback TokenContractApi~getListofFtContractsCallback

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

getMtContractDetail(xChainId, mtAddress, callback)

getMtContractDetail Retrieves a labeled MT contract information.

Parameters:
Name Type Description
xChainId String

Klaytn network chain ID (1001 or 8217)

mtAddress String
callback TokenContractApi~getMtContractDetailCallback

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

getNftContractDetail(xChainId, nftAddress, callback)

getNftContractDetail Retrieve information for one (1) labeled NFT contract.

Parameters:
Name Type Description
xChainId String

Klaytn network chain ID (1001 or 8217)

nftAddress String

NFT contract address

callback TokenContractApi~getNftContractDetailCallback

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

Type Definitions

getFtContractDetailCallback(error, data, response)

Callback function to receive the result of the getFtContractDetail operation.

Parameters:
Name Type Description
error String

Error message, if any.

data FtContractDetail

The data returned by the service call.

response String

The complete HTTP response.

getListOfMtContractsCallback(error, data, response)

Callback function to receive the result of the getListOfMtContracts operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableMtContractDetails

The data returned by the service call.

response String

The complete HTTP response.

getListOfNftContractsCallback(error, data, response)

Callback function to receive the result of the getListOfNftContracts operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableNftContractDetails

The data returned by the service call.

response String

The complete HTTP response.

getListofFtContractsCallback(error, data, response)

Callback function to receive the result of the getListofFtContracts operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableFtContractDetails

The data returned by the service call.

response String

The complete HTTP response.

getMtContractDetailCallback(error, data, response)

Callback function to receive the result of the getMtContractDetail operation.

Parameters:
Name Type Description
error String

Error message, if any.

data MtContractDetail

The data returned by the service call.

response String

The complete HTTP response.

getNftContractDetailCallback(error, data, response)

Callback function to receive the result of the getNftContractDetail operation.

Parameters:
Name Type Description
error String

Error message, if any.

data NftContractDetail

The data returned by the service call.

response String

The complete HTTP response.

TokenContractApi

new TokenContractApi(apiClientopt)

Constructs a new TokenContractApi.

Parameters:
Name Type Attributes Description
apiClient ApiClient <optional>

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

Methods

getFtContractDetail(xChainId, ftAddress, callback)

getFtContractDetail Retrieve information for one (1) labeled FT contract.

Parameters:
Name Type Description
xChainId String

Klaytn network chain ID (1001 or 8217)

ftAddress String

FT contract address

callback TokenContractApi~getFtContractDetailCallback

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

getListOfMtContracts(xChainId, opts, callback)

getListOfMtContracts Lists all labeled MT contracts.

## Size

* The size query parameter is optional (minimum = 1, maximum = 1000, default = 100).
* Submitting negative values result in errors.
* Submitting zero results in a query with size=100, which is the default value.
* Submitting values greater than 1000 result in queries with size=1000, which is the maximum value.

Parameters:
Name Type Description
xChainId String

Klaytn network chain ID (1001 or 8217)

opts Object

Optional parameters

Properties
Name Type Description
status String

Labelling status [completed, processing, failed, cancelled]

type String

Contract type [KIP-37, ERC-1155]; return both if not specified

size Number

Number of items to return (min=1, max=1000, default=100)

cursor String

Offset for the next batch of items (pagination)

callback TokenContractApi~getListOfMtContractsCallback

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

getListOfNftContracts(xChainId, opts, callback)

getListOfNftContracts Retrieve information for all labeled NFT contracts.

## Size

* The size query parameter is optional (minimum = 1, maximum = 1000, default = 100).
* Submitting negative values result in errors.
* Submitting zero results in a query with size=100, which is the default value.
* Submitting values greater than 1000 result in queries with size=1000, which is the maximum value.

Parameters:
Name Type Description
xChainId String

Klaytn network chain ID (1001 or 8217)

opts Object

Optional parameters

Properties
Name Type Description
status String

Labeling status [completed, processing, failed, cancelled]

type String

Contract type [KIP-17, ERC-721]. If not set, return all types.

size Number

Maximum number of items to return (min=1, max=1000, default=100)

cursor String

Response offset

callback TokenContractApi~getListOfNftContractsCallback

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

getListofFtContracts(xChainId, opts, callback)

getListofFtContracts Retrieve information for all labeled FT contracts.

## Size

* The size query parameter is optional (minimum = 1, maximum = 1000, default = 100).
* Submitting negative values result in errors.
* Submitting zero results in a query with size=100, which is the default value.
* Submitting values greater than 1000 result in queries with size=1000, which is the maximum value.

Parameters:
Name Type Description
xChainId String

Klaytn network chain ID (1001 or 8217)

opts Object

Optional parameters

Properties
Name Type Description
status String

Labeling status [completed, processing, failed, cancelled]

type String

Contract type [KIP-7, ERC-20]. If not set, return all types.

size Number

Maximum number of items to return (min=1, max=1000, default=100)

cursor String

Response offset

callback TokenContractApi~getListofFtContractsCallback

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

getMtContractDetail(xChainId, mtAddress, callback)

getMtContractDetail Retrieves a labeled MT contract information.

Parameters:
Name Type Description
xChainId String

Klaytn network chain ID (1001 or 8217)

mtAddress String
callback TokenContractApi~getMtContractDetailCallback

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

getNftContractDetail(xChainId, nftAddress, callback)

getNftContractDetail Retrieve information for one (1) labeled NFT contract.

Parameters:
Name Type Description
xChainId String

Klaytn network chain ID (1001 or 8217)

nftAddress String

NFT contract address

callback TokenContractApi~getNftContractDetailCallback

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

Type Definitions

getFtContractDetailCallback(error, data, response)

Callback function to receive the result of the getFtContractDetail operation.

Parameters:
Name Type Description
error String

Error message, if any.

data FtContractDetail

The data returned by the service call.

response String

The complete HTTP response.

getListOfMtContractsCallback(error, data, response)

Callback function to receive the result of the getListOfMtContracts operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableMtContractDetails

The data returned by the service call.

response String

The complete HTTP response.

getListOfNftContractsCallback(error, data, response)

Callback function to receive the result of the getListOfNftContracts operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableNftContractDetails

The data returned by the service call.

response String

The complete HTTP response.

getListofFtContractsCallback(error, data, response)

Callback function to receive the result of the getListofFtContracts operation.

Parameters:
Name Type Description
error String

Error message, if any.

data PageableFtContractDetails

The data returned by the service call.

response String

The complete HTTP response.

getMtContractDetailCallback(error, data, response)

Callback function to receive the result of the getMtContractDetail operation.

Parameters:
Name Type Description
error String

Error message, if any.

data MtContractDetail

The data returned by the service call.

response String

The complete HTTP response.

getNftContractDetailCallback(error, data, response)

Callback function to receive the result of the getNftContractDetail operation.

Parameters:
Name Type Description
error String

Error message, if any.

data NftContractDetail

The data returned by the service call.

response String

The complete HTTP response.