Cregis Developer Docs
POST/api/v1/sub_address_balance

Query Sub-address Balances

Query sub-address balances by project and token. Supports filtering by address, balance range, and pagination parameters.

Rate limit: 1000 requests/minute

Request

Request Body

required

application/json
  • noncestringrequired

    6-character random string.

  • timestampinteger<int64>required

    Timestamp.

  • signstringrequired

    Signature string.

  • pidinteger<int64>required

    Project ID.

  • currencystringrequired

    Token identifier to query, in chain_id@token_id format.

  • addressstring

    Sub-address to query. If omitted, all project addresses with balances are queried.

  • maximum_balancestring

    Maximum address balance to query, inclusive.

  • minimum_balancestring

    Minimum address balance to query, inclusive.

  • page_numinteger<int32>

    Page number. Defaults to 1 if omitted.

  • page_sizeinteger<int32>

    Number of records per page. Defaults to 10 if omitted. Maximum value is 100.

Responses

200Success
application/json
  • codestring

    Response code.

  • msgstring

    Response message.

  • dataobject

    Response data.

    • totalinteger<int64>

      Total number of records.

    • page_numinteger<int32>

      Current page number.

    • page_sizeinteger<int32>

      Number of records per page.

    • rowsarray<object>

      Address balance list.

      Array items · object

      • pidinteger<int64>

        Project ID.

      • addressstring

        Queried address.

      • currencystring

        Currency identifier, in chain_id@token_id format.

      • totalstring

        Total balance (available + processing).

      • availablestring

        Available balance.

      • processingstring

        Processing balance.