API User Guide

  • For security and prevention of unauthorized use, only one API key can be issued per IP, and API activation is not possible for keys that have not been authenticated.
  • If the IP is changed, you will need to reissue the API KEY.
  • You can request 10 times per second.
  • If you send more than 10 requests, you will be restricted from using the API for 5 minutes.
  • The development server API key and the production server API key are separate and must be requested separately.
  • All parameters must be requested via POST.

Response code and result

  • Success: RES:200 MSG:Result value
  • Failure: RES:ERROR_CODE MSG:Error message

Response code and result

Parameters Type memo sample
apikey String Only one can be issued per IP VGtOU0s2S3lWMy9SaGxHRUtTVmZTZERQWmlXZFFIeCt1UWVDOHBJQ0NFVT0
passwd String If the password of the wallet is lost, it cannot be recovered. Please keep it separately. a12345678
command String (ADD) Is a fixed parameter ADD

Response result

  • {"RES:200", "MSG:Wallet address"}

Check wallet balance

Parameters Type memo sample
apikeyStringOnly one can be issued per IPVGtOU0s2S3lWMy9SaGxHRUtTVmZTZERQWmlXZFFIeCt1UWVDOHBJQ0NFVT0
passwdStringIf the password of the wallet is lost, it cannot be recovered. Please keep it separatelya12345678
commandString(VAL) Is a fixed parameterVAL
addrString(ADD) Wallet address for which you want to check the balance0x0cac7efee5bbe24d698f08c8807e4dabdf318aec

Response result

  • {"RES:200", "MSG:Balance (18 decimal points)"}

Coin transfer

ParametersTypememosample
apikeyStringOnly one can be issued per IPVGtOU0s2S3lWMy9SaGxHRUtTVmZTZERQWmlXZFFIeCt1UWVDOHBJQ0NFVT0
passwdStringPassword sent when creating the sending addressa12345678
commandString(SND) This is a fixed parameterSND
addrStringSending wallet address0x0cac7efee5bbe24d698f08c8807e4dabdf318aec
receiveStringReceiving wallet address0x0cac7efee5bbe24d698f08c8807e4dabdf318aec
amountIntegerSending quantity (transfer is possible only if the sending address has more than the fee (0.5~1) used in the blockchain)100

Response result

  • {"RES:200", "MSG:Block hash value"}

Transaction detail inquiry

ParametersTypememosample
apikeyStringOnly one can be issued per IPVGtOU0s2S3lWMy9SaGxHRUtTVmZTZERQWmlXZFFIeCt1UWVDOHBJQ0NFVT0
passwdStringIf the password of the wallet is lost, it cannot be recovered. Please keep it separatelya12345678
commandString(TRX) It is a fixed parameterTRX
transactionStringHASH value received as a result of transmission0x09f3c28530f8ab2669dcc95e6ee2e2fdb9404b35ddd64c8232745e13ef8a750d

Response result

  • {"RES:200", MSG:{"SEND":"Sent address", "RCVE":"To address", "AMNT":"Transfer amount", "DATE":"Transfer time (server UNIXTIME)"}}

Transaction search

ParametersTypememosample
apikeyStringOnly one can be issued per IPVGtOU0s2S3lWMy9SaGxHRUtTVmZTZERQWmlXZFFIeCt1UWVDOHBJQ0NFVT0
passwdStringPassword sent when creating the sending addressa12345678
commandString(TRXSCH) This is a fixed parameterTRXSCH
addrStringSending wallet address0x0cac7efee5bbe24d698f08c8807e4dabdf318aec
displayIntegerSpecify the number of search results to be printed (default: 10, maximum: 100)10
pageIntegerSearch start position (default: 1)1

Response result

  • {"RES:200", MSG:{ "TYPE":"IN (deposit) / OUT (withdraw)", "SEND":"Sending address", "RCVE":"To address", "AMNT":" "}}

Response error code and error content

ERROR CODEERROR MESSAGEExplanation
200Successsuccess
300Bad RequestParameter or api key error
301Bad RequestParameter or api key error
302Bad RequestParameter or api key error
303Bad RequestParameter or api key error
401No permission (IP)Blocked IP
402No permission (KEY)Blocked api key
403Invalid ApikeyWrong api key
404Method Not AllowedWrong api key
405Database FailConnection error
406Invalid ParameterParameter error
500NODE MessageError message during node processing