API Reference

BasicAPIs

Initiate RBT Transfer

To Initiate RBT Transfer, you can use the following API endpoint:

Endpoint: /api/initiate-rbt-transfer

Method: POST

Request format:

{ 

  "comment": "string", 
  "receiver": "string", 
  "sender": "string", 
  "tokenCOunt": 0, 
  "type": 0 

}

comment [String]: Any commment during rbt transfer process.
receiver [String]: Add Reciver's DID.
sender [String]: Add Sender's DID.
tokenCount [int]: Amount of RBT to send.
type [int]: Type of quorum for the transaction.

Model request:

{ 
  "comment": "test transfer", 
  "receiver": "bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi", 
  "sender": "bafybmigxslkovkt3rirvtpvscskor4ys223fjdetkzu3drbrxhp3s7t5ui", 
  "tokenCOunt": 1.0, 
  "type": 2 
} 

curl request:

curl -X 'POST' \
 'http://localhost:21000/api/initiate-rbt-transfer' \
 -H 'accept: application/json' \
 -H 'Content-Type: application/json' \
 -d '{
 "comment": "test transfer",
 "receiver": "bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi",
 "sender": "bafybmigxslkovkt3rirvtpvscskor4ys223fjdetkzu3drbrxhp3s7t5ui",
 "tokenCOunt": 1.0,
 "type": 2
}'

Response:

{
 "status": true,
 "message": "Password needed",
 "result": {
   "id": "62352DFA-4654-45E1-8A31-15BDF9513B52",
   "mode": 4,
   "hash": null,
   "only_priv_key": false
 }
}

NOTE: Use the id in the api/signature-Response with password if created (default password: mypassword).

Final Response

{
  "status": true,
  "message": "Transaction is still processing, with transaction id aee95cdb9db8794b988063e29400198c3fc741f9f461faae8c83d02119e1d9d6",
  "result": "aee95cdb9db8794b988063e29400198c3fc741f9f461faae8c83d02119e1d9d6"
}

Get account Info

To Fetch the account info of a DID, you can use the following API endpoint:

Endpoint: /api/get-acccount-info

Method: GET

Request format:

get account info image

DID [String]: The Decentralized Identifier (DID) of the account for which the account information needs to be retrieved.

curl request:

curl -X 'GET' \ 
  'http://localhost:20800/api/get-account-info?did=bafybmiaflq2dxcg5frq5o5myoqtk6zle65okfnwb6y2tjpav4lsfwgknui' \ 
  -H 'accept: application/json'

Response:

{
  "status": true,
  "message": "Got account info successfully",
  "result": null,
  "account_info": [
    {
      "did": "bafybmiaflq2dxcg5frq5o5myoqtk6zle65okfnwb6y2tjpav4lsfwgknui",
      "did_type": 0,
      "rbt_amount": 2,
      "pledged_rbt": 0,
      "locked_rbt": 0,
      "pinned_rbt": 0
    }
  ]
}

Generate test rbt

To generate test rbt's, you can use the following API endpoint:

Endpoint: /api/generate-test-token

Method: POST

Request format:

{
  "did": "string",
  "number_of_tokens": int
}

did [String]: The DID of the account for which test rbt's needs to generate
number_of_tokens [int]: number of tokens to generate

Model request:

{
    "did":"bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi",
    "number_of_tokens": 2
}

curl request:

curl --location 'http://localhost:20900/api/generate-test-token' \
--header 'Content-Type: application/json' \
--data '{
    "did":"bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi",
    "NumberOfTokens":2
}'

Response:

{
  "status": true,
  "message": "Test tokens generated successfully",
  "result": null
}

DID Management

Create DID

To create a DID, you can use the following API endpoint:

Endpoint: /api/createdid

Method: POST

Request format:

create did image

type[int]: DID type (0=Basic, 1=Standard, 2=Wallet, 3=Child, 4=Light; default: 0).
priv_pwd[string]: Private key password is needed to encrypt the private key file(default: "mypassword").
mnemonic_file[String]:Mnemonic key file (default: "mnemonic.txt").
secret[string]: DID secret (default: "My DID Secret").
quorum_pwd [string]: Quorum key password (default: "mypassword").
img_file [string]: Image file for DID creation (must be 256x256 PNG; default: "image.png").
priv_img_file [string]: Private share image file name (default: "pvtShare.png").
pub_img_file [string]: Public share image file name (default: "pubShare.png").
priv_key_file [string]: Private key file name (default: "pvtKey.pem").
pub_key_file [string]: Public key file name (default: "pubKey.pem").
childPath [int]: BIP Child Path (default: 0).

Response:

{
    "status": true,
    "message": "DID created successfully",
    "result": {
        "did": "bafybmiaiudnmnbpr2kst26tf56vsnsklncucflb6er566twzrk4itryfom",
        "peer_id": "12D3KooWRK3CzoVYGdcMZqPYHJTkdnWZTTZqyAaSgFFETapBmT97"
    }
}

curl request:

curl --location 'http://localhost:20900/api/createdid' \
--form 'did_config="{\"type\": 4, \"priv_pwd\":\"mypassword\"}"'

Get all DID's

To get all DIDs of a node, you can use the following API endpoint:

Endpoint: /api/getalldid

Method: GET

Request format:

Request body will be empty for this API as shown in the following image.

getall did image

curl request:

curl --location 'http://localhost:20900/api/getalldid' \
--data ''

Register DID

To regisster DID, you can use the following API endpoint:

Endpoint: /api/register-did

Method: POST

Request format:

did [String]: The DID of the account which you want to register

Model request:

{
	"did": "bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi"
}

Response:

{
    "status": true,
    "message": "Password needed",
    "result": {
        "id": "B5C0C562-2F60-4BA7-B887-A0FB64FCBFBA",
        "mode": 4,
        "hash": null,
        "only_priv_key": false
    }
}

NOTE: Use the id in the api/signature-Response with password (default password: mypassword).

Final Response:

{
  "status": true,
  "message": "DID registered successfully",
  "result": null
}

curl request:

curl --location 'http://localhost:20900/api/register-did' \
--header 'Content-Type: application/json' \
--data '{
	"did": "bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi"
}'

Smart Contract

Generate smart contract

To generate a smart contract, you can use the following API endpoint:

Endpoint: /api/generate-smart-contract

Method: POST

Request format:

generate smart contract image

did [String]: The DID of the user genarating the Smart contract.
binaryCodePath [File]: The compiled WASM binary file.
rawCodePath [File]: The raw smart contract logic code file (Rust/Go/ file).
schemaFilePath [File]: The JSON file for updating state changes if required.

Model request:

curl request:

curl --location --request POST 'http://localhost:20000/api/generate-smart-contract' 
--form 'did="your_did"' 
--form 'binaryCodePath=@"path_to_binary_code"' 
--form 'rawCodePath=@"path_to_raw_code"' 
--form 'schemaFilePath=@"path_to_schema"'

Response:

{
  "status": true,
  "message": "Smart contract generated successfully",
  "result": "QmW83PT7dKWT5ccBvQvSmkSQJNbWR5hMheQ3n6vckwDFkE"
}

Deploy smart contract

To deploy a smart contract, you can use the following API endpoint:

Endpoint: /api/deploy-smart-contract

Method: POST

Request format:

{
  "comment": "string",
  "deployerAddr": "string",
  "quorumType": 0,
  "rbtAmount": 0,
  "smartContractToken": "string"
}

comment [String]: Any commment during deployment process.
deployerAddr [String]: The DID of the deployer.
quorum_type [Integer]: Type of quorum for the transaction.
- 1: Randomly picked quorums.
- 2: Specified by the deployer.
rbt_amount [Integer]: The amount of native token RBT required for the deployment process, ensure sufficient RBT funds are available.
smartContractToken [String]: The smart contract hash generated during generation process

Model request:

{
  "comment": "deploying first contract",
  "deployerAddr": "bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi",
  "quorumType": 2,
  "rbtAmount": 1,
  "smartContractToken": "QmW83PT7dKWT5ccBvQvSmkSQJNbWR5hMheQ3n6vckwDFkE"
}

curl request:

curl --header "Content-Type: application/json" --request POST 'http://localhost:20000/api/deploy-smart-contract' --data '{ 
  "smartContractToken": "your_token",
  "deployerAddr": "your_address", 
  "rbtAmount": "rbt_amount_for_deployment", 
  "quorumType": "quorum_type", 
  "comment": "your_comment" 
}'

Response:

{
  "status": true,
  "message": "Password needed",
  "result": {
    "id": "823A1C97-736F-482D-B911-79F4B5AC205E",
    "mode": 4,
    "hash": null,
    "only_priv_key": false
  }
}

NOTE: Use the id in the api/signature-Response with password (default password: mypassword).

{
  "status": true,
  "message": "Smart Contract Token Deployed successfully in 2m52.7881096s",
  "result": null
}

Execute smart contract

To execute a smart contract, you can use the following API endpoint:

Endpoint: /api/execute-smart-contract

Method: POST

Request format:

{ 
  "comment": "string", 
  "executorAddr": "string", 
  "quorumType": 0, 
  "smartContractData": "string", 
  "smartContractToken": "string" 
}

comment [String]: Any comment during execution process.
executorAddr [String]: The DID of the executor.
quorum_type [Integer]: Type of quorum for the transaction.
- 1: Randomly picked quorums.
- 2: Specified by the deployer.
smartContractData [String]: The smart contract data to be given as input during execution.
smartContractToken [String]: The smart contract hash generated during generation process.

Model request:

{ 
  "comment": "executing smart contract", 
  "executorAddr": "bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi", 
  "quorumType": 2, 
  "smartContractData": "Red", 
  "smartContractToken": "QmW83PT7dKWT5ccBvQvSmkSQJNbWR5hMheQ3n6vckwDFkE" 
}

curl request:

curl -X 'POST' \ 
  'http://localhost:20900/api/execute-smart-contract' \ 
  -H 'accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -d '{ 
  "comment": "executing smart contract", 
  "executorAddr": "bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi", 
  "quorumType": 2, 
  "smartContractData": "Red", 
  "smartContractToken": "QmW83PT7dKWT5ccBvQvSmkSQJNbWR5hMheQ3n6vckwDFkE" 
}'

Response:

{ "status": true,
  "message": "Password needed",
  "result": { 
    "id": "C22411FC-962D-4221-A89A-227EDB07E2E6",
    "mode": 4,
    "hash": null,
    "only_priv_key": false 
  } 
}

NOTE: Use the id in the api/signature-Response with password if created (default password: mypassword).

{ 
  "status": true, 
  "message": "Smart Contract Token Executed successfully in 50.188983855s", 
  "result": null 
}

Get Smart contract token chain data

To get the full smart contract token chain data, you can use the following API endpoint:

Endpoint: /api/get-smart-contract-token-chain-data

Method: POST

Request format:

{ 
  "latest": true, 
  "token": "string" 
}

latest [String]: Indicates whether need only latest block. (For chain give as false)
token [String]: Smart contract token hash.

Model request:

{ 
  "latest": true, 
  "token": "QmW83PT7dKWT5ccBvQvSmkSQJNbWR5hMheQ3n6vckwDFkE" 
}

curl request:

curl -X 'POST' \ 
  'http://localhost:20900/api/get-smart-contract-token-chain-data' \ 
  -H 'accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -d '{ 
  "latest": true, 
  "token": "QmW83PT7dKWT5ccBvQvSmkSQJNbWR5hMheQ3n6vckwDFkE" 
}'

Response:

{ 
  "status": true, 
  "message": "Fetched latest block smart contract data", 
  "result": null, 
  "SCTDataReply": [ 
    { 
      "BlockNo": 1, 
      "BlockId": "1-96df30c70c5873e3751c593f35ec23e702339e6c721d42b7181adb8653dab21d", 
      "SmartContractData": "Red", 
      "Epoch": 1756375523, 
      "InitiatorSignature": "3044022032786c4333d85492ac334f85ac597a67bf468bd20a40f01ba8febdd0aa30f0d1022010851bf1ff50f8b0db6f6cf11f543de27cf97aa8058551327a0e05db1b9bb4ea", 
      "ExecutorDID": "bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi", 
      "InitiatorSignData": "48c36408b85a59525095b95ccb2b0241a33f192a53642d740419fb16f3acd842" 
    } 
  ] 
}

Register callback URL

Endpoint: /api/register-callback-url

Method: POST

Request format:

{ 
  "CallBackURL": "string", 
  "SmartContractToken": "string" 
}

Model request:

{ 
  "CallBackURL": "http://localhost:8080/api/contract-input", 
  "SmartContractToken": "QmW83PT7dKWT5ccBvQvSmkSQJNbWR5hMheQ3n6vckwDFkE" 
}

curl request:

curl -X 'POST' \ 
  'http://localhost:20900/api/register-callback-url' \ 
  -H 'accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -d '{ 
  "CallBackURL": "http://localhost:8080/api/contract-input", 
  "SmartContractToken": "QmW83PT7dKWT5ccBvQvSmkSQJNbWR5hMheQ3n6vckwDFkE" 
}'

Response:

{ 
  "status": true, 
  "message": "Call back URL registered successfully", 
  "result": null 
}

Fetch smart contract files

To fetch all files related to a smart contract

Endpoint: /api/fetch-smart-contract

Method: GET

Give the smart contract token hash as the value for the smartContractToken query parameter.

curl request:

curl -X 'GET' \ 
  'http://localhost:20900/api/fetch-smart-contract?smartContractToken=QmW83PT7dKWT5ccBvQvSmkSQJNbWR5hMheQ3n6vckwDFkE'\
  -H 'accept: application/json'

Response:

{ 
  "status": true, 
  "message": "Smart Contract fetched successfully", 
  "result": null 
}

A folder will be created with all the files related to the smart contract

FT

Creation of FTs

To create an FT, you can use the following API endpoint:

Endpoint: api/create-ft

Method: POST

Request format:

{
  "did": "string",
  "ft_count": 0,
  "ft_name": "string",
  "token_count": 0
}

did [String]: The DID of the user creating the FTs.
ft_count [Integer]: The total supply of FTs to be created.
ft_name [String]: The name/symbol of the FT being created.
token_count [Integer]: The amount of native token RBT required for the creation process, ensure sufficient RBT funds are available.

Model request:

{
  "did": "bafybmidhjebpnarqite2pf7akpb333svhdkhnyucalxv3aelg3c6iq6aom",
  "ft_count": 100,
  "ft_name": "apple",
  "token_count": 1
}

Model curl request:

curl --location 'localhost:20000/api/create-ft' \
--header 'Content-Type: application/json' \
--data '{
  "did": "bafybmidhjebpnarqite2pf7akpb333svhdkhnyucalxv3aelg3c6iq6aom",
  "ft_count": 100,
  "ft_name": "apple",
  "token_count": 1
}'

Response

{
  "message": "string",
  "result": "string",
  "status": true
}

Transfer of FTs

To transfer an FT from one DID to another, you can use:

Endpoint: /api/initiate-ft-transfer

Method: POST

Request format:

{
  "comment": "string",
  "creatorDID": "string",
  "ft_count": 0,
  "ft_name": "string",
  "password": "string",
  "quorum_type": 0,
  "receiver": "string",
  "sender": "string"
}

ft_count [Integer]: Total number of FTs to be transferred.
ft_name [String]: Name/symbol of the FT being transferred.
comment [String]: Optional message regarding the transfer.
password [String]: Password to authorize the transfer (default “ ”).
receiver [String]: Address of the recipient receiving the FT.
sender [String]: Address of the user initiating the transfer.
quorum_type [Integer]: Type of quorum for the transaction.
- 1: Randomly picked quorums.
- 2: Specified by the sender.
creatorDID [String]: Defines the creator of an FT.

Model request:

{
  "comment": "",
  "creatorDID": "",
  "ft_count": 8,
  "ft_name": "ARR",
  "password": "",
  "quorum_type": 2,
  "receiver": "bafybmicdvgacsdsscn63eaq3faqdtimros23b4j7bpj2m2wsmjjaxoj47i",
  "sender": "bafybmig7cmpfdcxqbvn3wutczeby2a6o46cnfzmcyoy6imgbnt7qzfwxp4"
}

Model curl request:

curl --location 'localhost:20051/api/initiate-ft-transfer' \
--header 'Content-Type: application/json' \
--data '{
  "comment": "",
  "creatorDID": "",
  "ft_count": 3,
  "ft_name": "ARR",
  "password": "",
  "quorum_type": 2,
  "receiver": "bafybmicdvgacsdsscn63eaq3faqdtimros23b4j7bpj2m2wsmjjaxoj47i",
  "sender": "bafybmig7cmpfdcxqbvn3wutczeby2a6o46cnfzmcyoy6imgbnt7qzfwxp4"
}'

Response

{
  "message": "string",
  "result": "string",
  "status": true
}

NOTES:

password is mandatory when you have a password created during the creation of DID.
creatorDID is mandatory when you have multiple FTs with the same FT Name.
Default port: 20000. Adjust if needed.

Preview of FT Token chain

Provide the FT token ID as the value for the tokenID query parameter.

Endpoint: /api/get-ft-token-chain

Method: GET

Model curl request:

curl --location 'localhost:20000/api/get-ft-token-chain?tokenID=QmWxBMRbW2uyD27Czm5Bor49hnjvyRHMd1sEHTk8UGbe7i'

Response

{
  "message": "string",
  "result": "string",
  "status": true,
  "tokenChainData": [
    "string"
  ]
}

Get FT's Balance

Provide the user DID as the value for the did query parameter.

Endpoint: /api/get-ft-info-by-did

Method: GET

Model curl request:

curl --location 'localhost:20000/api/get-ft-info-by-did?did=bafybmidhjebpnarqite2pf7akpb333svhdkhnyucalxv3aelg3c6iq6aom'

Response

{
  "ft_info": [
    {
      "creator_did": "string",
      "ft_count": 0,
      "ft_name": "string"
    }
  ],
  "message": "string",
  "result": "string",
  "status": true
}

NFT

Generation of NFT

To Generate an NFT, you can use the following API endpoint

Endpoint: /api/create-nft

Method: POST

Request format:

image of NFT creation request

curl request:

curl -X 'POST' \
  'http://localhost:20900/api/create-nft' \ 
  -H 'accept: multipart/form-data' \ 
  -H 'Content-Type: multipart/form-data' \ 
  -F 'did=bafybmiaflq2dxcg5frq5o5myoqtk6zle65okfnwb6y2tjpav4lsfwgknui' \ 
  -F 'metadata=@632498430230723.json;type=application/json' \ 
  -F 'artifact=@20250730_114411.jpg;type=image/jpeg' 

Response:

{ 
  "status": true, 
  "message": "NFT Token generated successfully", 
  "result": "QmRjtbUxw8yh1DN2JjzDqm3wuedVECv5B3jDUzWq9QUEK1" 
} 

Deployment of NFT

To deploy an NFT, you can use the following endpoint:

Endpoint: /api/deploy-nft

Method: POST

Request format:

{ 
  "did": "string", 
  "nft": "string", 
  "nft_data": "string", 
  "nft_file_name": "string", 
  "nft_metadata": "string", 
  "nft_value": 0, 
  "quorum_type": 0 
} 

did [String]: DID of the deployer of NFT
nft [String]: NFT token ID
nft_data [String]: Arbitary data for the NFT during deployment
nft_file_name [String]: File name of the actual NFT
nft_metadata [String]: Metadata of the NFT data
nft_value [Integer]: Value of the NFT during deployment
quorum_type [Integer]: Type of quorum for the NFT deployment.
- 1: Randomly picked quorums.
- 2: Specified by the sender.

Model request:

{ 
  "did": "bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi", 
  "nft": "QmRjtbUxw8yh1DN2JjzDqm3wuedVECv5B3jDUzWq9QUEK1", 
  "nft_data": "test nft", 
  "nft_file_name": "20250730_114411.jpg", 
  "nft_metadata": "", 
  "nft_value": 1, 
  "quorum_type": 2 
}

curl request:

curl -X 'POST'  
'http://localhost:20900/api/deploy-nft'  
-H 'accept: application/json'  
-H 'Content-Type: application/json'  
-d '{ 
  "did": "bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi", 
  "nft": "QmRjtbUxw8yh1DN2JjzDqm3wuedVECv5B3jDUzWq9QUEK1", 
  "nft_data": "test nft", 
  "nft_file_name": "20250730_114411.jpg", 
  "nft_metadata": "", 
  "nft_value": 1, 
  "quorum_type": 2 
}'

Response:

{
  "status": true,
  "message": "Password needed",
  "result": {
    "id": "823A1C97-736F-482D-B911-79F4B5AC205E",
    "mode": 4,
    "hash": null,
    "only_priv_key": false
  }
}

NOTE: Use the id in the api/signature-Response with password if created (default password: mypassword).

{
  "status": true,
  "message": "NFT Deployed successfully in 53.368924154s with trnxid 7eec78f9f16f5b6ebc6757f9d21af0c000c53f1d6e6254897a2d71832e8c2260",
  "result": null
}

Execution/Tranfer of NFT

For transferring an NFT, use the following API endpoint:

Endpoint: /api/execute-nft

Method: POST

Request format:

{ 
  "comment": "string", 
  "executor": "string", 
  "nft": "string", 
  "nft_data": "string", 
  "nft_value": 0, 
  "quorum_type": 0, 
  "receiver": "string" 
}

comment [String]: Any comment during execution process.
executor [String]: DID of the executor of the NFT
nft [String]: NFT token ID
nft_data [String]: Arbitary data for the NFT during deployment
nft_value [Integer]: Value of the NFT during deployment
quorum_type [Integer]: Type of quorum for the NFT deployment.
- 1: Randomly picked quorums.
- 2: Specified by the sender.
receiver [String]: DID of the receiver of the NFT.

Model request:

{ 
  "comment": "testing execute", 
  "executor": "bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi", 
  "nft": "QmRjtbUxw8yh1DN2JjzDqm3wuedVECv5B3jDUzWq9QUEK1", 
  "nft_data": "test nft", 
  "nft_value": 1, 
  "quorum_type": 2, 
  "receiver": "bafybmiaflq2dxcg5frq5o5myoqtk6zle65okfnwb6y2tjpav4lsfwgknui" 
}

curl request:

curl -X 'POST' \ 
  'http://localhost:20900/api/execute-nft' \ 
  -H 'accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -d '{ 
  "comment": "testing execute", 
  "executor": "bafybmicggfkxfz667vnra3datk5h3y5el24ir7gx7tciciaaoniaxnadwi", 
  "nft": "QmRjtbUxw8yh1DN2JjzDqm3wuedVECv5B3jDUzWq9QUEK1", 
  "nft_data": "test nft", 
  "nft_value": 1, 
  "quorum_type": 2, 
  "receiver": "bafybmiaflq2dxcg5frq5o5myoqtk6zle65okfnwb6y2tjpav4lsfwgknui" 
}'

Response:

{ "status": true, 
  "message": "Password needed", 
  "result": { 
    "id": "85EDB8E8-FD06-4E12-816F-86C6A195F821", 
    "mode": 4, 
    "hash": null, 
    "only_priv_key": false 
  } 
}

NOTE: Use the id in the api/signature-Response with password if created (default password: mypassword).

{ 
  "status": true, 
  "message": "NFT Executed successfully in 1m2.131491535s", 
  "result": null 
}

Fetch NFT

For Fetching NFT details, use the following API endpoint

Endpoint: api/fetch-nft

Method: GET

Give the NFT ID as the value for the nft query parameter.

curl request:

curl -X 'GET' \
  'http://localhost:21000/api/fetch-nft?nft=QmRjtbUxw8yh1DN2JjzDqm3wuedVECv5B3jDUzWq9QUEK1' \ 
  -H 'accept: application/json'

Response:

{ 
  "status": true, 
  "message": "NFT fetched successfully", 
  "result": null 
}

Getting NFT token chain Data

For getting an NFT token chain data, you can use the following API endpoint

Endpoint: /api/get-nft-token-chain-data

Method: GET

There are two query parameters for this API:

nft[String]: NFT token ID
latest[Boolean]:
- Use true for getting latest block
- Use false for getting entire token chain

curl request:

curl -X 'GET' \ 
  'http://localhost:20800/api/get-nft-token-chain-data?nft=QmUPAe9qQFe6n8RtoB467bDvGZUhUEWd1xbdXqTq25RNuC&latest=true' \ 
  -H 'accept: application/json'

Response:

{ 
  "status": true, 
  "message": "Fetched NFT data", 
  "result": null, 
  "NFTDataReply": [ 
    { 
      "BlockNo": 1, 
      "BlockId": "1-4baef7c5c0448bc45dd4935f3684503d0c5b8ec2090eff2c88e231e1bda399fb", 
      "NFTData": "test nft", 
      "NFTOwner": "bafybmiaflq2dxcg5frq5o5myoqtk6zle65okfnwb6y2tjpav4lsfwgknui", 
      "NFTValue": 1, 
      "Epoch": 1756457355, 
      "TransactionID": "089b31686a01e8d8479a141546ea6da80a9053e8636ec3ec5d9c7efb135110fe" 
    } 
  ] 
}

Subscribing for an NFT

For subscribing for getting updates of an NFT, you can use the following API endpoint:

Endpoint: /api/subscribe-nft

Method: POST

Request format:

{ 
  "nft": "string" 
}

nft[String]: NFT Token ID

Model request:

{ 
  "nft": "QmRjtbUxw8yh1DN2JjzDqm3wuedVECv5B3jDUzWq9QUEK1" 
}

curl request:

curl -X 'POST' \ 
  'http://localhost:20900/api/subscribe-nft' \ 
  -H 'accept: application/json' \ 
  -H 'Content-Type: application/json' \ 
  -d '{ 
  "nft": "QmRjtbUxw8yh1DN2JjzDqm3wuedVECv5B3jDUzWq9QUEK1" 
}'

Response:

{ 
  "status": true, 
  "message": "NFT subscribed successfully", 
  "result": null 
}

BasicAPIs​

Initiate RBT Transfer​

Get account Info​

Generate test rbt​

DID Management​

Create DID​

Get all DID's​

Register DID​

Smart Contract​

Generate smart contract​

Deploy smart contract​

Execute smart contract​

Get Smart contract token chain data​

Register callback URL​

Fetch smart contract files​

FT​

Creation of FTs​

Transfer of FTs​

Preview of FT Token chain​

Get FT's Balance​

NFT​

Generation of NFT​

Deployment of NFT​

Execution/Tranfer of NFT​

Fetch NFT​

Getting NFT token chain Data​

Subscribing for an NFT​

BasicAPIs

Initiate RBT Transfer

Get account Info

Generate test rbt

DID Management

Create DID

Get all DID's

Register DID

Smart Contract

Generate smart contract

Deploy smart contract

Execute smart contract

Get Smart contract token chain data

Register callback URL

Fetch smart contract files

FT

Creation of FTs

Transfer of FTs

Preview of FT Token chain

Get FT's Balance

NFT

Generation of NFT

Deployment of NFT

Execution/Tranfer of NFT

Fetch NFT

Getting NFT token chain Data

Subscribing for an NFT