logo

OpenSea - NFT marketplace

Demo to preview the plugin:

Introduction

The OpenSea plugin helps developers create new features using Nfs data and their marketplace. We provide a set of actions that allow you to receive the metadata of the ERC721 and ERC1155 tokens, as well as other key aspects of their trading platform, including events, collection, orders, and more.

How to setup

The plugin does not contain elements. In order to get data from the service, use the appropriate call from the list of actions
Image without caption
For each call you will need an API key (X-API-KEY)
To get X-API-KEY, you must fill out a special form on the official website https://docs.opensea.io/reference/request-an-api-key
Image without caption

Plugin Data/Action Calls (API Calls only)

  1. Retrieve List Of Assets
Image without caption
Image without caption
Param Name
Description
Type
token_ids
An array of token IDs to search for (e.g. ?token_ids=1&token_ids=209). Will return a list of assets with token_id matching any of the IDs in this array
text
collection
Limit responses to members of a collection. Case sensitive and must match the collection slug exactly. Will return all assets from all contracts in a collection. For more information on collections, see our collections documentation
text
collection_slug
Limit responses to members of a collection. Case sensitive and must match the collection slug exactly. Will return all assets from all contracts in a collection. For more information on collections, see our collections documentation
text
order_direction
Can be asc for ascending or desc for descending
text
asset_contract_address
The NFT contract address for the assets
text
asset_contract_addresses
An array of contract addresses to search for (e.g. ?asset_contract_addresses=0x1...&asset_contract_addresses=0x2...). Will return a list of assets with contracts matching any of the addresses in this array. If "token_ids" is also specified, then it will only return assets that match each (address, token_id) pairing, respecting the order
text
limit
Limit. Defaults to 20, capped at 50
number
cursor
A cursor pointing to the page to retrieve
text
include_orders
A flag determining if order information should be included in the response
text
owner
The address of the owner of the assets
2. Retrieve List Of Events
Image without caption
Image without caption
Param Name
Description
Type
only_opensea
Restrict events on OpenSea auctions. Can be true or false
boolean
token_id
The token's id to optionally filter by
number
asset_contract_address
The NFT contract address for the assets for which to show events
text
collection_slug
Limit responses to events from a collection. Case sensitive and must match the collection slug exactly. Will return all assets from all contracts in a collection. For more information on collections, see our collections documentation
text
account_address
A user account's wallet address to filter for events on an account
text
event_type
The event type to filter. Can be created for new auctions, successful for sales, canceled, bid_entered, bid_withdrawn, transfer, offer_entered, or approve
text
auction_type
Filter by an auction type. Can be English for English Auctions, dutch for fixed-price and declining-price sell orders (Dutch Auctions), or min-price for CryptoPunks bidding auctions
text
occurred_before
Only show events listed before this timestamp. Seconds since the Unix epoch
date-time
occurred_after
Only show events listed after this timestamp. Seconds since the Unix epoch
date-time
cursor
A cursor pointing to the page to retrieve
text
3. Retrieve list of Collections
Image without caption
Param Name
Desription
Type
asset_owner
A wallet address. If specified, will return collections where the owner owns at least one asset belonging to smart contracts in the collection. The number of assets the account owns is shown as owned_asset_count for each collection
text
offset
For pagination. Number of contracts offset from the beginning of the result list
number
limit
For pagination. Maximum number of contracts to return
number
4. Retrieve Bundles
Image without caption
Param Name
Desription
Type
on_sale
If set to true, only show bundles currently on sale. If set to false, only show bundles that have been sold or cancelled.
owner
Account address of the owner of a bundle (and all assets within)
asset_contract_address
Contract address of all the assets in a bundle. Only works for homogenous bundles, not mixed ones.
asset_contract_addresses
An array of contract addresses to search for (e.g. ?asset_contract_addresses=0x1...&asset_contract_addresses=0x2...). Will return a list of bundles with assets having contracts that match ALL of the addresses in this array. Useful for querying for mixed bundles, e.g. ones with CryptoKitties AND CK Talisman statues.
text
token_ids
A list of token IDs for showing only bundles with at least one of the token IDs in the list
limit
For pagination. Maximum number of contracts to return
number
offset
For pagination. Number of contracts offset from the beginning of the result list
5. Retrieving A Single Asset
Image without caption
Param Name
Desription
Type
contract_address
Address of the contract for this NFT
text
token_id
Token ID for this item
text
include_orders
A flag determining if order information should be included in the response. The default value of this flag is false.
text
account_address
Address of an owner of the token. If you include this, the response will include an ownership object that includes the number of tokens owned by the address provided instead of the top_ownerships object included in the standard response, which provides the number of tokens owned by each of the 10 addresses with the greatest supply of the token
text
6. Retrieving Listings For An Asset
Image without caption
Param Name
Desription
Type
contract_address
Address of the contract for this NFT
text
token_id
Token ID for this item
text
limit
Limit. Defaults to 20, capped at 50
number
7. Retrieving Offers For An Asset
Image without caption
Param Name
Desription
Type
contract_address
Address of the contract for this NFT
text
token_id
Token ID for this item
text
limit
Limit. Defaults to 20, capped at 50
number
8.Retrieving A Single Contract
Image without caption
Param Name
Desription
Type
asset_contract_address
Address of the contract
text
9.Retrieving A Single Collection
Image without caption
Param Name
Description
Type
collection_slug
The collection slug of this collection is used to uniquely link to this collection on OpenSea
text
10.Retrieving Collection Stats
Image without caption
Param Name
Description
Type
collection_slug
The collection slug of this collection is used to uniquely link to this collection on OpenSea
text
11.Retrieving Orders
Image without caption
Image without caption
Param Name
Desription
Type
asset_contract_address
Filter by smart contract address for the asset category. Needs to be defined together with token_id or token_ids
text
payment_token_address
Filter by the address of the smart contract of the payment token that is accepted or offered by the order
text
maker
Filter by the order maker's wallet address
Text
taker
Filter by the order taker's wallet address. Orders open for any taker have the null address as their taker
Text
owner
Filter by the asset owner's wallet address
Text
is_english
When "true", only show English Auction sell orders, which wait for the highest bidder. When "false", exclude those
Boolean
bundled
Only show orders for bundles of assets
Boolean
include_bundled
Include orders on bundles where all assets in the bundle share the address provided in asset_contract_address or where the bundle's maker is the address provided in the owner
Boolean
listed_after
Only show orders listed after this timestamp. Seconds since the Unix epoch
Date-time
listed_before
Only show orders listed before this timestamp. Seconds since the Unix epoch
Date-time
token_id
Filter by the token ID of the order's asset. Needs to be defined together with asset_contract_addres
Text
token_ids
Filter by a list of token IDs for the order's asset. Needs to be defined together with asset_contract_address
List of texts
side
Filter by the side of the order. 0 for buy orders and 1 for sell orders
Number

Workflow example

All actions are data received from the Opensea service. Use this data as like a data source for state or data source for repeating group or a simple group.
Image without caption

Changelogs

  • added -
  • fixed -

Helpful?