User Marketplace Activity & History

Getting user activity and history

Function: getUserBids

Description: Returns all existing user bids

Inputs:

Condition Inputs:

  • [Required] userAddress

    • Type: String

    • Description: Wallet to look up bids

Response:

GetUserBidsQuery

Example:

hsClient.getUserBids(
  {
    condition: {
      userAddress: "Bnxf8Kz5TG6YUeyw9pTFPGMaazNswsoEvqgUVL7ekG9C"
    }
  }
)

Reference Implementation:

Function: getUserListings

Description: Returns all existing user listings

Inputs:

Condition Inputs:

  • [Required] userAddress

    • Type: String

    • Description: Wallet to look up bids

Response:

GetUserListingsQuery

Example:

hsClient.getUserListings(
  {
    condition: {
      userAddress: "Bnxf8Kz5TG6YUeyw9pTFPGMaazNswsoEvqgUVL7ekG9C"
    }
  }
)

Reference Implementation:

Function: getUserHistory

Description: Returns all user activity

Inputs:

Condition Inputs:

  • [Required] userAddress

    • Type: String

    • Description: Wallet to look up bids

  • Optional] actionTypes

    • Type: MarketplaceActionEnums[]

    • Description: Action types that we want to filter for

    • Allowed Values:

      • MarketPlaceActionEnum.Bid | "BID"
        MarketPlaceActionEnum.Delisting | "DELISTING"
        MarketPlaceActionEnum.Listing | "LISTING"
        MarketPlaceActionEnum.Transaction | "TRANSACTION"
        MarketPlaceActionEnum.Updatelisting | "UPDATELISTING"
        MarketPlaceActionEnum.Updatebid | "UPDATEBID"
        MarketPlaceActionEnum.Cancelbid | "CANCELBID"
  • [DEPRECATED] nonMpaActionTypes

    • We no longer show mints in this endpoint for performance reasons. There is a new endpoint to get mint activity. We have plans down the road to merge the 2 but until then we please use the non marketplace actions endpoint for mints.

Pagination Input:

  • [Optional] paginationInfo

    • Type: PaginationConfig

    • Description: Pagination Params

    • Example:

    • {
          page_number: 1,
          page_size: 40
      }

Response:

GetUserHistoryQuery

Example:

hsClient.getUserHistory(
  {
    condition: {
      userAddress: "Bnxf8Kz5TG6YUeyw9pTFPGMaazNswsoEvqgUVL7ekG9C"
    }
  }
)

Reference Implementation:

Last updated