ex_open_sea v0.0.7

ExOpenSea.Events.Index (ex_open_sea v0.0.7)

Return a list of events that occur on the NFTs that are tracked by OpenSea. The event_type field indicates the type of event (transfer, successful auction, etc) and the results are sorted by event timestamp.

Note that due to block reorganizations, recent events (less than 10 minutes old) may not reflect the final state of the blockchain.

https://docs.opensea.io/reference/retrieving-asset-events

Link to this section Summary

Types

api_key()
error_reason()
events_response()
params()
raw_payload()
result()

Functions

get(api_key, params \\ %{})

Link to this section Types

Link to this type

api_key()

@type api_key() :: ExOpenSea.ApiKey.t()
Link to this type

error_reason()

@type error_reason() :: :parse_result_item | String.t()
Link to this type

events_response()

@type events_response() :: ExOpenSea.EventsResponse.t()
Link to this type

params()

@type params() :: %{
  optional(:only_opensea) => boolean(),
  optional(:token_id) => non_neg_integer(),
  optional(:collection_slug) => String.t(),
  optional(:collection_editor) => String.t(),
  optional(:account_address) => String.t(),
  optional(:event_type) => String.t(),
  optional(:auction_type) => String.t(),
  optional(:occured_before) => non_neg_integer(),
  optional(:cursor) => String.t()
}
Link to this type

raw_payload()

@type raw_payload() :: map()
Link to this type

result()

@type result() ::
  {:ok, events_response(), raw_payload()}
  | {:error, error_reason(), raw_payload() | nil}

Link to this section Functions

Link to this function

get(api_key, params \\ %{})

@spec get(api_key(), params()) :: result()