Dfns TypeScript SDK - v0.8.37
    Preparing search index...

    Type Alias SearchWalletsBody

    type SearchWalletsBody = {
        filters?: {
            asset?: {
                balance?: { max?: string; min?: string };
                scope?: "verified" | "all";
                symbol?: string;
                token?: { network: string; tid: string };
            };
            custodial?: boolean;
            networks?: string[];
            statuses?: ("Active" | "Inactive" | "Archived")[];
            storeIds?: string[];
            tags?: { hasAll?: string[]; hasAny?: string[] };
            vaultWallets?: "exclude" | "include";
        };
        includeAssets?: "native"
        | "verified";
        limit?: number;
        matching?: "precise" | "broad";
        paginationToken?: string;
        q?: string;
        sort?: {
            direction: "asc" | "desc";
            field: "name" | "dateCreated" | "assetBalance";
        };
    }
    Index
    filters?: {
        asset?: {
            balance?: { max?: string; min?: string };
            scope?: "verified" | "all";
            symbol?: string;
            token?: { network: string; tid: string };
        };
        custodial?: boolean;
        networks?: string[];
        statuses?: ("Active" | "Inactive" | "Archived")[];
        storeIds?: string[];
        tags?: { hasAll?: string[]; hasAny?: string[] };
        vaultWallets?: "exclude" | "include";
    }

    Narrows the results. A wallet is returned only if it matches every filter set here.

    Type Declaration

    • Optionalasset?: {
          balance?: { max?: string; min?: string };
          scope?: "verified" | "all";
          symbol?: string;
          token?: { network: string; tid: string };
      }

      Matches wallets holding a positive balance of the token. Results are ranked by that balance, or by relevance when q is set.

      • Optionalbalance?: { max?: string; min?: string }

        Optional balance bounds. Set min, max, or both.

        • Optionalmax?: string

          Inclusive upper bound, in whole token units. Fractional allowed.

        • Optionalmin?: string

          Inclusive lower bound, in whole token units: "100" is 100 USDC, not its smallest unit. Fractional allowed.

      • Optionalscope?: "verified" | "all"

        "verified" (default) matches staff-verified tokens only. "all" widens to every token with the symbol — unverified balances are self-reported and may be spam.

      • Optionalsymbol?: string

        Token symbol to filter by across networks, case insensitive, e.g. "USDC". Set either symbol or token. Resolves to verified tokens unless scope is "all".

      • Optionaltoken?: { network: string; tid: string }

        An exact token identified by its network and tid. Set either token or symbol. If filters.networks is also set, it must include this network. Reserved for future use: token selectors currently return HTTP 400 with details.kind UnsupportedAssetSelector.

        • network: string
        • tid: string

          Canonical token identifier including its kind prefix, e.g. erc20:, spl:, hts:, or native:eth.

    • Optionalcustodial?: boolean

      Matches custodial wallets when true, and wallets that are not custodial when false.

    • Optionalnetworks?: string[]

      Matches wallets on any of these networks.

    • Optionalstatuses?: ("Active" | "Inactive" | "Archived")[]

      Matches wallets in any of these statuses. Archived wallets are left out unless this list includes Archived.

    • OptionalstoreIds?: string[]

      Scope results to wallets controlled by these key stores.

    • Optionaltags?: { hasAll?: string[]; hasAny?: string[] }

      Tag filter: set exactly one of hasAny or hasAll. Tags match exactly and are case sensitive.

      • OptionalhasAll?: string[]

        Matches wallets carrying every one of these tags.

      • OptionalhasAny?: string[]

        Matches wallets carrying at least one of these tags.

    • OptionalvaultWallets?: "exclude" | "include"

      'include' (default) keeps vault-controlled wallets. 'exclude' drops them from browse and text-search results, but an exact identifier still resolves: pasting a wallet id, address, transaction hash or vault id returns the wallet even when it belongs to a vault.

    includeAssets?: "native" | "verified"

    Inline each wallet's assets: 'native' returns its native asset only, 'verified' adds its verified tokens. Omit to return none.

    limit?: number

    Maximum number of wallets to return, up to 500. Defaults to 50.

    matching?: "precise" | "broad"

    How widely to match. 'broad' (the default when omitted) matches identifiers and names, and also looks inside names and tolerates typos. 'precise' matches identifiers and names only: an exact id, an exact name, or the start of a name. It skips the fuzzy work, so it is markedly faster on a large org, but it is not a guarantee against the time limit: a search that also carries several filters can still exceed it.

    paginationToken?: string

    Opaque token used to retrieve the next page. Returned as nextPageToken from the previous request.

    q?: string

    Text to search for. A wallet id, address, external id, transaction hash or vault id resolves to its wallets. Any other text matches wallet names: an exact name first, then names starting with the text, then looser matches such as a word inside a name or a typo.

    sort?: {
        direction: "asc" | "desc";
        field: "name" | "dateCreated" | "assetBalance";
    }

    Result order. Omitted, results are ranked by relevance when q is set, by the filtered token balance with an asset filter, and newest first otherwise. assetBalance requires an asset filter, and an asset filter accepts no other sort.

    Type Declaration

    • direction: "asc" | "desc"

      'asc' for ascending, 'desc' for descending.

    • field: "name" | "dateCreated" | "assetBalance"

      What to order by: 'name' (the wallet name), 'dateCreated' (when the wallet was created), or 'assetBalance' (the balance of the token in filters.asset, which requires that filter).