Restful APIs Documentation

This documentation covers the Restful APIs available in the Smart Node system. The APIs are organized into several main categories.

Smart Node Management#health--metricsIPFS OperationsValidator OperationsAuthentication ServicesHashgraph Consensus Service (HCS) OperationsHashgraph HCS RESTful OperationsHashgraph HTS (Token Service) OperationsHashgraph HTS RESTful OperationsHashgraph Accounts

Smart Node Management

Get SmartNetwork.Operator.Entity identifier

Returns the SmartNetwork.Operator.Entity identifier details

get

/smart-node/identifier

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/smart-node/identifier'

200

400

404

200

{
  "accountId": "0.0.1234567",
  "publicKey": "302a300506032b6570032100a6e3161d0db8e3c629e4d1d2a3a4e4b6e1f1c1d8c7b5b4a3c2d1f0e9d8c7b5",
  "url": "https://operator.smartnetwork.com",
  "nft": {
    "id": "0.0.123456",
    "serialNumber": 1,
    "name": "Premium Operator",
    "description": "High-capacity network operator",
    "attributes": {
      "tier": "premium",
      "region": "us-east",
      "permissions": [
        "read",
        "write",
        "execute"
      ]
    }
  }
}

Returns SmartNetwork.Operator.Entity

Get SmartNetwork.SmartNode.State status

Returns the SmartNetwork.SmartNode.State details

get

/smart-node/status

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/smart-node/status'

200

400

404

200

{
  "node": {
    "status": "active",
    "lastSeen": "2023-12-01T10:00:00Z",
    "metrics": {
      "cpu": "45%",
      "memory": "60%",
      "network": "120Mbps"
    }
  },
  "ipfs": {
    "connected": true,
    "peers": 25,
    "storage": {
      "pinned": 1500,
      "available": "2TB"
    }
  }
}

Returns SmartNetwork.SmartNode.State

Get array of SmartNetwork.Network.Entity nodes

Returns array of SmartNetwork.Network.Entity whitelisted nodes

get

/smart-node/network

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/smart-node/network'

200

400

404

200

[
  {
    "type": "operator",
    "dkgId": "dkg123456",
    "clusters": [
      {
        "id": "cluster1",
        "name": "Primary Cluster",
        "nodes": [
          "node1",
          "node2"
        ]
      }
    ],
    "membership": {
      "walletId": "0x1234567890abcdef",
      "status": "ACTIVE",
      "operator": {
        "id": "op123",
        "name": "MainOperator"
      },
      "details": {
        "metadata": {
          "name": "Premium Operator",
          "description": "High-performance network operator"
        }
      }
    }
  }
]

Returns array of SmartNetwork.Network.Entity

Get array of SmartNetwork.Network.Utility tokens

Returns array of SmartNetwork.Network.Utility token details

get

/smart-node/utilities

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/smart-node/utilities'

200

400

404

200

[
  {
    "name": "GovernanceToken",
    "id": "0x1234567890abcdef",
    "treasury": "0xabcdef1234567890",
    "decimals": "18"
  }
]

Returns array of SmartNetwork.Network.Utility

Health & Metrics

GET /health/check - Perform system health check

get

/health/check

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/health/check'

200

400

503

200

{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}

The Health Check is successful

GET /health/infos - Retrieve detailed system health metrics

get

/health/infos

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/health/infos'

200

400

200

{
  "platform": "text",
  "release": "text",
  "machine": "text",
  "arch": "text",
  "uptime": 1,
  "cpu": {
    "usage": 1,
    "cpus": 1,
    "speed": 1
  },
  "memory": {
    "totalMemMb": 1,
    "usedMemMb": 1,
    "freeMemMb": 1,
    "usedMemPercentage": 1,
    "freeMemPercentage": 1
  },
  "drive": {
    "totalGb": "text",
    "usedGb": "text",
    "freeGb": "text",
    "usedPercentage": "text",
    "freePercentage": "text"
  },
  "network": {
    "inputBytes": 1,
    "outputBytes": 1
  }
}

HealthInfos - Contains detailed metrics about CPU, memory, disk and network usage

IPFS Operations

IPFS.Pin.Content

post

/ipfs/pin/{cid}

Path parameters

cidstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/ipfs/pin/{cid}'

200

400

401

200

No body

IPFS.Pin.Content.Success

IPFS.Unpin.Content

delete

/ipfs/unpin/{cid}

Path parameters

cidstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/ipfs/unpin/{cid}'

200

400

401

403

200

No body

IPFS.Unpin.Content.Success

IPFS.Upload.File

post

/ipfs/upload

Body

filestring · binary

File to upload (max 100MB)

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/ipfs/upload' \
  --header 'Content-Type: multipart/form-data'

201

400

401

201

No body

IPFS.Upload.File.Success

Validator Operations

Validators.Consensus.Add

Validators.Consensus.Add.Description

post

/validators/consensus

Body

smartNodeSecuritystring · enum

Level of Smart Node security for the token's keys

Example: partial

Options: none, partial, full

tokenGatesall ofrequired

The token gating configuration for both fungible and non-fungible tokens.

Example: {"fungibleTokens":[],"nonFungibleTokens":[]}

actionConditionsall ofrequired

The conditions for the actions property.

Example: {"create":[],"update":[],"delete":[]}

updateConditionsall ofrequired

The conditions for updatable fields in the consensus topic.

customInterfaceall of

The custom parameters for the consensus topic.

Example: {"conditions":[],"parameters":{}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/validators/consensus' \
  --header 'Content-Type: application/json' \
  --data '{"smartNodeSecurity":"partial","tokenGates":{"fungibleTokens":[],"nonFungibleTokens":[]},"actionConditions":{"create":[],"update":[],"delete":[]},"updateConditions":{},"customInterface":{"conditions":[],"parameters":{}}}'

200

400

200

text

Validators.Consensus.Add.Response.Success

Validators.Consensus.Read

Validators.Consensus.Read.Description

get

/validators/consensus/{timestamp}

Path parameters

timestampstringrequired

Validators.Consensus.Read.Param.Timestamp.Description

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/validators/consensus/{timestamp}'

200

400

200

{
  "smartNodeSecurity": "partial",
  "tokenGates": {
    "fungibleTokens": [],
    "nonFungibleTokens": []
  },
  "actionConditions": {
    "create": [],
    "update": [],
    "delete": []
  },
  "updateConditions": {},
  "customInterface": {
    "conditions": [],
    "parameters": {}
  }
}

Validators.Consensus.Read.Response.Success

Validators.Token.Add

Validators.Token.Add.Description

post

/validators/tokens

Body

smartNodeSecuritystring · enumrequired

Level of Smart Node security for the token's keys

Example: partial

Options: none, partial, full

updateConditionsall ofrequired

Conditions for the updatable property of the token.

Example: {"values":["condition1","condition2"],"controller":{"type":"standard"}}

actionsConditionsall ofrequired

Conditions for the actions property.

Example: {"values":["action1","action2"],"controller":{"type":"advanced"}}

feesConditionsall ofrequired

Conditions for the fees property.

Example: {"values":["fee1","fee2"],"controller":{"type":"basic"}}

keysConditionsall ofrequired

Conditions for the keys property.

Example: {"values":["key1","key2"],"controller":{"type":"secure"}}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/validators/tokens' \
  --header 'Content-Type: application/json' \
  --data '{"smartNodeSecurity":"partial","updateConditions":{"values":["condition1","condition2"],"controller":{"type":"standard"}},"actionsConditions":{"values":["action1","action2"],"controller":{"type":"advanced"}},"feesConditions":{"values":["fee1","fee2"],"controller":{"type":"basic"}},"keysConditions":{"values":["key1","key2"],"controller":{"type":"secure"}}}'

200

400

200

text

Validators.Token.Add.Response.Success

Validators.Token.Read

Validators.Token.Read.Description

get

/validators/tokens/{timestamp}

Path parameters

timestampstringrequired

Validators.Token.Read.Param.Timestamp.Description

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/validators/tokens/{timestamp}'

200

400

200

{
  "smartNodeSecurity": "partial",
  "updateConditions": {
    "values": [
      "condition1",
      "condition2"
    ],
    "controller": {
      "type": "standard"
    }
  },
  "actionsConditions": {
    "values": [
      "action1",
      "action2"
    ],
    "controller": {
      "type": "advanced"
    }
  },
  "feesConditions": {
    "values": [
      "fee1",
      "fee2"
    ],
    "controller": {
      "type": "basic"
    }
  },
  "keysConditions": {
    "values": [
      "key1",
      "key2"
    ],
    "controller": {
      "type": "secure"
    }
  }
}

Validators.Token.Read.Response.Success

Validators.Account.Add

Validators.Account.Add.Description

post

/validators/accounts

Body

smartNodeSecuritystring · enumrequired

Level of Smart Node security for the account's keys

Example: partial

Options: none, partial, full

updateConditionsall ofrequired

Conditions for the updatable property.

Example: {"fields":["key","maxTokenAssociations"],"conditions":[]}

actionConditionsall ofrequired

Conditions for the Actions property.

Example: {"actions":["transfer","delete"],"conditions":[]}

tokenGatesall ofrequired

Token gating configuration for both fungible and non-fungible tokens.

Example: {"fungible":[],"nonFungible":[]}

swapConditionsall ofrequired

Swap conditions.

Example: {"prices":[]}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/validators/accounts' \
  --header 'Content-Type: application/json' \
  --data '{"smartNodeSecurity":"partial","updateConditions":{"fields":["key","maxTokenAssociations"],"conditions":[]},"actionConditions":{"actions":["transfer","delete"],"conditions":[]},"tokenGates":{"fungible":[],"nonFungible":[]},"swapConditions":{"prices":[]}}'

200

400

200

text

Validators.Account.Add.Response.Success

Validators.Account.Read

Validators.Account.Read.Description

get

/validators/accounts/{timestamp}

Path parameters

timestampstringrequired

Validators.Account.Read.Param.Timestamp.Description

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/validators/accounts/{timestamp}'

200

400

200

{
  "smartNodeSecurity": "partial",
  "updateConditions": {
    "fields": [
      "key",
      "maxTokenAssociations"
    ],
    "conditions": []
  },
  "actionConditions": {
    "actions": [
      "transfer",
      "delete"
    ],
    "conditions": []
  },
  "tokenGates": {
    "fungible": [],
    "nonFungible": []
  },
  "swapConditions": {
    "prices": []
  }
}

Validators.Account.Read.Response.Success

Authentication Services

Get authenticated user profile from session

Returns the profile of the authenticated user from their active session. Requires valid authentication.

get

/auth/profile

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/auth/profile'

200

400

404

200

{
  "email": "[email protected]",
  "username": "johndoe",
  "created_at": 1634567890,
  "updated_at": 1634567890,
  "confirmed": true,
  "type": "standard",
  "role": "user",
  "banned": false,
  "tags": [
    "premium",
    "beta"
  ],
  "twoFactorAuth": {
    "factorSid": "YF1234567890abcdef1234567890abcdef",
    "identity": "[email protected]",
    "qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgA...",
    "status": "PENDING"
  }
}

Returns the user's safe profile data

trigger a request to be signed offline with your web3 wallet.

This endpoint will return a payload to be signed offline with your web3 wallet. The signed payload will then be sent to the login endpoint to authenticate the user.

get

/auth/web3/request

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/auth/web3/request'

200

400

404

200

{
  "signedData": {
    "serverSigningAccount": "0x1234567890abcdef",
    "signature": {
      "0": 1,
      "1": 2,
      "2": 3,
      "3": 4,
      "4": 5
    }
  },
  "payload": {
    "url": "https://example.com/auth",
    "node": "node-1",
    "data": {
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    }
  }
}

Returns a Web3AuthRequestDto.

create a user session from a web3 signed payload.

This endpoint will create a user session from a web3 signed payload. The payload must be signed offline with your web3 wallet.

post

/auth/web3/login

Body

operatorobjectrequired

The operator information for the login request

signedDataall ofrequired

The signed data for the login request

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/auth/web3/login' \
  --header 'Content-Type: application/json' \
  --data '{"operator":{},"signedData":{"serverSigningAccount":"0x1234567890abcdef","signature":{"0":1,"1":2,"2":3,"3":4,"4":5}}}'

200

400

404

200

{
  "operator": {},
  "signedData": {
    "serverSigningAccount": "0x1234567890abcdef",
    "signature": {
      "0": 1,
      "1": 2,
      "2": 3,
      "3": 4,
      "4": 5
    }
  }
}

Returns a Auth.Credentials.Web3.Request.Signin.Login.

allow a user to logout and destroy the session.

This endpoint will destroy the session and the user will be logged out. This endpoint is protected and requires authentication.

get

/auth/web3/logout

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/auth/web3/logout'

200

400

404

200

{
  "logout": true,
  "message": "Logout successful"
}

Returns a CredentialsLogoutResponse.

Hashgraph Consensus Service (HCS) Operations

Hashgraph.Ledger.HCS.Topic.Create

Creates a new Hashgraph.Ledger.HCS.Topic

post

/hcs

Body

keyobject

The key for the topic. Can be a single PublicKey or a KeyList.

memostring

Optional memo or description for the topic

validatorConsensusTimestampstring

The consensus timestamp for the validator.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/hcs' \
  --header 'Content-Type: application/json' \
  --data '{"key":{}}'

200

400

404

200

{}

Returns Uint8Array transaction bytes

Hashgraph.Ledger.HCS.Topic.Update

Updates an existing Hashgraph.Ledger.HCS.Topic

put

/hcs/{topic}

Path parameters

topicstringrequired

Hashgraph.Ledger.HCS.Topic ID

Body

memostringrequired

A short description or note about the topic update

Example: Updated topic description

senderobject

Configuration for the topic sender

daoobject

Configuration settings for the DAO

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/hcs/{topic}' \
  --header 'Content-Type: application/json' \
  --data '{"memo":"Updated topic description","sender":{},"dao":{}}'

200

400

404

200

{}

Returns Uint8Array transaction bytes

Hashgraph.Ledger.HCS.Topic.Delete

Deletes an existing Hashgraph.Ledger.HCS.Topic

delete

/hcs/{topic}

Path parameters

topicstringrequired

Hashgraph.Ledger.HCS.Topic ID

Body

daoobject

Configuration settings for the DAO associated with this topic

senderobject

Configuration for the topic's sender

Example: {"key":"PublicKey or KeyList object","id":"AccountId object"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/hcs/{topic}' \
  --header 'Content-Type: application/json' \
  --data '{"dao":{},"sender":{"key":"PublicKey or KeyList object","id":"AccountId object"}}'

200

400

404

200

{}

Returns Uint8Array transaction bytes

Hashgraph.Ledger.HCS.Topic.Info

Gets information about a Hashgraph.Ledger.HCS.Topic

get

/hcs/{topic}

Path parameters

topicstringrequired

Hashgraph.Ledger.HCS.Topic ID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/hcs/{topic}'

200

400

404

200

{
  "topicId": "text",
  "topicMemo": "text",
  "sequenceNumber": "text",
  "expirationTime": "text",
  "autoRenewAccountId": "text",
  "ledgerId": "text",
  "adminKey": [
    "text"
  ],
  "submitKey": [
    "text"
  ]
}

Returns Hashgraph.Ledger.HCS.Topic.Info

Hashgraph.Ledger.HCS.Topic.Message.Submit

Submits a Hashgraph.Ledger.HCS.Topic.Message

post

/hcs/{topic}/message

Path parameters

topicstringrequired

Hashgraph.Ledger.HCS.Topic ID

Body

messagestringrequired

The content of the message to be submitted to the Hashgraph Consensus Service topic

senderobject

Configuration for the topic sender

daoobject

Configuration settings for the DAO

signatureall ofrequired

The signature of the message to be submitted to the Hashgraph Consensus Service topic

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/hcs/{topic}/message' \
  --header 'Content-Type: application/json' \
  --data '{"message":"text","sender":{},"dao":{},"signature":{}}'

200

400

404

200

{}

Returns Uint8Array transaction bytes

Hashgraph.Ledger.HCS.Topic.Message.Info

Gets messages from a Hashgraph.Ledger.HCS.Topic

get

/hcs/{topic}/messages

Path parameters

topicstringrequired

Hashgraph.Ledger.HCS.Topic ID

Query parameters

callbackSuccessfunctionrequired

Callback for successful message retrieval

startnumberrequired

Start sequence number for message retrieval

endnumberrequired

End sequence number for message retrieval

limitnumberrequired

Maximum number of messages to retrieve

callbackErrorfunctionrequired

Callback for message retrieval error

callbackSuccessfunctionrequired

Callback for successful message retrieval

startnumberrequired

Start sequence number for message retrieval

endnumberrequired

End sequence number for message retrieval

limitnumberrequired

Maximum number of messages to retrieve

callbackErrorfunctionrequired

Callback for message retrieval error

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/hcs/{topic}/messages?callbackSuccess=null&start=1&end=1&limit=1&callbackError=null&callbackSuccess=null&start=1&end=1&limit=1&callbackError=null'

200

400

404

200

{}

Returns SubscriptionHandle for message stream

Hashgraph HCS RESTful Operations

Hashgraph HTS (Token Service) Operations

Hashgraph.Ledger.HTS.Create

Creates a new Hashgraph.Ledger.HTS token

post

/hts/create/token

Body

namestringrequired

The name of the token

Example: My Token

treasuryAccountIdstring

The account ID that will act as the treasury for the token

Example: 0.0.12345

symbolstringrequired

The symbol of the token

Example: MTK

decimalsnumber · max: 18required

The number of decimal places a token is divisible by

Example: 8

initialSupplynumber

The initial supply of tokens to be put in circulation

Example: 1000000

maxSupplynumber

The maximum number of tokens that can be in circulation

Example: 10000000

maxTransactionFeenumberrequired

The maximum transaction fee the client is willing to pay

Example: 1000000

freezeKeyboolean

Whether to include a freeze key

Example: true

pauseKeyboolean

Whether to include a pause key

Example: true

adminKeyboolean

Whether to include an admin key

Example: true

kycKeyboolean

Whether to include a KYC key

Example: true

wipeKeyboolean

Whether to include a wipe key

Example: true

supplyKeyboolean

Whether to include a supply key

Example: true

feeScheduleKeyboolean

Whether to include a fee schedule key

Example: true

freezeDefaultbooleanrequired

Whether accounts should be frozen by default when they receive the token

Example: false

validatorConsensusTimestampstringrequired

The validator consensus timestamp

Example: 1718800000000000

memostring

The memo for the token

Example: My Token

daoobject

Optional DAO configuration for the token creation

Example: {"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}

supplyTypeall ofrequired

The supply type of the token

Example: {"_code":1}

tokenTypeall ofrequired

The type of token

Example: {"_code":0}

senderobject

Optional sender information

customFeesobject[]

Custom fees to apply to the token

Example: [{"feeType":"royalty","numerator":5,"denominator":100,"feeCollectorAccountId":"0.0.12345","fallbackFee":{"hbarAmount":1}}]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/hts/create/token' \
  --header 'Content-Type: application/json' \
  --data '{"name":"My Token","treasuryAccountId":"0.0.12345","symbol":"MTK","decimals":8,"initialSupply":1000000,"maxSupply":10000000,"maxTransactionFee":1000000,"freezeKey":true,"pauseKey":true,"adminKey":true,"kycKey":true,"wipeKey":true,"supplyKey":true,"feeScheduleKey":true,"freezeDefault":false,"validatorConsensusTimestamp":"1718800000000000","memo":"My Token","dao":{"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"},"supplyType":{"_code":1},"tokenType":{"_code":0},"sender":{"key":{},"id":{}},"customFees":[{"feeType":"royalty","numerator":5,"denominator":100,"feeCollectorAccountId":"0.0.12345","fallbackFee":{"hbarAmount":1}}]}'

200

400

404

200

{}

Returns Uint8Array transaction bytes

Hashgraph.Ledger.HTS.Update

Updates an existing Hashgraph.Ledger.HTS token

patch

/hts/update/{token}

Path parameters

tokenstringrequired

Hashgraph.Ledger.HTS token ID

Body

currentTreasurystring

Current Treasury account ID

Example: 0.0.12345

namestring

New token name

Example: Updated Token Name

symbolstring

New token symbol

Example: UTN

memostring

New memo for the token

Example: Updated token description

newTreasuryAccountIdstring

New Treasury account ID

Example: 0.0.67890

newTreasuryKeyobject

New Treasury key

Example: 302a300506032b6570032100114e6abc371b82dab5c15ea149f02d34a012087b163516dd70f44acafabf7777

daoobject

Optional DAO configuration for the token update

Example: {"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}

senderobject

Sender information

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/hts/update/{token}' \
  --header 'Content-Type: application/json' \
  --data '{"currentTreasury":"0.0.12345","name":"Updated Token Name","symbol":"UTN","memo":"Updated token description","newTreasuryAccountId":"0.0.67890","newTreasuryKey":"302a300506032b6570032100114e6abc371b82dab5c15ea149f02d34a012087b163516dd70f44acafabf7777","dao":{"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"},"sender":{"key":{},"id":{}}}'

200

400

404

200

{}

Returns Uint8Array transaction bytes

Hashgraph.Ledger.HTS.UpdateFees

Updates custom fees for a Hashgraph.Ledger.HTS token

patch

/hts/update/{token}/fees

Path parameters

tokenstringrequired

Hashgraph.Ledger.HTS token ID

Body

daoobject

Optional DAO configuration for the fee update

Example: {"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}

senderobject

Optional sender information

customFeesone of[]required

Array of custom fees to be updated for the token

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/hts/update/{token}/fees' \
  --header 'Content-Type: application/json' \
  --data '{"dao":{"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"},"sender":{"key":{},"id":{}},"customFees":[]}'

200

400

404

200

{}

Returns Uint8Array transaction bytes

Hashgraph.Ledger.HTS.Delete

Deletes a Hashgraph.Ledger.HTS token

delete

/hts/delete/{token}

Path parameters

tokenstringrequired

Hashgraph.Ledger.HTS token ID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/hts/delete/{token}'

200

400

404

200

{}

Returns Uint8Array transaction bytes

Hashgraph.Ledger.HTS.Pause

Pauses a Hashgraph.Ledger.HTS token

post

/hts/pause/{token}

Path parameters

tokenstringrequired

Hashgraph.Ledger.HTS token ID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/hts/pause/{token}'

200

400

404

200

{}

Returns Uint8Array transaction bytes

Hashgraph.Ledger.HTS.Unpause

Unpauses a Hashgraph.Ledger.HTS token

post

/hts/unpause/{token}

Path parameters

tokenstringrequired

Hashgraph.Ledger.HTS token ID

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/hts/unpause/{token}'

200

400

404

200

{}

Returns Uint8Array transaction bytes

Hashgraph.Ledger.HTS.FungibleToken.Mint

Mints additional supply of a Hashgraph.Ledger.HTS fungible token

post

/hts/mint/token

Body

token_idstringrequired

The unique identifier of the token to be minted

Example: 0.0.12345

amountnumberrequired

The quantity of tokens to be minted

Example: 100

daoobject

Optional DAO configuration for the token minting

Example: {"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}

senderobjectrequired

Sender information for the mint operation

Example: {"key":"PublicKey or KeyList","id":"AccountId"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/hts/mint/token' \
  --header 'Content-Type: application/json' \
  --data '{"token_id":"0.0.12345","amount":100,"dao":{"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"},"sender":{"key":"PublicKey or KeyList","id":"AccountId"}}'

200

400

404

200

{}

Returns Uint8Array transaction bytes

Hashgraph.Ledger.HTS.FungibleToken.Burn

Burns Hashgraph.Ledger.HTS fungible tokens from treasury

post

/hts/burn/token

Body

token_idstringrequired

The unique identifier of the token to be burned

Example: 0.0.12345

amountnumberrequired

The quantity of tokens to be burned

Example: 100

daoobject

Optional DAO configuration for the token burning

Example: {"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}

senderobjectrequired

Sender information for the burn operation

Example: {"key":"PublicKey or KeyList","id":"AccountId"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/hts/burn/token' \
  --header 'Content-Type: application/json' \
  --data '{"token_id":"0.0.12345","amount":100,"dao":{"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"},"sender":{"key":"PublicKey or KeyList","id":"AccountId"}}'

200

400

404

200

{}

Returns a Uint8Array.

Mint an NFT

This endpoint allows you to mint an NFT.

post

/hts/mint/nft

Body

token_idstringrequired

The unique identifier of the token to be minted

Example: 0.0.12345

cidstringrequired

The Content Identifier (CID) associated with the NFT

Example: QmX5NLKeso6xVxTeP3ycB1RQ5Ir3q7C84oSqQyaCzB7q8g

senderobjectrequired

Sender information for the minting operation

Example: {"key":"PublicKey or KeyList","id":"AccountId"}

daoobject

Optional DAO configuration for the NFT minting

Example: {"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/hts/mint/nft' \
  --header 'Content-Type: application/json' \
  --data '{"token_id":"0.0.12345","cid":"QmX5NLKeso6xVxTeP3ycB1RQ5Ir3q7C84oSqQyaCzB7q8g","sender":{"key":"PublicKey or KeyList","id":"AccountId"},"dao":{"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}}'

200

400

404

200

{}

Returns a Uint8Array.

Burn an NFT

This endpoint allows you to burn an NFT.

post

/hts/burn/nft

Body

token_idstringrequired

The unique identifier of the NFT token to be burned

Example: 0.0.12345

serial_numbernumberrequired

The unique serial number of the specific NFT to be burned

Example: 1

daoobject

Optional DAO configuration for the NFT burning

Example: {"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}

senderobjectrequired

Sender information for the burn operation

Example: {"key":"PublicKey or KeyList","id":"AccountId"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/hts/burn/nft' \
  --header 'Content-Type: application/json' \
  --data '{"token_id":"0.0.12345","serial_number":1,"dao":{"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"},"sender":{"key":"PublicKey or KeyList","id":"AccountId"}}'

200

400

404

200

{}

Returns a Uint8Array.

Wipe an NFT

This endpoint allows you to wipe an NFT.

post

/hts/wipe/nft

Body

token_idstringrequired

The unique identifier of the NFT token to be wiped

Example: 0.0.12345

serial_numbernumberrequired

The unique serial number of the specific NFT to be wiped

Example: 1

account_idstringrequired

The account identifier from which the NFT will be wiped

Example: 0.0.67890

senderobjectrequired

Sender information for the wipe operation

Example: {"key":"PublicKey or KeyList","id":"AccountId"}

daoobject

Optional DAO configuration for the NFT wiping

Example: {"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/hts/wipe/nft' \
  --header 'Content-Type: application/json' \
  --data '{"token_id":"0.0.12345","serial_number":1,"account_id":"0.0.67890","sender":{"key":"PublicKey or KeyList","id":"AccountId"},"dao":{"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}}'

200

400

404

200

{}

Returns a Uint8Array.

get info of a given token id

This endpoint returns the info of a given token id.

get

/hts/token/{token}

Path parameters

tokenstringrequired

the token id of the token we want to get theinfo.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/hts/token/{token}'

200

400

404

200

{}

Returns a TokenInfo object.

get info of a given NFT id and serial number

This endpoint returns theinfo of a given NFT serial number.

get

/hts/nft/{token}//{serialNumber}

Path parameters

tokenstringrequired

the token id of the NFT we want to get theinfo.

serialNumbernumberrequired

the serial number of the NFT we want to get theinfo.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/hts/nft/{token}/{serialNumber}'

200

400

404

200

[
  {}
]

Returns an array of TokenNftInfo.

Hashgraph HTS RESTful Operations

Hashgraph Accounts

Transfer HBAR

Transfer HBAR from one account to another. Requires sender, receiver, and amount details.

post

/accounts/transfer/hbar

Body

amountnumberrequired

The amount of HBAR to transfer

Example: 100

fromstringrequired

The account ID of the sender

Example: 0.0.12345

tostringrequired

The account ID of the receiver

Example: 0.0.67890

memostring

An optional memo to include with the transfer

Example: Payment for services

senderobject

The sender account details

daoobject

Optional DAO configuration for the HBAR transfer

Example: {"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/accounts/transfer/hbar' \
  --header 'Content-Type: application/json' \
  --data '{"amount":100,"from":"0.0.12345","to":"0.0.67890","memo":"Payment for services","sender":{},"dao":{"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}}'

200

400

404

200

{}

Returns a Uint8Array representing the transaction.

Transfer Token

Transfer a specific amount of tokens from one account to another. Requires token ID, sender, receiver, amount, and token decimals.

post

/accounts/transfer/token

Body

token_idstringrequired

The unique identifier of the fungible token to be transferred

Example: 0.0.12345

fromstringrequired

The account ID of the sender

Example: 0.0.67890

tostringrequired

The account ID of the receiver

Example: 0.0.11111

amountnumberrequired

The amount of tokens to transfer

Example: 100

decimalsnumberrequired

The number of decimal places for the token

Example: 2

memostring

An optional memo to include with the transfer

Example: Transfer memo

daoobject

Optional DAO configuration for the fungible token transfer

Example: {"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/accounts/transfer/token' \
  --header 'Content-Type: application/json' \
  --data '{"token_id":"0.0.12345","from":"0.0.67890","to":"0.0.11111","amount":100,"decimals":2,"memo":"Transfer memo","dao":{"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}}'

200

400

404

200

{}

Returns a Uint8Array representing the transaction.

Transfer NFT

Transfer a specific NFT from one account to another. Requires NFT ID, sender, receiver, and serial number.

post

/accounts/transfer/nft

Body

nftstringrequired

The unique identifier of the NFT token to be transferred

Example: 0.0.12345

fromstringrequired

The account ID of the sender

Example: 0.0.67890

tostringrequired

The account ID of the receiver

Example: 0.0.11111

serial_numbernumberrequired

The unique serial number of the specific NFT to be transferred

Example: 1

memostring

An optional memo to include with the transfer

Example: NFT transfer memo

senderobject

Optional sender configuration

daoobject

Optional DAO configuration for the NFT transfer

Example: {"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/accounts/transfer/nft' \
  --header 'Content-Type: application/json' \
  --data '{"nft":"0.0.12345","from":"0.0.67890","to":"0.0.11111","serial_number":1,"memo":"NFT transfer memo","sender":{},"dao":{"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}}'

200

400

404

200

{}

Returns a Uint8Array representing the transaction.

Atomic Swap

Perform an atomic swap of tokens and/or HBAR between accounts. The swap either succeeds or fails atomically.

post

/accounts/transfer/atomic-swap

Body

fromstringrequired

The account ID of the sender initiating the atomic swap

Example: 0.0.123456

tostringrequired

The account ID of the receiver in the atomic swap

Example: 0.0.789012

token_idstringrequired

The unique identifier of the token being swapped

Example: 0.0.345678

decimalsnumberrequired

The number of decimal places for the token being swapped

Example: 8

amountnumberrequired

The amount of tokens to be swapped

Example: 100

memostring

An optional memo to include with the atomic swap

Example: Atomic swap for Project X

senderobject

The sender account details

daoobject

Optional DAO configuration for the atomic swap

Example: {"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/accounts/transfer/atomic-swap' \
  --header 'Content-Type: application/json' \
  --data '{"from":"0.0.123456","to":"0.0.789012","token_id":"0.0.345678","decimals":8,"amount":100,"memo":"Atomic swap for Project X","sender":{},"dao":{"topicId":"0.0.12345","consensusTimestamp":"1234567890.123456789"}}'

200

400

404

200

{}

Returns a Uint8Array representing the signed transaction.

---

Built with ❤️ by the HbarSuite Team Copyright © 2024 HbarSuite. All rights reserved.