Cregis Developer Docs
POST/openapi/v1/wallet_address_balance

Query Address Balance

Query wallet address balances. Supports filtering by address, blockchain ID, token ID, balance range, and pagination parameters.

Rate limit: 1000 requests/minute

Request

Headers

  • Access-Keystringrequired

    API Key identifier used to identify the caller.

  • Access-Timestampinteger<int64>required

    Unix timestamp in milliseconds.

  • Access-Noncestringrequired

    Random string used to prevent replay attacks.

  • Access-Signaturestringrequired

    Request signature calculated with the Access Secret.

Request Body

required

application/json
  • wallet_idinteger<int64>required

    Wallet ID to query. You can find it in Cregis portal > Wallet > Settings.

  • 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.

  • addressstring

    Wallet address to query.

  • chain_idstring

    Blockchain ID. If omitted, all blockchain tokens with balances in the address are queried.

  • token_idstring

    Token ID. If omitted, all blockchain tokens with balances in the address are queried.

  • maximum_balancestring

    Maximum available address balance to query, inclusive.

  • minimum_balancestring

    Minimum available address balance to query, inclusive.

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

      Address balance list.

      Array items

      • addressstring

        Queried address.

      • chain_idstring

        Blockchain ID.

      • token_idstring

        Token ID.

      • totalstring

        Total balance (available + processing).

      • availablestring

        Available balance.

      • processingstring

        Processing balance.