Project Marketplace Activity & History

Getting activity / history for a project

Function: getProjectHistory

Inputs:

Condition Inputs:

  • [Required] projects

    • Type: ProjectIdWithAttributes[]

    • Description: Projects to query against

    • Note: Supports attribute filtering for only a single collection

    • Example:

    • [
        {
          project_id: "degenape",
        }
      ]
      
      [
        {
          project_id: "degenape",
          attributes: [{name: "Clothing", type: "CATEGORY", values: ["Maid's Uniform"]}]
        }
      ]

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

Response:

GetProjectHistoryQuery

Example:

Getting all degeniverse collections

import { HyperspaceClient } from "hyperspace-js";

const hsClient = new HyperspaceClient(API_KEY);

hsClient.getProjectHistory({
  condition: {
      projects: [
        {project_id: "degenape"}, 
        {project_id: "degenerateapekindergarten"}, 
        {project_id: "degentrashpandas"}
      ],
    }
  }
)

Getting sales activity only

hsClient.getProjectHistory({
  condition: {
      projects: [
        {project_id: "degenape"}, 
        {project_id: "degenerateapekindergarten"}, 
        {project_id: "degentrashpandas"}
      ],
      actionTypes: [MarketPlaceActionEnum.Transaction]
    }
  }
)

Getting 1 attribute SMB activity

hsClient.getProjectHistory({
  condition: {
      projects: [
        {project_id: "smb", attributes: [{name: "Attributes Count", type: "NUMERIC", values: ["1"]}]}, 
      ],
    }
  }
)

Reference Implementation

Last updated