/

OpenSea - NFT marketplace

✅

Link to plugin page: https://zeroqode.com/version-live/plugin/opensea---nft-marketplace-1656504576153x180371562815977440

Demo to preview the plugin:

✅

Live Demo: https://pwc-data-layer-demo.bubbleapps.io/opensea

✅

Bubble Editor: https://bubble.io/page?type=page&name=opensea&id=pwc-data-layer-demo&test_plugin=1649935005300x697514891872829400_current&tab=tabs-1

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.

Image without caption

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.

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/api-keys

Steps to request an API key

Follow these steps to request an API key. Each account can generate up to three API keys.

On opensea.io, hover over your Profile icon and select Settings.

On the left side of the page, click Developer.

Click Verify in profile to verify your email address. Anonymous email addresses are not supported at this time.

After verifying your email address, navigate back to the Developer section and click Get access.

Image without caption

Fill out your Organization Name, Website, and Intended use of the OpenSea API.

Image without caption

Click Submit.

Fill out the Recaptcha.

You’ll be directed back to the Developer section in your Account settings. Click Create API key.

Name your key and click Create new key.

Image without caption

You’ll be able to see your API key and the key’s expiration date.

Image without caption

To use your API key, include it in the plugin tabs in the X-API-KEY(shared headers) field.

Image without caption

More information on the OpenSea documentation: https://docs.opensea.io/reference/api-keys

Plugin Data/Action Calls

Shared Headers:

Name	Description	Type
X-API-KEY	API key allows you to access the Stream API and all V1 and V2 endpoints. You can use your API key on mainnet, but the testnet endpoints do not require keys.	Text

Get Collection Stats

Get stats for a single collection.

Name	Description	Type
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field	Text
Collection_slug	TODO: Fill in description	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body total volume": "number",
  "body total sales": "number",
  "body total average_price": "number",
  "body total num_owners": "number",
  "body total market_cap": "number",
  "body total floor_price": "number",
  "body total floor_price_symbol": "text",
  "body intervals": {
    "interval": "text",
    "volume": "number",
    "volume_diff": "number",
    "volume_change": "number",
    "sales": "number",
    "sales_diff": "number",
    "average_price": "number"  },
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get Events

Get a list of events based on before and after timestamps.

Name	Description	Type
After	Ilter to only include events that occurred at or after the given timestamp. The Unix epoch timstamp must be in seconds	Text
Before	Filter to only include events that occurred before the given timestamp. The Unix epoch timstamp must be in seconds.	Text
Event_type	The type of event to filter by. If not provided, only sales will be returned.	Text
Limit	The number of events to return. Must be between 1 and 50. Default: 50	Text
Next	The cursor for the next page of results. This is returned from a previous request.	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body asset_events": {
    "event_type": "text",
    "order_hash": "text",
    "order_type": "text",
    "chain": "text",
    "protocol_address": "text",
    "start_date": "number",
    "expiration_date": "number",
    "asset": "text",
    "quantity": "number",
    "maker": "text",
    "taker": "text",
    "payment quantity": "text",
    "payment token_address": "text",
    "payment decimals": "number",
    "payment symbol": "text",
    "criteria collection slug": "text",
    "criteria contract address": "text",
    "criteria trait type": "text",
    "criteria trait value": "text",
    "criteria encoded_token_ids": "text",
    "event_timestamp": "number",
    "is_private_listing": "boolean",
    "asset identifier": "text",
    "asset collection": "text",
    "asset contract": "text",
    "asset token_standard": "text",
    "asset name": "text",
    "asset description": "text",
    "asset image_url": "text",
    "asset metadata_url": "text",
    "asset opensea_url": "text",
    "asset updated_at": "text",
    "asset is_disabled": "boolean",
    "asset is_nsfw": "boolean",
    "criteria trait": "text"  
  },
  "body next": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"
}

Get Events (by account)

Get a list of events for an account.

Name	Description	Type
After	Ilter to only include events that occurred at or after the given timestamp. The Unix epoch timstamp must be in seconds	Text
Before	Filter to only include events that occurred before the given timestamp. The Unix epoch timstamp must be in seconds.	Text
Event_type	The type of event to filter by. If not provided, only sales will be returned.	Text
Limit	The number of events to return. Must be between 1 and 50. Default: 50	Text
Next	The cursor for the next page of results. This is returned from a previous request.	Text
Chain	The blockchain on which to filter the results.	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field	Text
Address	The public blockchain address.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body asset_events": {
    "event_type": "text",
    "chain": "text",
    "transaction": "text",
    "from_address": "text",
    "to_address": "text",
    "quantity": "number",
    "nft identifier": "text",
    "nft collection": "text",
    "nft contract": "text",
    "nft token_standard": "text",
    "nft name": "text",
    "nft description": "text",
    "nft image_url": "text",
    "nft metadata_url": "text",
    "nft opensea_url": "text",
    "nft updated_at": "text",
    "nft is_disabled": "boolean",
    "nft is_nsfw": "boolean",
    "event_timestamp": "number"  
  },
  "body next": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"
}

Get Events (by collection)

Get a list of events for a collection.

Name	Description	Type
After	Ilter to only include events that occurred at or after the given timestamp. The Unix epoch timstamp must be in seconds	Text
Before	Filter to only include events that occurred before the given timestamp. The Unix epoch timstamp must be in seconds.	Text
Event_type	The type of event to filter by. If not provided, only sales will be returned.	Text
Limit	The number of events to return. Must be between 1 and 50. Default: 50	Text
Next	The cursor for the next page of results. This is returned from a previous request.	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field	Text
Collection_slug	Unique string to identify a collection on OpenSea. This can be found by visiting the collection on the OpenSea website and noting the last path parameter.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body asset_events": {
    "event_type": "text",
    "chain": "text",
    "transaction": "text",
    "from_address": "text",
    "to_address": "text",
    "quantity": "number",
    "nft identifier": "text",
    "nft collection": "text",
    "nft contract": "text",
    "nft token_standard": "text",
    "nft name": "text",
    "nft description": "text",
    "nft image_url": "text",
    "nft metadata_url": "text",
    "nft opensea_url": "text",
    "nft updated_at": "text",
    "nft is_disabled": "boolean",
    "nft is_nsfw": "boolean",
    "event_timestamp": "number"  
  },
  "body next": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"
}

Get Events (by NFT)

Get a list of events for a single NFT.

Name	Description	Type
After	Ilter to only include events that occurred at or after the given timestamp. The Unix epoch timstamp must be in seconds	Text
Before	Filter to only include events that occurred before the given timestamp. The Unix epoch timstamp must be in seconds.	Text
Event_type	The type of event to filter by. If not provided, only sales will be returned.	Text
Limit	The number of events to return. Must be between 1 and 50. Default: 50	Text
Next	The cursor for the next page of results. This is returned from a previous request.	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field	Text
Chain	Available values: arbitrum arbitrum_nova arbitrum_sepolia avalanche avalanche_fuji baobab base base_sepolia bsc bsctestnet ethereum klaytn matic mumbai optimism optimism_sepolia sepolia solana soldev zora zora_sepolia	Text
Address	The blockchain on which to filter the results.	Text
Identifier	The NFT token id	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body asset_events": {
    "event_type": "text",
    "order_hash": "text",
    "order_type": "text",
    "chain": "text",
    "protocol_address": "text",
    "start_date": "number",
    "expiration_date": "number",
    "asset identifier": "text",
    "asset collection": "text",
    "asset contract": "text",
    "asset token_standard": "text",
    "asset name": "text",
    "asset description": "text",
    "asset image_url": "text",
    "asset metadata_url": "text",
    "asset opensea_url": "text",
    "asset updated_at": "text",
    "asset is_disabled": "boolean",
    "asset is_nsfw": "boolean",
    "quantity": "number",
    "maker": "text",
    "taker": "text",
    "payment quantity": "text",
    "payment token_address": "text",
    "payment decimals": "number",
    "payment symbol": "text",
    "event_timestamp": "number",
    "is_private_listing": "boolean"  
  },
  "body next": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get Account

Get an OpenSea Account Profile including details such as bio, social media usernames, and profile image.

Name	Description	Type
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field	Text
Address	TODO: Fill in description	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body address": "text",
  "body username": "text",
  "body profile_image_url": "text",
  "body banner_image_url": "text",
  "body website": "text",
  "body bio": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get Collection

Get a single collection including details such as fees, traits, and links.

Name	Description	Type
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field	Text
Collection_slug	TODO: Fill in description	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body collection": "text",
  "body name": "text",
  "body description": "text",
  "body image_url": "text",
  "body banner_image_url": "text",
  "body owner": "text",
  "body safelist_status": "text",
  "body category": "text",
  "body is_disabled": "boolean",
  "body is_nsfw": "boolean",
  "body trait_offers_enabled": "boolean",
  "body collection_offers_enabled": "boolean",
  "body opensea_url": "text",
  "body project_url": "text",
  "body wiki_url": "text",
  "body discord_url": "text",
  "body telegram_url": "text",
  "body twitter_username": "text",
  "body instagram_username": "text",
  "body contracts": {
    "address": "text",
    "chain": "text"  },
  "body editors": "list.text",
  "body fees": {
    "fee": "number",
    "recipient": "text",
    "required": "boolean"  },
  "body payment_tokens": {
    "symbol": "text",
    "address": "text",
    "chain": "text",
    "image": "text",
    "name": "text",
    "decimals": "number",
    "eth_price": "text",
    "usd_price": "text"  },
  "body total_supply": "number",
  "body created_date": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"
  }

Get Collections

Get a list of OpenSea collections.

Name	Description	Type
Chain	The blockchain on which to filter the results. Available values:, arbitrum, arbitrum_nova, arbitrum_sepolia, avalanche, avalanche_fuji, baobab, base, base_sepolia, bsc, bsctestnet, ethereum, klaytn, matic, mumbai, optimism, optimism_sepolia, sepolia, solana, soldev, zora, zora_sepolia	Text
Creator_username	If set, will only return collections created by the given OpenSea username.	Text
Include_hidden	If true, will return hidden collections. Default: false,	Text
Limit	The number of collections to return. Must be between 1 and 100. Default: 100	Text
Next	The cursor for the next page of results. This is returned from a previous request.	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body collections": {
    "collection": "text",
    "name": "text",
    "description": "text",
    "image_url": "text",
    "banner_image_url": "text",
    "owner": "text",
    "safelist_status": "text",
    "category": "text",
    "is_disabled": "boolean",
    "is_nsfw": "boolean",
    "trait_offers_enabled": "boolean",
    "collection_offers_enabled": "boolean",
    "opensea_url": "text",
    "project_url": "text",
    "wiki_url": "text",
    "discord_url": "text",
    "telegram_url": "text",
    "twitter_username": "text",
    "instagram_username": "text",
    "contracts": {
      "address": "text",
      "chain": "text"    }  },
  "body next": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get NFT

Get metadata, traits, ownership information, and rarity for a single NFT.

Name	Description	Type
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field	Text
Address	The public blockchain address.	Text
Identifier	The NFT token id.	Text
Chain	The blockchain on which to filter the results. Available values:, arbitrum, arbitrum_nova, arbitrum_sepolia, avalanche, avalanche_fuji, baobab, base, base_sepolia, bsc, bsctestnet, ethereum, klaytn, matic, mumbai, optimism, optimism_sepolia, sepolia, solana, soldev, zora, zora_sepolia	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body nft identifier": "text",
  "body nft collection": "text",
  "body nft contract": "text",
  "body nft token_standard": "text",
  "body nft name": "text",
  "body nft description": "text",
  "body nft image_url": "text",
  "body nft metadata_url": "text",
  "body nft opensea_url": "text",
  "body nft updated_at": "text",
  "body nft is_disabled": "boolean",
  "body nft is_nsfw": "boolean",
  "body nft animation_url": "text",
  "body nft is_suspicious": "boolean",
  "body nft creator": "text",
  "body nft traits": {
    "trait_type": "text",
    "display_type": "text",
    "max_value": "text",
    "value": "text"  },
  "body nft owners": {
    "address": "text",
    "quantity": "number"  },
  "body nft rarity strategy_id": "text",
  "body nft rarity strategy_version": "text",
  "body nft rarity rank": "number",
  "body nft rarity score": "text",
  "body nft rarity calculated_at": "text",
  "body nft rarity max_rank": "text",
  "body nft rarity tokens_scored": "number",
  "body nft rarity ranking_features": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get NFTs (by account)

Get NFTs owned by a given account address.

Name	Description	Type
Collection	Unique string to identify a collection on OpenSea. This can be found by visiting the collection on the OpenSea website and noting the last path parameter.	Text
Limit	The number of NFTs to return. Must be between 1 and 200. Default: 50	Text
Next	The cursor for the next page of results. This is returned from a previous request.	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field	Text
Address	The public blockchain address.	Text
Chain	The blockchain on which to filter the results., Available values:, arbitrum, arbitrum_nova, arbitrum_sepolia, avalanche, avalanche_fuji, baobab, base, base_sepolia, bsc, bsctestnet, ethereum, klaytn, matic, mumbai, optimism, optimism_sepolia, sepolia, solana, soldev, zora, zora_sepolia	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body nfts": {
    "identifier": "text",
    "collection": "text",
    "contract": "text",
    "token_standard": "text",
    "name": "text",
    "description": "text",
    "image_url": "text",
    "metadata_url": "text",
    "opensea_url": "text",
    "updated_at": "text",
    "is_disabled": "boolean",
    "is_nsfw": "boolean"  },
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get NFTs (by collection)

Get multiple NFTs for a collection.

Name	Description	Type
Limit	The number of NFTs to return. Must be between 1 and 200. Default: 50	Text
Next	The cursor for the next page of results. This is returned from a previous request.	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Collection_slug	Unique string to identify a collection on OpenSea. This can be found by visiting the collection on the OpenSea website and noting the last path parameter.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body nfts": {
    "identifier": "text",
    "collection": "text",
    "contract": "text",
    "token_standard": "text",
    "name": "text",
    "description": "text",
    "image_url": "text",
    "metadata_url": "text",
    "opensea_url": "text",
    "updated_at": "text",
    "is_disabled": "boolean",
    "is_nsfw": "boolean"  },
  "body next": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get NFTs (by contract)

Get multiple NFTs for a smart contract.

Name	Description	Type
Limit	The number of NFTs to return. Must be between 1 and 200. Default: 50	Text
Next	The cursor for the next page of results. This is returned from a previous request.	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Chain	The blockchain on which to filter the results. Available values:, arbitrum, arbitrum_nova, arbitrum_sepolia, avalanche, avalanche_fuji, baobab, base, base_sepolia, bsc, bsctestnet, ethereum, klaytn, matic, mumbai, optimism, optimism_sepolia, sepolia, solana, soldev, zora, zora_sepolia	Text
Address	The public blockchain address.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body nfts": {
    "identifier": "text",
    "collection": "text",
    "contract": "text",
    "token_standard": "text",
    "name": "text",
    "description": "text",
    "image_url": "text",
    "metadata_url": "text",
    "opensea_url": "text",
    "updated_at": "text",
    "is_disabled": "boolean",
    "is_nsfw": "boolean"  },
  "body next": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get Payment Token

Get a smart contract for a given chain and address.

Name	Description	Type
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Chain	The blockchain on which to filter the results. Available values:, arbitrum, arbitrum_nova, arbitrum_sepolia, avalanche, avalanche_fuji, baobab, base, base_sepolia, bsc, bsctestnet, ethereum, klaytn, matic, mumbai, optimism, optimism_sepolia, sepolia, solana, soldev, zora, zora_sepolia	Text
Address	The public blockchain address. (token address)	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body symbol": "text",
  "body address": "text",
  "body chain": "text",
  "body image": "text",
  "body name": "text",
  "body decimals": "number",
  "body eth_price": "text",
  "body usd_price": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get Traits

Get the traits in a collection.

Name	Description	Type
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Collection_slug	Unique string to identify a collection on OpenSea. This can be found by visiting the collection on the OpenSea website and noting the last path parameter.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body categories Artist": "text",
  "body categories Key Edition": "text",
  "body categories Collection": "text",
  "body categories Gallery": "text",
  "body categories DOWN LEVEL": "text",
  "body categories Edition Type": "text",
  "body categories Burn Tier": "text",
  "body counts Artist NessGraphics": "number",
  "body counts Key Edition First": "number",
  "body counts Collection gm:gn": "number",
  "body counts Gallery Pellas Gallery": "number",
  "body counts Gallery Avant Arte": "number",
  "body counts DOWN LEVEL EXTREMELY BAD": "number",
  "body counts Edition Type Burn Reward": "number",
  "body counts Burn Tier Level 5": "number",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get All Listings (by collection)

Get all active, valid listings for a single collection.

Name	Description	Type
Limit	The number of listings to return. Must be between 1 and 100. Default: 100	Text
Next	The cursor for the next page of results. This is returned from a previous request.	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Collection_slug	Unique string to identify a collection on OpenSea. This can be found by visiting the collection on the OpenSea website and noting the last path parameter.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body listings": {
    "order_hash": "text",
    "chain": "text",
    "type": "text",
    "price current currency": "text",
    "price current decimals": "number",
    "price current value": "text",
    "protocol_data parameters offerer": "text",
    "protocol_data parameters offer": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text"    },
    "protocol_data parameters consideration": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text",
      "recipient": "text"    },
    "protocol_data parameters startTime": "text",
    "protocol_data parameters endTime": "text",
    "protocol_data parameters orderType": "number",
    "protocol_data parameters zone": "text",
    "protocol_data parameters zoneHash": "text",
    "protocol_data parameters salt": "text",
    "protocol_data parameters conduitKey": "text",
    "protocol_data parameters totalOriginalConsiderationItems": "number",
    "protocol_data parameters counter": "number",
    "protocol_data signature": "text",
    "protocol_address": "text"  },
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get All Offers (by collection)

Get all active, valid offers for the specified collection. This includes individual and criteria offers.

Name	Description	Type
Limit	The number of listings to return. Must be between 1 and 100. Default: 100	Text
Next	The cursor for the next page of results. This is returned from a previous request.	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Collection_slug	Unique string to identify a collection on OpenSea. This can be found by visiting the collection on the OpenSea website and noting the last path parameter.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body offers": {
    "order_hash": "text",
    "chain": "text",
    "price currency": "text",
    "price decimals": "number",
    "price value": "text",
    "criteria": "text",
    "protocol_data parameters offerer": "text",
    "protocol_data parameters offer": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text"    },
    "protocol_data parameters consideration": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text",
      "recipient": "text"    },
    "protocol_data parameters startTime": "text",
    "protocol_data parameters endTime": "text",
    "protocol_data parameters orderType": "number",
    "protocol_data parameters zone": "text",
    "protocol_data parameters zoneHash": "text",
    "protocol_data parameters salt": "text",
    "protocol_data parameters conduitKey": "text",
    "protocol_data parameters totalOriginalConsiderationItems": "number",
    "protocol_data parameters counter": "number",
    "protocol_data signature": "text",
    "protocol_address": "text"  },
  "body next": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get Best Listing (by NFT)

Get the best listing for an NFT

Name	Description	Type
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Collection_slug	Unique string to identify a collection on OpenSea. This can be found by visiting the collection on the OpenSea website and noting the last path parameter.	Text
Identifier	The NFT token id.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body order_hash": "text",
  "body chain": "text",
  "body type": "text",
  "body price current currency": "text",
  "body price current decimals": "number",
  "body price current value": "text",
  "body protocol_data parameters offerer": "text",
  "body protocol_data parameters offer": {
    "itemType": "number",
    "token": "text",
    "identifierOrCriteria": "text",
    "startAmount": "text",
    "endAmount": "text"  },
  "body protocol_data parameters consideration": {
    "itemType": "number",
    "token": "text",
    "identifierOrCriteria": "text",
    "startAmount": "text",
    "endAmount": "text",
    "recipient": "text"  },
  "body protocol_data parameters startTime": "text",
  "body protocol_data parameters endTime": "text",
  "body protocol_data parameters orderType": "number",
  "body protocol_data parameters zone": "text",
  "body protocol_data parameters zoneHash": "text",
  "body protocol_data parameters salt": "text",
  "body protocol_data parameters conduitKey": "text",
  "body protocol_data parameters totalOriginalConsiderationItems": "number",
  "body protocol_data parameters counter": "number",
  "body protocol_data signature": "text",
  "body protocol_address": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get Best Listings (by collection)

Get the cheapest priced active, valid listings on a single collection.

Name	Description	Type
Limit	The number of listings to return. Must be between 1 and 100. Default: 100	Text
Next	The cursor for the next page of results. This is returned from a previous request.	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Collection_slug	Unique string to identify a collection on OpenSea. This can be found by visiting the collection on the OpenSea website and noting the last path parameter.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body listings": {
    "order_hash": "text",
    "chain": "text",
    "type": "text",
    "price current currency": "text",
    "price current decimals": "number",
    "price current value": "text",
    "protocol_data parameters offerer": "text",
    "protocol_data parameters offer": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text"    },
    "protocol_data parameters consideration": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text",
      "recipient": "text"    },
    "protocol_data parameters startTime": "text",
    "protocol_data parameters endTime": "text",
    "protocol_data parameters orderType": "number",
    "protocol_data parameters zone": "text",
    "protocol_data parameters zoneHash": "text",
    "protocol_data parameters salt": "text",
    "protocol_data parameters conduitKey": "text",
    "protocol_data parameters totalOriginalConsiderationItems": "number",
    "protocol_data parameters counter": "number",
    "protocol_data signature": "text",
    "protocol_address": "text"  },
  "body next": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get Best Offer (by NFT)

Get the best offers for an NFT

Name	Description	Type
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Collection_slug	Unique string to identify a collection on OpenSea. This can be found by visiting the collection on the OpenSea website and noting the last path parameter.	Text
Identifier	The NFT token id.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body order_hash": "text",
  "body chain": "text",
  "body price currency": "text",
  "body price decimals": "number",
  "body price value": "text",
  "body criteria collection slug": "text",
  "body criteria contract address": "text",
  "body criteria trait": "text",
  "body criteria encoded_token_ids": "text",
  "body protocol_data parameters offerer": "text",
  "body protocol_data parameters offer": {
    "itemType": "number",
    "token": "text",
    "identifierOrCriteria": "text",
    "startAmount": "text",
    "endAmount": "text"  },
  "body protocol_data parameters consideration": {
    "itemType": "number",
    "token": "text",
    "identifierOrCriteria": "text",
    "startAmount": "text",
    "endAmount": "text",
    "recipient": "text"  },
  "body protocol_data parameters startTime": "text",
  "body protocol_data parameters endTime": "text",
  "body protocol_data parameters orderType": "number",
  "body protocol_data parameters zone": "text",
  "body protocol_data parameters zoneHash": "text",
  "body protocol_data parameters salt": "text",
  "body protocol_data parameters conduitKey": "text",
  "body protocol_data parameters totalOriginalConsiderationItems": "number",
  "body protocol_data parameters counter": "number",
  "body protocol_data signature": "text",
  "body protocol_address": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get Collection Offers

Get the active, valid collection offers for the specified collection.

Name	Description	Type
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Collection_slug	Unique string to identify a collection on OpenSea. This can be found by visiting the collection on the OpenSea website and noting the last path parameter.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body offers": {
    "order_hash": "text",
    "chain": "text",
    "price currency": "text",
    "price decimals": "number",
    "price value": "text",
    "criteria collection slug": "text",
    "criteria contract address": "text",
    "criteria trait": "text",
    "criteria encoded_token_ids": "text",
    "protocol_data parameters offerer": "text",
    "protocol_data parameters offer": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text"    },
    "protocol_data parameters consideration": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text",
      "recipient": "text"    },
    "protocol_data parameters startTime": "text",
    "protocol_data parameters endTime": "text",
    "protocol_data parameters orderType": "number",
    "protocol_data parameters zone": "text",
    "protocol_data parameters zoneHash": "text",
    "protocol_data parameters salt": "text",
    "protocol_data parameters conduitKey": "text",
    "protocol_data parameters totalOriginalConsiderationItems": "number",
    "protocol_data parameters counter": "number",
    "protocol_data signature": "text",
    "protocol_address": "text"  },
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get Item Offers

TODO: add description to the api call.

Name	Description	Type
Asset_contract_address	Filter results by the contract address for NFT(s)., NOTE: If used, token_ids or token_id is required.	Text
Cursor	The cursor for the next page of results. This is returned from a previous request.	Text
Limit	The number of orders to return. Must be between 1 and 50. Default: 20	Text
Listed_after	Filter to only include orders that were listed after the given timestamp. This is a Unix epoch timestamp in seconds.	Text
Listed_before	Filter to only include orders that were listed before the given timestamp. This is a Unix epoch timestamp in seconds.	Text
Maker	Filter results by the order maker’s wallet address.	Text
Order_by	The order in which to sort the results. Default: created_date, NOTE: If eth_price is used, asset_contract_address and token_id are required. Available values:, created_date, eth_price	Text
Order_direction	The direction in which to sort the results. Default: desc, Available options:, asc, decs,	Text
Payment_token_address	Payment Token Address to filter results. This ensures all returned orders are listed in a single currency.	Text
Taker	Filter results by the order taker’s wallet address.	Text
Token_ids	An array of token IDs to search for (e.g. ?token_ids=1&token_ids=209). This endpoint will return a list of orders with token_id matching any of the IDs in this array., NOTE: If used, asset_contract_address is required.	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Chain	The blockchain on which to filter the results. Available values:, arbitrum, arbitrum_nova, arbitrum_sepolia, avalanche, avalanche_fuji, baobab, base, base_sepolia, bsc, bsctestnet, ethereum, klaytn, matic, mumbai, optimism, optimism_sepolia, sepolia, solana, soldev, zora, zora_sepolia	Text
Protocol	The token settlement protocol to use in the request.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body next": "text",
  "body previous": "text",
  "body orders": {
    "created_date": "text",
    "closing_date": "text",
    "listing_time": "number",
    "expiration_time": "number",
    "order_hash": "text",
    "protocol_data parameters offerer": "text",
    "protocol_data parameters offer": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text"    },
    "protocol_data parameters consideration": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text",
      "recipient": "text"    },
    "protocol_data parameters startTime": "text",
    "protocol_data parameters endTime": "text",
    "protocol_data parameters orderType": "number",
    "protocol_data parameters zone": "text",
    "protocol_data parameters zoneHash": "text",
    "protocol_data parameters salt": "text",
    "protocol_data parameters conduitKey": "text",
    "protocol_data parameters totalOriginalConsiderationItems": "number",
    "protocol_data parameters counter": "number",
    "protocol_data signature": "text",
    "protocol_address": "text",
    "current_price": "text",
    "maker user": "number",
    "maker profile_img_url": "text",
    "maker address": "text",
    "maker config": "text",
    "taker": "text",
    "taker_fees": {
      "account user": "text",
      "account profile_img_url": "text",
      "account address": "text",
      "account config": "text",
      "basis_points": "text"    },
    "side": "text",
    "order_type": "text",
    "cancelled": "boolean",
    "finalized": "boolean",
    "marked_invalid": "boolean",
    "remaining_quantity": "number",
    "relay_id": "text",
    "criteria_proof": "text",
    "maker_asset_bundle assets": {
      "id": "text",
      "token_id": "text",
      "num_sales": "number",
      "background_color": "text",
      "image_url": "text",
      "image_preview_url": "text",
      "image_thumbnail_url": "text",
      "image_original_url": "text",
      "animation_url": "text",
      "animation_original_url": "text",
      "name": "text",
      "description": "text",
      "external_link": "text",
      "asset_contract address": "text",
      "asset_contract asset_contract_type": "text",
      "asset_contract chain_identifier": "text",
      "asset_contract created_date": "text",
      "asset_contract name": "text",
      "asset_contract nft_version": "text",
      "asset_contract opensea_version": "text",
      "asset_contract owner": "text",
      "asset_contract schema_name": "text",
      "asset_contract symbol": "text",
      "asset_contract total_supply": "text",
      "asset_contract description": "text",
      "asset_contract external_link": "text",
      "asset_contract image_url": "text",
      "asset_contract default_to_fiat": "boolean",
      "asset_contract dev_buyer_fee_basis_points": "number",
      "asset_contract dev_seller_fee_basis_points": "number",
      "asset_contract only_proxied_transfers": "boolean",
      "asset_contract opensea_buyer_fee_basis_points": "number",
      "asset_contract opensea_seller_fee_basis_points": "number",
      "asset_contract buyer_fee_basis_points": "number",
      "asset_contract seller_fee_basis_points": "number",
      "asset_contract payout_address": "text",
      "permalink": "text",
      "collection banner_image_url": "text",
      "collection chat_url": "text",
      "collection created_date": "text",
      "collection default_to_fiat": "boolean",
      "collection description": "text",
      "collection dev_buyer_fee_basis_points": "text",
      "collection dev_seller_fee_basis_points": "text",
      "collection discord_url": "text",
      "collection display_data card_display_style": "text",
      "collection external_url": "text",
      "collection featured": "boolean",
      "collection featured_image_url": "text",
      "collection hidden": "boolean",
      "collection safelist_request_status": "text",
      "collection image_url": "text",
      "collection is_subject_to_whitelist": "boolean",
      "collection large_image_url": "text",
      "collection medium_username": "text",
      "collection name": "text",
      "collection only_proxied_transfers": "boolean",
      "collection opensea_buyer_fee_basis_points": "text",
      "collection opensea_seller_fee_basis_points": "number",
      "collection payout_address": "text",
      "collection require_email": "boolean",
      "collection short_description": "text",
      "collection slug": "text",
      "collection telegram_url": "text",
      "collection twitter_username": "text",
      "collection instagram_username": "text",
      "collection wiki_url": "text",
      "collection is_nsfw": "boolean",
      "collection fees opensea_fees 0x0000a26b00c1f0df003000390027140000faa719": "number",
      "collection is_rarity_enabled": "boolean",
      "collection is_creator_fees_enforced": "boolean",
      "decimals": "number",
      "token_metadata": "text",
      "is_nsfw": "boolean",
      "owner": "text"    },
    "maker_asset_bundle maker": "text",
    "maker_asset_bundle slug": "text",
    "maker_asset_bundle name": "text",
    "maker_asset_bundle description": "text",
    "maker_asset_bundle external_link": "text",
    "maker_asset_bundle asset_contract": "text",
    "maker_asset_bundle permalink": "text",
    "maker_asset_bundle seaport_sell_orders": "text",
    "taker_asset_bundle assets": {
      "id": "text",
      "token_id": "text",
      "num_sales": "number",
      "background_color": "text",
      "image_url": "text",
      "image_preview_url": "text",
      "image_thumbnail_url": "text",
      "image_original_url": "text",
      "animation_url": "text",
      "animation_original_url": "text",
      "name": "text",
      "description": "text",
      "external_link": "text",
      "asset_contract address": "text",
      "asset_contract asset_contract_type": "text",
      "asset_contract chain_identifier": "text",
      "asset_contract created_date": "text",
      "asset_contract name": "text",
      "asset_contract nft_version": "text",
      "asset_contract opensea_version": "text",
      "asset_contract owner": "number",
      "asset_contract schema_name": "text",
      "asset_contract symbol": "text",
      "asset_contract total_supply": "text",
      "asset_contract description": "text",
      "asset_contract external_link": "text",
      "asset_contract image_url": "text",
      "asset_contract default_to_fiat": "boolean",
      "asset_contract dev_buyer_fee_basis_points": "number",
      "asset_contract dev_seller_fee_basis_points": "number",
      "asset_contract only_proxied_transfers": "boolean",
      "asset_contract opensea_buyer_fee_basis_points": "number",
      "asset_contract opensea_seller_fee_basis_points": "number",
      "asset_contract buyer_fee_basis_points": "number",
      "asset_contract seller_fee_basis_points": "number",
      "asset_contract payout_address": "text",
      "permalink": "text",
      "collection banner_image_url": "text",
      "collection chat_url": "text",
      "collection created_date": "text",
      "collection default_to_fiat": "boolean",
      "collection description": "text",
      "collection dev_buyer_fee_basis_points": "text",
      "collection dev_seller_fee_basis_points": "text",
      "collection discord_url": "text",
      "collection display_data card_display_style": "text",
      "collection external_url": "text",
      "collection featured": "boolean",
      "collection featured_image_url": "text",
      "collection hidden": "boolean",
      "collection safelist_request_status": "text",
      "collection image_url": "text",
      "collection is_subject_to_whitelist": "boolean",
      "collection large_image_url": "text",
      "collection medium_username": "text",
      "collection name": "text",
      "collection only_proxied_transfers": "boolean",
      "collection opensea_buyer_fee_basis_points": "text",
      "collection opensea_seller_fee_basis_points": "number",
      "collection payout_address": "text",
      "collection require_email": "boolean",
      "collection short_description": "text",
      "collection slug": "text",
      "collection telegram_url": "text",
      "collection twitter_username": "text",
      "collection instagram_username": "text",
      "collection wiki_url": "text",
      "collection is_nsfw": "boolean",
      "collection fees opensea_fees 0x0000a26b00c1f0df003000390027140000faa719": "number",
      "collection is_rarity_enabled": "boolean",
      "collection is_creator_fees_enforced": "boolean",
      "decimals": "number",
      "token_metadata": "text",
      "is_nsfw": "boolean",
      "owner": "text",
      "collection display_data images": "text",
      "collection fees seller_fees 0x06af3189c3f7a86b57439b193441b0da16ebe15f": "number",
      "collection fees seller_fees 0x3dcb97ac03b6568e1d0b3e90a20ecc0f6dca34a4": "number",
      "collection fees seller_fees 0x37ceb4ba093d40234c6fb312d9791b67c04ef49a": "number",
      "collection fees seller_fees 0xc84cb8cdd2119c24832b8868907537046cddb706": "number",
      "collection fees seller_fees 0x209aa937ac59f60384a70b98fec5daf54ac7b967": "number",
      "collection fees seller_fees 0x88315564d9ba67357f3644c76340168ae904b924": "number",
      "collection fees seller_fees 0x1c272515a79f8ea1bbdeeda8e7e5120cf6141e47": "number",
      "collection fees seller_fees 0x48cf2a4b8a74974beabf8db1f45f9123edc79c06": "number",
      "collection fees seller_fees 0x0e4708e33a335a62d51075941285a952d6b8f395": "number",
      "collection fees seller_fees 0xb98cdacd006b9d47c37ca63cc86f916ee23fc550": "number",
      "collection fees seller_fees 0xd3ee0b784615c0a10f19aea180de9bab744bba66": "number",
      "collection fees seller_fees 0x2de038a402119bcbd49a4412c35f27670801ed4e": "number",
      "collection fees seller_fees 0x2ce780d7c743a57791b835a9d6f998b15bbba5a4": "number",
      "collection fees seller_fees 0x1afa64e9b8e3090f2001f66d9c9a74cde646738a": "number",
      "collection fees seller_fees 0x646066781544aa5c4ea3d4af690eda73125ecdf7": "number",
      "collection fees seller_fees 0x6650dc11f439f14d4dfbea75233bd9b0099a0647": "number"    },
    "taker_asset_bundle maker": "text",
    "taker_asset_bundle slug": "text",
    "taker_asset_bundle name": "text",
    "taker_asset_bundle description": "text",
    "taker_asset_bundle external_link": "text",
    "taker_asset_bundle asset_contract": "text",
    "taker_asset_bundle permalink": "text",
    "taker_asset_bundle seaport_sell_orders": "text"  },
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get Listings

Get the complete set of active, valid listings.

Name	Description	Type
Asset_contract_address	Filter results by the contract address for NFT(s)., NOTE: If used, token_ids or token_id is required.	Text
Cursor	The cursor for the next page of results. This is returned from a previous request.	Text
Limit	The number of orders to return. Must be between 1 and 50. Default: 20	Text
Listed_after	Filter to only include orders that were listed after the given timestamp. This is a Unix epoch timestamp in seconds.	Text
Listed_before	Filter to only include orders that were listed before the given timestamp. This is a Unix epoch timestamp in seconds.	Text
Maker	Filter results by the order maker’s wallet address.	Text
Order_by	The order in which to sort the results. Default: created_date, NOTE: If eth_price is used, asset_contract_address and token_id are required., , Available values:, created_date, eth_price ,	Text
Order_direction	The direction in which to sort the results. Default: desc, Available options:, asc, decs,	Text
Payment_token_address	Payment Token Address to filter results. This ensures all returned orders are listed in a single currency.	Text
Taker	Filter results by the order taker’s wallet address.	Text
Token_ids	An array of token IDs to search for (e.g. ?token_ids=1&token_ids=209). This endpoint will return a list of orders with token_id matching any of the IDs in this array., NOTE: If used, asset_contract_address is required.	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Chain	The blockchain on which to filter the results. Available values:, arbitrum, arbitrum_nova, arbitrum_sepolia, avalanche, avalanche_fuji, baobab, base, base_sepolia, bsc, bsctestnet, ethereum, klaytn, matic, mumbai, optimism, optimism_sepolia, sepolia, solana, soldev, zora, zora_sepolia	Text
Protocol	The token settlement protocol to use in the request.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body next": "text",
  "body previous": "text",
  "body orders": {
    "created_date": "text",
    "closing_date": "text",
    "listing_time": "number",
    "expiration_time": "number",
    "order_hash": "text",
    "protocol_data parameters offerer": "text",
    "protocol_data parameters offer": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text"    },
    "protocol_data parameters consideration": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text",
      "recipient": "text"    },
    "protocol_data parameters startTime": "text",
    "protocol_data parameters endTime": "text",
    "protocol_data parameters orderType": "number",
    "protocol_data parameters zone": "text",
    "protocol_data parameters zoneHash": "text",
    "protocol_data parameters salt": "text",
    "protocol_data parameters conduitKey": "text",
    "protocol_data parameters totalOriginalConsiderationItems": "number",
    "protocol_data parameters counter": "number",
    "protocol_data signature": "text",
    "protocol_address": "text",
    "current_price": "text",
    "maker user": "number",
    "maker profile_img_url": "text",
    "maker address": "text",
    "maker config": "text",
    "taker": "text",
    "maker_fees": {
      "account user": "text",
      "account profile_img_url": "text",
      "account address": "text",
      "account config": "text",
      "basis_points": "text"    },
    "side": "text",
    "order_type": "text",
    "cancelled": "boolean",
    "finalized": "boolean",
    "marked_invalid": "boolean",
    "remaining_quantity": "number",
    "relay_id": "text",
    "criteria_proof": "text",
    "maker_asset_bundle assets": {
      "id": "text",
      "token_id": "text",
      "num_sales": "number",
      "background_color": "text",
      "image_url": "text",
      "image_preview_url": "text",
      "image_thumbnail_url": "text",
      "image_original_url": "text",
      "animation_url": "text",
      "animation_original_url": "text",
      "name": "text",
      "description": "text",
      "external_link": "text",
      "asset_contract address": "text",
      "asset_contract asset_contract_type": "text",
      "asset_contract chain_identifier": "text",
      "asset_contract created_date": "text",
      "asset_contract name": "text",
      "asset_contract nft_version": "text",
      "asset_contract opensea_version": "text",
      "asset_contract owner": "number",
      "asset_contract schema_name": "text",
      "asset_contract symbol": "text",
      "asset_contract total_supply": "text",
      "asset_contract description": "text",
      "asset_contract external_link": "text",
      "asset_contract image_url": "text",
      "asset_contract default_to_fiat": "boolean",
      "asset_contract dev_buyer_fee_basis_points": "number",
      "asset_contract dev_seller_fee_basis_points": "number",
      "asset_contract only_proxied_transfers": "boolean",
      "asset_contract opensea_buyer_fee_basis_points": "number",
      "asset_contract opensea_seller_fee_basis_points": "number",
      "asset_contract buyer_fee_basis_points": "number",
      "asset_contract seller_fee_basis_points": "number",
      "asset_contract payout_address": "text",
      "permalink": "text",
      "collection banner_image_url": "text",
      "collection chat_url": "text",
      "collection created_date": "text",
      "collection default_to_fiat": "boolean",
      "collection description": "text",
      "collection dev_buyer_fee_basis_points": "text",
      "collection dev_seller_fee_basis_points": "text",
      "collection discord_url": "text",
      "collection display_data card_display_style": "text",
      "collection external_url": "text",
      "collection featured": "boolean",
      "collection featured_image_url": "text",
      "collection hidden": "boolean",
      "collection safelist_request_status": "text",
      "collection image_url": "text",
      "collection is_subject_to_whitelist": "boolean",
      "collection large_image_url": "text",
      "collection medium_username": "text",
      "collection name": "text",
      "collection only_proxied_transfers": "boolean",
      "collection opensea_buyer_fee_basis_points": "text",
      "collection opensea_seller_fee_basis_points": "number",
      "collection payout_address": "text",
      "collection require_email": "boolean",
      "collection short_description": "text",
      "collection slug": "text",
      "collection telegram_url": "text",
      "collection twitter_username": "text",
      "collection instagram_username": "text",
      "collection wiki_url": "text",
      "collection is_nsfw": "boolean",
      "collection fees seller_fees 0x20c7e34b61546cb6412afdb865ec83af2c173702": "number",
      "collection fees opensea_fees 0x0000a26b00c1f0df003000390027140000faa719": "number",
      "collection is_rarity_enabled": "boolean",
      "collection is_creator_fees_enforced": "boolean",
      "decimals": "number",
      "token_metadata": "text",
      "is_nsfw": "boolean",
      "owner": "text",
      "collection fees seller_fees 0x92d0e30cc90af56747f80046233711db15d6b291": "number",
      "collection fees seller_fees 0xbc1cb0dd9c0fa0e540f4d76ed1a4f1b9ca1b705d": "number",
      "collection fees seller_fees 0xa44913f1062a9dd139af92484d9b95206444cd5a": "number",
      "collection fees seller_fees 0x76085a52e92839959fa7cc96b3e7bacc2930a6ab": "number",
      "collection fees seller_fees 0x488c63dc589539f904167ac4fc41334c4349c748": "number",
      "collection fees seller_fees 0x557068a9b7d66f97a61b97c80541eb17672e1e6f": "number",
      "collection fees seller_fees 0x14c0fc0d8b5c82d65c1db1db3f507d08c5ae8711": "number",
      "collection fees seller_fees 0xffb0bbfb7e3c393fb09680490fd072ecf86d372b": "number",
      "collection fees seller_fees 0x99dc3711726169a6f8965f4fd3918da750a386bc": "number",
      "collection fees seller_fees 0x432ee918144eb63a45b6611c9318274baf26230d": "number",
      "collection fees seller_fees 0x5980565737bb2885790c79f126d2c862ad1dc8ab": "number",
      "collection display_data images": "text",
      "collection fees seller_fees 0x950f656d919e26dc59a331984ec7c8709dcce3d8": "number",
      "collection fees seller_fees 0xc0f982492c323fcd314af56d6c1a35cc9b0fc31e": "number",
      "collection fees seller_fees 0xa4e40b1d48312bfb09c8d0c9cd0fb925c05274e8": "number",
      "collection fees seller_fees 0xab3ff2e0726ec997022ea64f9f57eba1617c720a": "number",
      "collection fees seller_fees 0xc9913c16047fdc7650bc7ad4fb15d69f0746f532": "number",
      "collection fees seller_fees 0xade4c7461af8bb8cbf59536dcac0904d1473275d": "number",
      "collection fees seller_fees 0x688d6520d7917ed6a6a6fb8f3130b6998d879d0b": "number"    },
    "maker_asset_bundle maker": "text",
    "maker_asset_bundle slug": "text",
    "maker_asset_bundle name": "text",
    "maker_asset_bundle description": "text",
    "maker_asset_bundle external_link": "text",
    "maker_asset_bundle asset_contract": "text",
    "maker_asset_bundle permalink": "text",
    "maker_asset_bundle seaport_sell_orders": "text",
    "taker_asset_bundle assets": {
      "id": "text",
      "token_id": "text",
      "num_sales": "number",
      "background_color": "text",
      "image_url": "text",
      "image_preview_url": "text",
      "image_thumbnail_url": "text",
      "image_original_url": "text",
      "animation_url": "text",
      "animation_original_url": "text",
      "name": "text",
      "description": "text",
      "external_link": "text",
      "asset_contract address": "text",
      "asset_contract asset_contract_type": "text",
      "asset_contract chain_identifier": "text",
      "asset_contract created_date": "text",
      "asset_contract name": "text",
      "asset_contract nft_version": "text",
      "asset_contract opensea_version": "text",
      "asset_contract owner": "text",
      "asset_contract schema_name": "text",
      "asset_contract symbol": "text",
      "asset_contract total_supply": "text",
      "asset_contract description": "text",
      "asset_contract external_link": "text",
      "asset_contract image_url": "text",
      "asset_contract default_to_fiat": "boolean",
      "asset_contract dev_buyer_fee_basis_points": "number",
      "asset_contract dev_seller_fee_basis_points": "number",
      "asset_contract only_proxied_transfers": "boolean",
      "asset_contract opensea_buyer_fee_basis_points": "number",
      "asset_contract opensea_seller_fee_basis_points": "number",
      "asset_contract buyer_fee_basis_points": "number",
      "asset_contract seller_fee_basis_points": "number",
      "asset_contract payout_address": "text",
      "permalink": "text",
      "collection banner_image_url": "text",
      "collection chat_url": "text",
      "collection created_date": "text",
      "collection default_to_fiat": "boolean",
      "collection description": "text",
      "collection dev_buyer_fee_basis_points": "text",
      "collection dev_seller_fee_basis_points": "text",
      "collection discord_url": "text",
      "collection display_data card_display_style": "text",
      "collection external_url": "text",
      "collection featured": "boolean",
      "collection featured_image_url": "text",
      "collection hidden": "boolean",
      "collection safelist_request_status": "text",
      "collection image_url": "text",
      "collection is_subject_to_whitelist": "boolean",
      "collection large_image_url": "text",
      "collection medium_username": "text",
      "collection name": "text",
      "collection only_proxied_transfers": "boolean",
      "collection opensea_buyer_fee_basis_points": "text",
      "collection opensea_seller_fee_basis_points": "number",
      "collection payout_address": "text",
      "collection require_email": "boolean",
      "collection short_description": "text",
      "collection slug": "text",
      "collection telegram_url": "text",
      "collection twitter_username": "text",
      "collection instagram_username": "text",
      "collection wiki_url": "text",
      "collection is_nsfw": "boolean",
      "collection fees opensea_fees 0x0000a26b00c1f0df003000390027140000faa719": "number",
      "collection is_rarity_enabled": "boolean",
      "collection is_creator_fees_enforced": "boolean",
      "decimals": "number",
      "token_metadata": "text",
      "is_nsfw": "boolean",
      "owner": "text"    
    },
    "taker_asset_bundle maker": "text",
    "taker_asset_bundle slug": "text",
    "taker_asset_bundle name": "text",
    "taker_asset_bundle description": "text",
    "taker_asset_bundle external_link": "text",
    "taker_asset_bundle asset_contract": "text",
    "taker_asset_bundle permalink": "text",
    "taker_asset_bundle seaport_sell_orders": "text"  },
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"
  }

Get Order

Get a single order, offer or listing, by its order hash. Protocol and Chain are required to prevent hash collisions.

Name	Description	Type
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Chain	The blockchain on which to filter the results. Available values:, arbitrum, arbitrum_nova, arbitrum_sepolia, avalanche, avalanche_fuji, baobab, base, base_sepolia, bsc, bsctestnet, ethereum, klaytn, matic, mumbai, optimism, optimism_sepolia, sepolia, solana, soldev, zora, zora_sepolia	Text
Protocol_address	The hash of the order to retrieve.	Text
Order_hash	The contract address of the protocol to use in the request.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body order order_hash": "text",
  "body order chain": "text",
  "body order price currency": "text",
  "body order price decimals": "number",
  "body order price value": "text",
  "body order criteria": "text",
  "body order protocol_data parameters offerer": "text",
  "body order protocol_data parameters offer": {
    "itemType": "number",
    "token": "text",
    "identifierOrCriteria": "text",
    "startAmount": "text",
    "endAmount": "text"  },
  "body order protocol_data parameters consideration": {
    "itemType": "number",
    "token": "text",
    "identifierOrCriteria": "text",
    "startAmount": "text",
    "endAmount": "text",
    "recipient": "text"  },
  "body order protocol_data parameters startTime": "text",
  "body order protocol_data parameters endTime": "text",
  "body order protocol_data parameters orderType": "number",
  "body order protocol_data parameters zone": "text",
  "body order protocol_data parameters zoneHash": "text",
  "body order protocol_data parameters salt": "text",
  "body order protocol_data parameters conduitKey": "text",
  "body order protocol_data parameters totalOriginalConsiderationItems": "number",
  "body order protocol_data parameters counter": "text",
  "body order protocol_data signature": "text",
  "body order protocol_address": "text",
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Get Trait Offers

Get the active, valid trait offers for the specified collection.

Name	Description	Type
Float_value	The value of the trait (e.g. 0.5). This is only used for decimal-based numeric traits to ensure it is parsed correctly., ,	Text
Int_value	The value of the trait (e.g. 10). This is only used for numeric traits to ensure it is parsed correctly., ,	Text
Type	Required., The name of the trait (e.g. ‘Background’)	Text
Value	Required., The value of the trait (e.g. ‘Red’)	Text
Hash	In order not to send identical requests, hash is used. Use Current date/time for this field.	Text
Collection_slug	Unique string to identify a collection on OpenSea. This can be found by visiting the collection on the OpenSea website and noting the last path parameter.	Text
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text

Return Values: Return type: JSON

json
{
  "body offers": {
    "order_hash": "text",
    "chain": "text",
    "price currency": "text",
    "price decimals": "number",
    "price value": "text",
    "criteria collection slug": "text",
    "criteria contract address": "text",
    "criteria trait type": "text",
    "criteria trait value": "text",
    "criteria encoded_token_ids": "text",
    "protocol_data parameters offerer": "text",
    "protocol_data parameters offer": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text"    },
    "protocol_data parameters consideration": {
      "itemType": "number",
      "token": "text",
      "identifierOrCriteria": "text",
      "startAmount": "text",
      "endAmount": "text",
      "recipient": "text"    },
    "protocol_data parameters startTime": "text",
    "protocol_data parameters endTime": "text",
    "protocol_data parameters orderType": "number",
    "protocol_data parameters zone": "text",
    "protocol_data parameters zoneHash": "text",
    "protocol_data parameters salt": "text",
    "protocol_data parameters conduitKey": "text",
    "protocol_data parameters totalOriginalConsiderationItems": "number",
    "protocol_data parameters counter": "number",
    "protocol_data signature": "text",
    "protocol_address": "text"  },
  "error status_code": "number",
  "error status_message": "text",
  "error body": "text",
  "returned_an_error": "boolean"}

Build Criteria Offer

Build a portion of a criteria offer including the merkle tree needed to post an offer.

Name	Description	Type
Testnets-	If you are using testnets, then leave “testnets-” in the field, if not then remove it.	Text
Offerer	The address which supplies all the items in the offer.	Text
Quantity	The number of offers to place.	Text
Slug	Unique string to identify a collection on OpenSea. This can be found by visiting the collection on the OpenSea website and noting the last path parameter.	Text
Address	The public blockchain address of the NFT contract	Text
Trait type	The trait that the criteria offer’s type	Text
Trait value	The trait that the criteria offer’s value	Text
Protocol_address	Exchange contract address. Must be one of [‘0x00000000000000adc04c56bf30ac9d3c0aaf14dc’]	Text
Offer_protection_enabled	Builds the offer on OpenSea’s signed zone to provide offer protections from receiving an item which is disabled from trading. Available values:, true, false	Text

Return Values: Return type: JSON

json
{
  "partialParameters consideration": {
    "itemType": "number",
    "token": "text",
    "identifierOrCriteria": "text",
    "startAmount": "text",
    "endAmount": "text",
    "recipient": "text"  },
  "partialParameters zone": "text",
  "partialParameters zoneHash": "text",
  "encoded_token_ids": "text"}

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

Image without caption

Changelogs

Advanced Paypal Payments

Powered by Notaku

Helpful?

Content

OpenSea - NFT marketplace

Demo to preview the plugin:

Steps to request an API key

Plugin Data/Action Calls

Workflow example