OpenSea connects to a Nagent workspace with an API key. Once it is connected, agents can call 24 OpenSea actions, such as "Create criteria offer", "Create item offer" and "Create listing". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against OpenSea, with input parameters and output schema.
OPEN_SEA_BUILD_CRITERIA_OFFERBuild a portion of a criteria offer including the merkle tree needed to post an offer.
Input parameters
The address which supplies all the items in the offer
Criteria for the collection or trait offer
The number of offers to place
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_CANCEL_ORDEROffchain 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.
Input parameters
The blockchain on which to filter the results
The hash of the order to retrieve
The contract address of the protocol to use in the request
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 from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_CREATE_CRITERIA_OFFERCreate a criteria offer to purchase any NFT in a collection or which matches the specified trait.
Input parameters
The signed order which will be submitted to Seaport
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_CREATE_ITEM_OFFERCreate an offer to purchase a single NFT (ERC721 or ERC1155).
Input parameters
The blockchain on which to filter the results
The token settlement protocol to use in the request
Signature of the signed type data represented by the parameters field
Order components object containing the order details
Exchange contract address. Must be one of \['0x0000000000000068f116a894984e2db1123eb395'\]
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_CREATE_LISTINGList a single NFT (ERC721 or ERC1155) for sale on the OpenSea marketplace.
Input parameters
The blockchain on which to filter the results
The token settlement protocol to use in the request
Signature of the signed type data represented by the parameters field
Order components object containing the order details
Exchange contract address. Must be one of \['0x0000000000000068f116a894984e2db1123eb395'\]
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_FULFILL_LISTINGRetrieve all the information, including signatures, needed to fulfill a listing directly onchain.
Input parameters
Listing to get fulfillment data for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_FULFILL_OFFERRetrieve all the information, including signatures, needed to fulfill an offer directly onchain.
Input parameters
Offer to get fulfillment data for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_ACCOUNTGet an OpenSea Account Profile including details such as bio, social media usernames, and profile image.
Input parameters
The public blockchain address or OpenSea username
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_ALL_LISTINGS_BY_COLLECTIONGet all active, valid listings for a single collection.
Input parameters
The cursor for the next page of results
The number of listings to return. Must be between 1 and 100
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 from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_ALL_OFFERS_BY_COLLECTIONGet all active, valid offers for the specified collection. This includes individual and criteria offers.
Input parameters
The cursor for the next page of results
The number of offers to return. Must be between 1 and 100
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 from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_BEST_LISTING_BY_NFTGet the best listing for an NFT.
Input parameters
The NFT token id
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
If true, will include private listings
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_BEST_LISTINGS_BY_COLLECTIONGet the cheapest priced active, valid listings on a single collection.
Input parameters
The cursor for the next page of results
The number of listings to return. Must be between 1 and 100
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
If true, will include private listings
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_BEST_OFFER_BY_NFTGet the best offers for an NFT.
Input parameters
The NFT token id
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 from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_COLLECTIONGet a single collection including details such as fees, traits, and links.
Input parameters
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 from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_COLLECTIONSGet a list of OpenSea collections with optional filtering and pagination.
Input parameters
The cursor for the next page of results
The blockchain on which to filter the results
The number of collections to return. Must be between 1 and 100
The order in which to sort the collections
If true, will return hidden collections
If set, will only return collections created by the given OpenSea username
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_COLLECTION_STATSGet stats for a single collection on OpenSea.
Input parameters
Unique string to identify a collection on OpenSea
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_CONTRACTGet a smart contract for a given chain and address.
Input parameters
The blockchain on which to filter the results
The public blockchain address
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_EVENTSGet a list of events from OpenSea based on various filters like timestamps and event types.
Input parameters
The cursor for the next page of results
Filter to only include events that occurred at or after the given timestamp (Unix epoch in seconds)
The number of events to return. Must be between 1 and 50
Filter to only include events that occurred before the given timestamp (Unix epoch in seconds)
The type of event to filter by. If not provided, only sales will be returned
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_LISTINGSGet the complete set of active, valid listings.
Input parameters
The blockchain on which to filter the results
The number of orders to return. Must be between 1 and 50
Filter results by the order maker's wallet address
Filter results by the order taker's wallet address
The cursor for the next page of results
The order in which to sort the results. If eth_price is used, asset_contract_address and token_id are required
The token settlement protocol to use in the request
An array of token IDs to search for. If used, asset_contract_address is required
Filter to only include orders that were listed after the given timestamp
Filter to only include orders that were listed before the given timestamp
The direction in which to sort the results
Payment Token Address to filter results. This ensures all returned orders are listed in a single currency
Filter results by the contract address for NFT(s). If used, token_ids is required
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_NFTGet metadata, traits, ownership information, and rarity for a single NFT.
Input parameters
The blockchain on which to filter the results
The public blockchain address
The NFT token id
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_ORDERGet a single order, offer or listing, by its order hash. Protocol and Chain are required to prevent hash collisions.
Input parameters
The blockchain on which to filter the results
The hash of the order to retrieve
The contract address of the protocol to use in the request
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_PAYMENT_TOKENGet a smart contract for a given chain and address.
Input parameters
The blockchain on which to filter the results
The public blockchain address
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_GET_TRAITSGet the traits in a collection.
Input parameters
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 from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OPEN_SEA_REFRESH_NFT_METADATARefresh metadata for a single NFT.
Input parameters
The blockchain on which to filter the results
The public blockchain address
The NFT token id
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 24 OpenSea actions on Nagent, including "Create criteria offer", "Create item offer" and "Create listing". Create criteria offer: Create a criteria offer to purchase any NFT in a collection or which matches the specified trait. Each action is listed on this page with its input parameters and its output.
OpenSea connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create criteria offer takes 1 required input: protocol_data. It returns data, error and successful.