This page introduces how to get FT and NFT contract information with Token History API.
Before Getting Started
API introduced in here should only be used with HTTP Request.
The x-chain-id value for calling the API is 8217 (Cypress) or 1001 (Baobab).
Essential parameters for calling APIs are described in individual examples.
Values that a user needs to enter for calling APIs will be represented with one pair of braces ({}). A user must enter the following values.
Item
Description
Note
chain-id
8217 or 1001
Cypress(Klaytn mainnet) or Baobab(Klaytn testnet
access-key-id
Auth ID
accessKeyId obtained from KAS Console - Security - Credential
secret-access-key
Auth Password
secretAccessKey obtained from KAS Console - Security - Credential
krn
(optional) ID of Account Pool
Unnecessary when using Default Account Pool
A KAS API Authentication Key (API Auth Key) provides access to all KAS services and all the rights to a Klaytn account which was created by calling Wallet API via this API Auth Key. The rights here include accessing and transferring all the assets (KLAY, etc.) of or sending a transaction from a Klaytn account. If you shared your API Auth Key with any unauthorized personnel, your Klaytn account could be compromised and might cause unwanted transaction execution.
DO NOT share your API Auth Key (Secret AccessKey or Authorization) with any unauthorized personnel.
DO PUT efforts necessary to keep your API Auth Key safe for the security of your KAS/Klaytn account.
Get List of FT Contract
Search the list of labeled FT contracts.
FT contract is a type of smart contract deployed to Klaytn that allows users to issue, delete, and send Fungible Token (Fungible Token, FT).
Label is a marker put on a specific token contract by KAS for tracking its information. KAS only tracks labeled token contracts. This API requests for the list of labeled FT contracts. For details about labeling, please visit here.
Query Parameter
You can search for the list of FT contracts by specifying the labeling status and contract type. Also, you can receive API response values with Cursor-based Pagination.
Parameter
Description
Example
Required or Not
status
Labeling status ["completed", "processing", "failed", "cancelled"]
status=completed
False
type
Type of contract (KIP standard: "kip",
ERC standard: "erc", else: "")
type=kip
False
size
the number of items in the API response (min=1, max=1000, default=100)
size=100
False
cursor
the cursor required to get the next batch of response items
cursor=J9Ag...VM6z
False
API Request
Search for the list of labeled FT contracts as follows.
For details about this API, please visit here.
For inquires about this document or KAS, please visit KAS Developer forum.
Get List of NFT Contract
Search the list of labeled NFT contracts.
NFT contract is a type of smart contract deployed to Klaytn that allows users to issue, delete, and send Non-fungible Token (Non-Fungible Token, NFT).
Label is a marker put on a specific token contract by KAS for tracking its information. KAS only tracks labeled token contracts. This API requests for the list of labeled FT contracts. For details about labeling, please visit here.
Query Parameter
You can search for the list of FT contracts by specifying the labeling status and contract type. Also, you can receive API response values with Cursor-based Pagination.
Parameter
Description
Example
Required or Not
status
Labeling Status ["completed", "processing", "failed", "cancelled"]
status=completed
False
type
Type of contract (KIP standard: "kip",
ERC standard: "erc", else: "")
type=kip
False
size
the number of items in the API response (min=1, max=1000, default=100)
size=100
False
cursor
the cursor required to get the next batch of response items
cursor=J9Ag...VM6z
False
API Request
Search the list of labeled NFT contracts as follows.