Nft

Open Sea

Learn how to use Open Sea with Composio

Overview

SLUG

OPEN_SEA

Description

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

Authentication Details

api_key
stringRequired
base_url
stringDefaults to https://api.opensea.io/api/v2

Tools

SLUG: OPEN_SEA_CREATE_ITEM_OFFER

Create an offer to purchase a single nft (erc721 or erc1155).

Action Parameters

chain
stringRequired
parameters
objectRequired
protocol
stringRequired
protocol_address
stringRequired
signature
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_CREATE_LISTING

List a single nft (erc721 or erc1155) for sale on the opensea marketplace.

Action Parameters

chain
stringRequired
parameters
objectRequired
protocol
stringRequired
protocol_address
stringRequired
signature
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_FULFILL_LISTING

Retrieve all the information, including signatures, needed to fulfill a listing directly onchain.

Action Parameters

listing
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_GET_ACCOUNT

Get an opensea account profile including details such as bio, social media usernames, and profile image.

Action Parameters

address_or_username
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_GET_BEST_LISTINGS_BY_COLLECTION

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

Action Parameters

collection_slug
stringRequired
include_private_listings
boolean
limit
integerDefaults to 100
next
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_GET_COLLECTION

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

Action Parameters

collection_slug
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_GET_COLLECTION_STATS

Get stats for a single collection on opensea.

Action Parameters

collection_slug
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_GET_NFT

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

Action Parameters

address
stringRequired
chain
stringRequired
identifier
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

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.

Action Parameters

chain
stringRequired
order_hash
stringRequired
protocol_address
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_BUILD_CRITERIA_OFFER

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

Action Parameters

criteria
objectRequired
offerer
stringRequired
quantity
integerDefaults to 1

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_CANCEL_ORDER

Offchain cancel a single order, offer or listing, by its order hash when protected by the signedzone. protocol and chain are required to prevent hash collisions. please note cancellation is only assured if a fulfillment signature was not vended prior to cancellation.

Action Parameters

chain
stringRequired
offerer_signature
string
order_hash
stringRequired
protocol_address
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_CREATE_CRITERIA_OFFER

Create a criteria offer to purchase any nft in a collection or which matches the specified trait.

Action Parameters

protocol_data
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_FULFILL_OFFER

Retrieve all the information, including signatures, needed to fulfill an offer directly onchain.

Action Parameters

offer
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_GET_ALL_LISTINGS_BY_COLLECTION

Get all active, valid listings for a single collection.

Action Parameters

collection_slug
stringRequired
limit
integerDefaults to 100
next
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_GET_ALL_OFFERS_BY_COLLECTION

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

Action Parameters

collection_slug
stringRequired
limit
integerDefaults to 100
next
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_GET_BEST_LISTING_BY_NFT

Get the best listing for an nft.

Action Parameters

collection_slug
stringRequired
identifier
stringRequired
include_private_listings
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_GET_BEST_OFFER_BY_NFT

Get the best offers for an nft.

Action Parameters

collection_slug
stringRequired
identifier
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_GET_COLLECTIONS

Get a list of opensea collections with optional filtering and pagination.

Action Parameters

chain
string
creator_username
string
include_hidden
boolean
limit
integerDefaults to 100
next
string
order_by
stringDefaults to created_date

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_GET_CONTRACT

Get a smart contract for a given chain and address.

Action Parameters

address
stringRequired
chain
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: OPEN_SEA_GET_EVENTS

Get a list of events from opensea based on various filters like timestamps and event types.

Action Parameters

after
integer
before
integer
event_type
array
limit
integerDefaults to 50
next
string

Action Response

data
objectRequired
error
string
successful
booleanRequired