Get currency information

Gets the information of a currency.


Call URL

/currencies/(currencyAddress)

Type : GET


Call request URL parameters

Field Type Required/Optional Description Accepted values
currencyAddress string Required The address of the involved currency. Any valid currency address

Sample Call Request

https://api.tetrium.io/tokenize/currencies/0x29341b674091d600c227B137a457b0573515A7A8

Call responses

Success response

Field Type Description Respond Values
status string Status of the API call. "success"
message string Information about the status. "currency information retrieved"
currencyName string The name of the currency token. Any string
currencySymbol string The symbol of the currency token. Any string
currencyDecimals string The decimal points allowed for the currency token. Any string with an integer number
currencyTokenMinted number (in string) The total amount of currency token minted. Any number in a string format
currencyTokenLimit number (in string) The maximum amount of currency token allowed to be minted. Any number in a string format
currencyMemberCount number (in string) The current number of currency members. Any number in a string format
currencyMemberLimit number (in string) The maximum number of currency members allowed to be added. Any number in a string format
adminWalletAddress string The wallet address of the currency creator. Any valid wallet address

Error response

Field Type Description Respond Values
status string Status of the API call. "fail"
error string Information about the error. (See below)

Information contained in error:

Error Messages Description
"invalid currencyAddress" currencyAddress provided was not in the correct format.

For any other errors, please refer to List of Common Error Messages

Sample Call Response

{
   "status":"success",
   "message":"currency information retrieved",
   "info":{
      "currencyName":"SampleCurrency",
      "currencySymbol":"SMC",
      "currencyDecimals":"2",
      "currencyTokenMinted":"100.00",
      "currencyTokenLimit":"10000000.00",
      "currencyMemberCount":"2",
      "currencyMemberLimit":"10",
      "adminWalletAddress":"0xc7731Ba1b2cFB4e5fDBce6492928a7c7787E211E"
   }

results matching ""

    No results matching ""