Wallet Stats & Wallet Stats Hist

Wallet Stats

We track all wallets in the space and show statistics on them from a 24H and All Time time period. We allow the user to search either by wallet address for their wallet.

Function: getWalletStats

Inputs:

Condition Inputs:

• [Optional] searchAddress

  • Type: String

  • Description: Single wallet address if you want to search for a single user

• [Optional] includeUserRank

  • Type: Boolean

  • Description: Flag to include the rank of the user or person you are searching for

• [Required] timePeriod

  • Type: TimePeriodEnum

  • Description: Time period

  • Values: "ALL" or "ONE_DAY"

Order By

• [Optional] orderBy

  • Type: OrderConfig

  • Allowed Values:

  • All the returned values should be allowed for sorting

Pagination Input:

• [Optional] paginationInfo

  • Type: PaginationConfig

  • Description: Pagination Params

  • Example:

  • {
        page_number: 1,
        page_size: 40
    }

The following are the fields returned by this call.

wallet_stats {
      address
      listed_nfts
      owned_nfts
      portfolio_value
      sol_name
      twitter
      num_sold_1day
      volume_sold_1day
      num_bought_1day
      volume_bought_1day
      num_bids_1day
      bids_made_amount_1day
      max_purchase_1day
      max_sale_1day
      num_minted_1day
      minted_amount_1day
      wallet_score_1day
      max_purchase_item_1day
      max_sale_item_1day
      num_sold
      volume_sold
      num_bought
      volume_bought
      num_bids
      bids_made_amount
      max_purchase
      max_sale
      num_minted
      minted_amount
      wallet_score
      max_purchase_item
      max_sale_item
      rank
}

Example Usage

hsClient.getWalletStats({
  condition: {
    timePeriod: "ONE_DAY" as TimePeriodEnum
  },
  orderBy: {field_name: "volume_bought_1day", sort_order: "DESC" as SortOrderEnum}
}).then(result => console.log(result.getWalletStats.wallet_stats));

Reference Usage

Get Overall Wallet Stats

Returns the largest seller, buyer, and highest sale in the last 24 hours. Each field returned is a wallet_stat type that make up the rows in the wallet stats table (described above).

GetOverallWalletStatOutput {
  top_seller_1day: WalletStat;

  top_buyer_1day: WalletStat;

  largest_sale_1day: WalletStat;
}

Reference Usage

Wallet Stat Hist

For a single user we can fetch their # of owned NFTs and portfolio value (Sum of floors, if we have them). This API is a bit spotty in terms of accuracy so please use at your own discretion

Function: getWalletStatsHist

Inputs:

Condition Inputs:

• [Required] searchAddress

  • Type: String

  • Description: Single wallet address if you want to search for a single user

• [Optional] dayLookback

  • Type: Day_Lookback_Enum

  • Default Value: "SEVEN_DAY"

  • Description: Time period to look back

  • Values:

    • "SEVEN_DAY"

    • "ONE DAY"

    • "MONTH"

Example Usage

hsClient.getWalletStatsHist({
  condition: {
    searchAddress: "HGEj9nJHdAWJKMHGGHRnhvb3i1XakELSRTn5B4otmAhU"
  },
}).then(result => console.log(result.getWalletStatsHist.wallet_stats_history));

Reference Usage