> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenSea

> OpenSea is the world's first and largest NFT marketplace for NFTs and crypto collectibles.

![OpenSea logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/open_sea.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=645625d79e9a7123aa2f46dfdaff18ab)

* **Category:** ecommerce
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 24
* **Triggers:** 0
* **Slug:** `OPEN_SEA`
* **Version:** 20261101\_00

## Tools

> [accordion] Build criteria offer
>
> **Slug:** `OPEN_SEA_BUILD_CRITERIA_OFFER`
>
> Build a portion of a criteria offer including the merkle tree needed to post an offer.
>
> #### Input Parameters
>
> **offerer** `string` *required*
>
> The address which supplies all the items in the offer
>
> **criteria** `object` *required*
>
> Criteria for the collection or trait offer
>
> **quantity** `integer`
>
> The number of offers to place
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel order
>
> **Slug:** `OPEN_SEA_CANCEL_ORDER`
>
> Request offchain cancellation of a SignedZone-protected order, offer, or listing by chain, protocol, and order hash. Cancellation is only assured if a fulfillment signature was not vended beforehand; OpenSea requires a scoped bearer token for order cancellation.
>
> #### Input Parameters
>
> **chain** `string` *required*
>
> The blockchain on which to filter the results
>
> **order\_hash** `string` *required*
>
> The hash of the order to retrieve
>
> **protocol\_address** `string` *required*
>
> The contract address of the protocol to use in the request
>
> **offerer\_signature** `string`
>
> An EIP-712 signature from the offerer of the order. If not provided, the user associated with the API Key will be checked instead
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create criteria offer
>
> **Slug:** `OPEN_SEA_CREATE_CRITERIA_OFFER`
>
> Submit a criteria offer creation request to OpenSea. The accepted protocol data contains only a criteria protocol address, so collection or trait criteria and signed order details cannot be supplied.
>
> #### Input Parameters
>
> **protocol\_data** `object` *required*
>
> The signed order which will be submitted to Seaport
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create item offer
>
> **Slug:** `OPEN_SEA_CREATE_ITEM_OFFER`
>
> Submit an offer to purchase a single NFT (ERC721 or ERC1155). The order parameters accepted by this tool contain only the order type; a signature and protocol address are also required.
>
> #### Input Parameters
>
> **chain** `string` *required*
>
> The blockchain on which to filter the results
>
> **protocol** `string` *required*
>
> The token settlement protocol to use in the request
>
> **signature** `string` *required*
>
> Signature of the signed type data represented by the parameters field
>
> **parameters** `object` *required*
>
> Order components object containing the order details
>
> **protocol\_address** `string` *required*
>
> Exchange contract address. Must be one of \['0x0000000000000068f116a894984e2db1123eb395']
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create listing
>
> **Slug:** `OPEN_SEA_CREATE_LISTING`
>
> Submit a listing for a single NFT (ERC721 or ERC1155) on OpenSea. The order parameters accepted by this tool contain only the order type; a signature and protocol address are also required.
>
> #### Input Parameters
>
> **chain** `string` *required*
>
> The blockchain on which to filter the results
>
> **protocol** `string` *required*
>
> The token settlement protocol to use in the request
>
> **signature** `string` *required*
>
> Signature of the signed type data represented by the parameters field
>
> **parameters** `object` *required*
>
> Order components object containing the order details
>
> **protocol\_address** `string` *required*
>
> Exchange contract address. Must be one of \['0x0000000000000068f116a894984e2db1123eb395']
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fulfill listing
>
> **Slug:** `OPEN_SEA_FULFILL_LISTING`
>
> Request fulfillment information for an OpenSea listing, including transaction and order details intended for fulfilling it onchain. The request includes the fulfiller address; this tool does not itself execute the onchain transaction.
>
> #### Input Parameters
>
> **listing** `object` *required*
>
> Listing to get fulfillment data for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fulfill offer
>
> **Slug:** `OPEN_SEA_FULFILL_OFFER`
>
> Request fulfillment information for an OpenSea offer, including transaction and order details intended for fulfilling it onchain. The request includes the fulfiller address; this tool does not itself execute the onchain transaction.
>
> #### Input Parameters
>
> **offer** `object` *required*
>
> Offer to get fulfillment data for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get account
>
> **Slug:** `OPEN_SEA_GET_ACCOUNT`
>
> Get an OpenSea Account Profile including details such as bio, social media usernames, and profile image.
>
> #### Input Parameters
>
> **address\_or\_username** `string` *required*
>
> The public blockchain address or OpenSea username
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get all listings by collection
>
> **Slug:** `OPEN_SEA_GET_ALL_LISTINGS_BY_COLLECTION`
>
> Get a page of active, valid listings for a single collection, with cursor pagination.
>
> #### Input Parameters
>
> **next** `string`
>
> The cursor for the next page of results
>
> **limit** `integer`
>
> The number of listings to return. Must be between 1 and 100
>
> **collection\_slug** `string` *required*
>
> 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
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get all offers by collection
>
> **Slug:** `OPEN_SEA_GET_ALL_OFFERS_BY_COLLECTION`
>
> Get a page of active, valid offers for a collection, including individual and criteria offers, with cursor pagination.
>
> #### Input Parameters
>
> **next** `string`
>
> The cursor for the next page of results
>
> **limit** `integer`
>
> The number of offers to return. Must be between 1 and 100
>
> **collection\_slug** `string` *required*
>
> 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
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get best listing by nft
>
> **Slug:** `OPEN_SEA_GET_BEST_LISTING_BY_NFT`
>
> Get the best listing for an NFT.
>
> #### Input Parameters
>
> **identifier** `string` *required*
>
> The NFT token id
>
> **collection\_slug** `string` *required*
>
> 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
>
> **include\_private\_listings** `boolean`
>
> If true, will include private listings
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get best listings by collection
>
> **Slug:** `OPEN_SEA_GET_BEST_LISTINGS_BY_COLLECTION`
>
> Get the cheapest priced active, valid listings on a single collection.
>
> #### Input Parameters
>
> **next** `string`
>
> The cursor for the next page of results
>
> **limit** `integer`
>
> The number of listings to return. Must be between 1 and 100
>
> **collection\_slug** `string` *required*
>
> 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
>
> **include\_private\_listings** `boolean`
>
> If true, will include private listings
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get best offer by nft
>
> **Slug:** `OPEN_SEA_GET_BEST_OFFER_BY_NFT`
>
> Get the best offer for an NFT in a collection.
>
> #### Input Parameters
>
> **identifier** `string` *required*
>
> The NFT token id
>
> **collection\_slug** `string` *required*
>
> 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
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get collection
>
> **Slug:** `OPEN_SEA_GET_COLLECTION`
>
> Get a single collection by slug, including details such as fees and links.
>
> #### Input Parameters
>
> **collection\_slug** `string` *required*
>
> 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
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get collections
>
> **Slug:** `OPEN_SEA_GET_COLLECTIONS`
>
> Get a list of OpenSea collections with optional filtering and pagination.
>
> #### Input Parameters
>
> **next** `string`
>
> The cursor for the next page of results
>
> **chain** `string`
>
> The blockchain on which to filter the results
>
> **limit** `integer`
>
> The number of collections to return. Must be between 1 and 100
>
> **order\_by** `string`
>
> The order in which to sort the collections
>
> **include\_hidden** `boolean`
>
> If true, will return hidden collections
>
> **creator\_username** `string`
>
> If set, will only return collections created by the given OpenSea username
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get collection stats
>
> **Slug:** `OPEN_SEA_GET_COLLECTION_STATS`
>
> Get stats for a single collection on OpenSea.
>
> #### Input Parameters
>
> **collection\_slug** `string` *required*
>
> Unique string to identify a collection on OpenSea
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get contract
>
> **Slug:** `OPEN_SEA_GET_CONTRACT`
>
> Get a smart contract for a given chain and address.
>
> #### Input Parameters
>
> **chain** `string` *required*
>
> The blockchain on which to filter the results
>
> **address** `string` *required*
>
> The public blockchain address
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get events
>
> **Slug:** `OPEN_SEA_GET_EVENTS`
>
> Get a list of events from OpenSea based on various filters like timestamps and event types.
>
> #### Input Parameters
>
> **next** `string`
>
> The cursor for the next page of results
>
> **after** `integer`
>
> Filter to only include events that occurred at or after the given timestamp (Unix epoch in seconds)
>
> **limit** `integer`
>
> The number of events to return. Must be between 1 and 50
>
> **before** `integer`
>
> Filter to only include events that occurred before the given timestamp (Unix epoch in seconds)
>
> **event\_type** `array`
>
> The type of event to filter by. If not provided, only sales will be returned
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get listings
>
> **Slug:** `OPEN_SEA_GET_LISTINGS`
>
> Get a page of active, valid listings, with optional filters and a cursor for pagination.
>
> #### Input Parameters
>
> **chain** `string` *required*
>
> The blockchain on which to filter the results
>
> **limit** `integer`
>
> The number of orders to return. Must be between 1 and 50
>
> **maker** `string`
>
> Filter results by the order maker's wallet address
>
> **taker** `string`
>
> Filter results by the order taker's wallet address
>
> **cursor** `string`
>
> The cursor for the next page of results
>
> **order\_by** `string`
>
> The order in which to sort the results. If eth\_price is used, asset\_contract\_address and token\_id are required
>
> **protocol** `string` *required*
>
> The token settlement protocol to use in the request
>
> **token\_ids** `array`
>
> An array of token IDs to search for. If used, asset\_contract\_address is required
>
> **listed\_after** `string`
>
> Filter to only include orders that were listed after the given timestamp
>
> **listed\_before** `string`
>
> Filter to only include orders that were listed before the given timestamp
>
> **order\_direction** `string`
>
> The direction in which to sort the results
>
> **payment\_token\_address** `string`
>
> Payment Token Address to filter results. This ensures all returned orders are listed in a single currency
>
> **asset\_contract\_address** `string`
>
> Filter results by the contract address for NFT(s). If used, token\_ids is required
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get nft
>
> **Slug:** `OPEN_SEA_GET_NFT`
>
> Get metadata, traits, ownership information, and rarity for a single NFT.
>
> #### Input Parameters
>
> **chain** `string` *required*
>
> The blockchain on which to filter the results
>
> **address** `string` *required*
>
> The public blockchain address
>
> **identifier** `string` *required*
>
> The NFT token id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get order
>
> **Slug:** `OPEN_SEA_GET_ORDER`
>
> Get a single order, offer or listing, by its order hash. Protocol and Chain are required to prevent hash collisions.
>
> #### Input Parameters
>
> **chain** `string` *required*
>
> The blockchain on which to filter the results
>
> **order\_hash** `string` *required*
>
> The hash of the order to retrieve
>
> **protocol\_address** `string` *required*
>
> The contract address of the protocol to use in the request
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get payment token
>
> **Slug:** `OPEN_SEA_GET_PAYMENT_TOKEN`
>
> Get payment token information for a given chain and token contract address.
>
> #### Input Parameters
>
> **chain** `string` *required*
>
> The blockchain on which to filter the results
>
> **address** `string` *required*
>
> The public blockchain address
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get traits
>
> **Slug:** `OPEN_SEA_GET_TRAITS`
>
> Get the traits in a collection.
>
> #### Input Parameters
>
> **collection\_slug** `string` *required*
>
> 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
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Refresh nft metadata
>
> **Slug:** `OPEN_SEA_REFRESH_NFT_METADATA`
>
> Refresh metadata for a single NFT.
>
> #### Input Parameters
>
> **chain** `string` *required*
>
> The blockchain on which to filter the results
>
> **address** `string` *required*
>
> The public blockchain address
>
> **identifier** `string` *required*
>
> The NFT token id
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
