API Reference

Return the history activity of a NFT without scanning the entire chain.

🚧

The NFT History Activity API on Sui is currently exclusively available to Pro Members. However, non-Pro members can also enjoy a trial period with an allocation of 300 free calls. If you're interested, please register directly through here. Please note that the API Key can also be used for your RPC endpoint.

Parameter

  • objectId, string - search by NFT Object ID.
  • eventType, string - the returned data will be filtered by event types using this array of strings. Supports "ListingCreate, ListingClosed, BidCreate, BidClosed, Sale, BidAccepted”.
  • marketplace, string - the returned activity data will be filtered by marketplace. Supports "Clutchy , BlueMove, Tocen, Souffl3, KeepSake, HyperSpace".
  • startTime, string - find event Time from start time.
  • endTime, string - find event Time to end time.
  • pageSize, integer - the number of records showing on each page. 20 by default and up to 50.
  • pageIndex, integer - the index of the page to retrieve. The first page is typically indexed as 1, and subsequent pages are numbered incrementally.

Response

  • data - an array of the specified NFT activity detail. An empty array will be returned if there are no holders.
    • txDigest, string - the txDigest of sui event .
    • eventSeq, string - the eventSeq of sui event.
    • objectId, string - the object Id of an NFT.
    • eventType, string - the event type of an event.
    • eventFunc, string - the sui package's module of an func.
    • marketPlace, string - the sui nft marketplace.
    • from, string - the from user address.
    • to, string - the to user address.
    • price, string - the event order price.
    • ftType, string - the event order payment token address.
    • timestampMs, int - the event time.
    • description, string - the description of the associated NFT metadata.
    • projectURL, string - the project official url if the associated package is verified.
    • imageURL,string - the image url of the associated NFT metadata.
    • name,string - the name of the associated NFT metadata, for example.
  • nextPageIndex, integer - the index of the next page to retrieve. Current page index will be returned if the last page is reached.
  • total, integer - the count of result.

For higher throughput, create your own API key.

Language
Credentials
Header
Click Try It! to start a request and see the response here!