Skip to main content

​
API URL

POST /api/v1/sub_address_balance

​
Request

​
Request Parameters

NameTypeRequiredDescription
pidinteger(int64)YesWaaS Project ID. Navigate to: “Cregis > WaaS > [Your Project] > Settings > Developer”
currencystringYesThe token you want to query (chain_id@token_id)
addressstringNoThe sub-address you want to query
maximum_balancestringNoQuery address maximum balance
minimum_balancestringNoQuery address minimum balance
page_numinteger(int32)NoPage number (defaults to 1 if empty)
page_sizeinteger(int32)NoItems per page (defaults to 10 if empty, maximum allowed value is 100 if specified)
noncestringYes6-character random string
timestampinteger(int64)YesCurrent timestamp (milliseconds)
signstringYesDigital signature to prevent tampering
Request Example
{
  "pid": 1382528827416576,
  "address": "",
  "currency": "195@195",
  "minimum_balance":"1"
  "maximum_balance":"10"
  "page_num": 1,
  "page_size": 10,
  "nonce": "hwlkk6",
  "timestamp": 1688004243314,
  "sign": "d6eef2de79e39f434a38efb910213ba6"
}

​
Response

​
Response Result

NameTypeDescription
codestringResponse Code
msgstringResponse Message
dataobjectResponse Data Object

​
Response data Object

NameTypeDescription
pidinteger(int64)WaaS project ID
currencystringThe token name of the token you are querying
addressstringQueried address
totalstringTotal balance（Available+Processing）
availablestringAvailable balance
processingstringProcessing balance
Response Example
{
    "code": "00000",
    "msg": "ok",
    "data": {
        "total": 1,
        "rows": [
            {
              "pid":1395142548643840,
              "address":"TKDxZEycaxNosmH1V9x6hEacKgWF3RRZ7h",
              "currency":"198@TG3XXyExBkPp9nzdajDZsozEu4BkaSJozs",
              "total":"7",
              "available":"7",
              "processing":"0"
            }
        ],
        "pageNum": 1,
        "pageSize": 10
    },
}