ex_open_sea v0.0.7

ExOpenSea.Collections.Index (ex_open_sea v0.0.7)

Return a list of all the collections supported and vetted by OpenSea. To include all collections relevant to a user (including non-whitelisted ones) include the asset_owner parameter.

Each collection in the response has an attribute called primary_asset_contracts with info about the smart contracts belonging to that collection. For example, ERC-1155 contracts maybe have multiple collections all referencing the same contract, but many ERC-721 contracts may all belong to the same collection (dapp).

You can also use this endpoint to find which dapps an account uses, and how many items they own in each in a single API call.

https://docs.opensea.io/reference/retrieving-collections

Link to this section Summary

Types

collection()
error_reason()
params()
raw_payload()
result()

Functions

get(params \\ %{})

Link to this section Types

Link to this type

collection()

@type collection() :: ExOpenSea.Collection.t()
Link to this type

error_reason()

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

params()

@type params() :: %{
  optional(:asset_owner) => String.t(),
  optional(:offset) => non_neg_integer(),
  optional(:limit) => non_neg_integer()
}
Link to this type

raw_payload()

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

result()

@type result() ::
  {:ok, [collection()], raw_payload()}
  | {:error, error_reason(), raw_payload() | nil}

Link to this section Functions

Link to this function

get(params \\ %{})

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