Token State & Token History

Getting token state and its history

Function: getTokenState

Description: Returns all active actions for a token. Think of this as the live order book on a single NFT. Specifically this shows all bids on a token and if its listed. You can use this call to check if there are bids on your NFT.

Inputs:

Condition Inputs:

• [Required] tokenAddresses

  • Type: Array of strings

  • Description: List of token addresses to get state for

  • Note: Limit of 500 tokens per call

• [Optional] actionTypes

  • Type: MarketplaceActionEnums[]

  • Description: Action types that we want to filter for

  • Allowed Values:

    • MarketPlaceActionEnum.Bid
      MarketPlaceActionEnum.Delisting
      MarketPlaceActionEnum.Listing
      MarketPlaceActionEnum.Transaction
      MarketPlaceActionEnum.Updatelisting
      MarketPlaceActionEnum.Updatebid
      MarketPlaceActionEnum.Cancelbid;

Response:

GetTokenStateQuery

Example:

hsClient.getTokenState({
  condition: {
    tokenAddresses: ['FUsGSgD9sdnHugRCWHhoxLnyER4mwL7wcEYLyaz5zw66'],
  }
})

Reference Implementation:

Function: getTokenHistory

Description: Returns the history of a token.

Inputs:

Condition Inputs:

• [Required] tokenAddresses

  • Type: Array of strings

  • Description: List of token addresses to get state for

  • Note: Limit of 500 tokens per call

• [Optional] actionTypes

  • Type: MarketplaceActionEnums[]

  • Description: Action types that we want to filter for

  • Allowed Values:

    • MarketPlaceActionEnum.Bid
      MarketPlaceActionEnum.Delisting
      MarketPlaceActionEnum.Listing
      MarketPlaceActionEnum.Transaction
      MarketPlaceActionEnum.Updatelisting
      MarketPlaceActionEnum.Updatebid
      MarketPlaceActionEnum.Cancelbid;

Response:

GetTokenHistoryQuery

Example:

hsClient.getTokenHistory({
  condition: {
    tokenAddresses: ['FUsGSgD9sdnHugRCWHhoxLnyER4mwL7wcEYLyaz5zw66']
  }
})

Reference Implementation: