Class OpenSeaAPI

The API class for the OpenSea SDK.

Constructors

constructor

new OpenSeaAPI(config, logger?): OpenSeaAPI
Create an instance of the OpenSea API
Parameters
- config: OpenSeaAPIConfig
  OpenSeaAPIConfig for setting up the API, including an optional API key, Chain name, and base URL
- Optional logger: ((arg) => void)
  Optional function for logging debug strings before and after requests are made
  - - (arg): void
    - Parameters
      arg: string
      Returns void
Returns OpenSeaAPI
- Defined in api/api.ts:98

Properties

`Readonly` apiBaseUrl

apiBaseUrl: string

Base url for the API

logger

logger: ((arg) => void)

Type declaration

- (arg): void
- Logger function to use when debugging
  Parameters
  - arg: string
  Returns void

pageSize

pageSize: number = 20

Default size to use for fetching orders

Methods

buildOffer

buildOffer(offererAddress, quantity, collectionSlug): Promise<BuildOfferResponse>
Build a OpenSea collection offer.
Parameters
- offererAddress: string
  The wallet address which is creating the offer.
- quantity: number
  The number of NFTs requested in the offer.
- collectionSlug: string
  The slug (identifier) of the collection to build the offer for.
Returns Promise<BuildOfferResponse>
The BuildOfferResponse returned by the API.
- Defined in api/api.ts:340

generateFulfillmentData

generateFulfillmentData(fulfillerAddress, orderHash, protocolAddress, side): Promise<FulfillmentDataResponse>
Generate the data needed to fulfill a listing or an offer onchain.
Parameters
- fulfillerAddress: string
  The wallet address which will be used to fulfill the order
- orderHash: string
  The hash of the order to fulfill
- protocolAddress: string
  The address of the seaport contract
- side: OrderSide
Returns Promise<FulfillmentDataResponse>
The FulfillmentDataResponse

Side
The side of the order (buy or sell)
- Defined in api/api.ts:272

get

get<T>(apiPath, query?): Promise<T>
Generic fetch method for any API endpoint
Type Parameters
- T
  The response from the API.
Parameters
- apiPath: string
  Path to URL endpoint under API
- query: object = {}
  URL query params. Will be used to create a URLSearchParams object.
Returns Promise<T>
- Defined in api/api.ts:734

getAllListings

getAllListings(collectionSlug, limit?, next?): Promise<GetListingsResponse>
Gets all listings for a given collection.
Parameters
- collectionSlug: string
  The slug of the collection.
- Optional limit: number
  The number of listings to return. Must be between 1 and 100. Default: 100
- Optional next: string
  The cursor for the next page of results. This is returned from a previous request.
Returns Promise<GetListingsResponse>
The GetListingsResponse returned by the API.
- Defined in api/api.ts:217

getAllOffers

getAllOffers(collectionSlug, limit?, next?): Promise<GetOffersResponse>
Gets all offers for a given collection.
Parameters
- collectionSlug: string
  The slug of the collection.
- Optional limit: number
  The number of offers to return. Must be between 1 and 100. Default: 100
- Optional next: string
  The cursor for the next page of results. This is returned from a previous request.
Returns Promise<GetOffersResponse>
The GetOffersResponse returned by the API.
- Defined in api/api.ts:195

getAsset

getAsset(options, retries?): Promise<OpenSeaAsset>
Fetch an asset.
Parameters
- options: {
  tokenAddress: string;
  tokenId: null | string | number;
  }
  - tokenAddress: string
    The asset's contract address.
  - tokenId: null | string | number
    The asset's token ID, or null if ERC-20
- retries: number = 1
  Number of times to retry if the service is unavailable for any reason
Returns Promise<OpenSeaAsset>
The OpenSeaAsset returned by the API.

Deprecated
Use getNFT for multichain capabilities.

Throws
An error if the function is called on an unsupported chain.
- Defined in api/api.ts:413

getAssets

getAssets(query?): Promise<GetAssetsResponse>
Fetch a list of assets.
Parameters
- query: OpenSeaAssetQuery = {}
  Options to filter the list returned.
Returns Promise<GetAssetsResponse>
The GetAssetsResponse returned by the API.

Deprecated
Use getNFTsByContract or getNFTsByCollection for multichain capabilities.

Throws
An error if the function is called on an unsupported chain.
- Defined in api/api.ts:583

getBestListing

getBestListing(collectionSlug, tokenId): Promise<Listing>
Gets the best listing for a given token.
Parameters
- collectionSlug: string
  The slug of the collection.
- tokenId: string | number
  The token identifier.
Returns Promise<Listing>
The GetBestListingResponse returned by the API.
- Defined in api/api.ts:254

getBestOffer

getBestOffer(collectionSlug, tokenId): Promise<GetBestOfferResponse>
Gets the best offer for a given token.
Parameters
- collectionSlug: string
  The slug of the collection.
- tokenId: string | number
  The token identifier.
Returns Promise<GetBestOfferResponse>
The GetBestOfferResponse returned by the API.
- Defined in api/api.ts:238

getBundle

getBundle(options): Promise<null | OpenSeaAssetBundle>
Fetch a bundle from the API.
Parameters
- options: {
  slug: string;
  }
  - slug: string
    The bundle's identifier
Returns Promise<null | OpenSeaAssetBundle>
The OpenSeaAssetBundle returned by the API. If not found, returns null.
- Defined in api/api.ts:664

getBundles

getBundles(query?, page?): Promise<GetBundlesResponse>
Fetch list of bundles from the API.
Parameters
- query: OpenSeaAssetBundleQuery = {}
  Query to use for getting bundles. See OpenSeaAssetBundleQuery.
- page: number = 1
  Page number to fetch. Defaults to 1.
Returns Promise<GetBundlesResponse>
The GetBundlesResponse returned by the API.
- Defined in api/api.ts:680

getCollection

getCollection(slug): Promise<OpenSeaCollection>
Fetch an OpenSea collection.
Parameters
- slug: string
  The slug (identifier) of the collection.
Returns Promise<OpenSeaCollection>
The OpenSeaCollection returned by the API.
- Defined in api/api.ts:615

getCollectionOffers

getCollectionOffers(slug, retries?): Promise<null | ListCollectionOffersResponse>
Get a list collection offers for a given slug.
Parameters
- slug: string
  The slug (identifier) of the collection to list offers for
- retries: number = 0
  Number of times to retry if the service is unavailable for any reason.
Returns Promise<null | ListCollectionOffersResponse>
The ListCollectionOffersResponse returned by the API.
- Defined in api/api.ts:363

getNFT

getNFT(chain, address, identifier, retries?): Promise<GetNFTResponse>
Fetch metadata, traits, ownership information, and rarity for a single NFT.
Parameters
- chain: Chain
  The NFT's chain.
- address: string
  The NFT's contract address.
- identifier: string
  the identifier of the NFT (i.e. Token ID)
- retries: number = 1
  Number of times to retry if the service is unavailable for any reason
Returns Promise<GetNFTResponse>
The GetNFTResponse returned by the API.
- Defined in api/api.ts:549

getNFTsByAccount

getNFTsByAccount(address, limit?, next?, retries?, chain?): Promise<ListNFTsResponse>
Fetch NFTs owned by an account.
Parameters
- address: string
  The address of the account
- limit: undefined | number = undefined
  The number of NFTs to retrieve. Must be greater than 0 and less than 51.
- next: undefined | string = undefined
  Cursor to retrieve the next page of NFTs
- retries: number = 1
  Number of times to retry if the service is unavailable for any reason.
- chain: Chain = ...
  The chain to query. Defaults to the chain set in the constructor.
Returns Promise<ListNFTsResponse>
The ListNFTsResponse returned by the API.
- Defined in api/api.ts:516

getNFTsByCollection

getNFTsByCollection(slug, limit?, next?, retries?): Promise<ListNFTsResponse>
Fetch multiple NFTs for a collection.
Parameters
- slug: string
  The slug (identifier) of the collection
- limit: undefined | number = undefined
  The number of NFTs to retrieve. Must be greater than 0 and less than 51.
- next: undefined | string = undefined
  Cursor to retrieve the next page of NFTs
- retries: number = 1
  Number of times to retry if the service is unavailable for any reason.
Returns Promise<ListNFTsResponse>
The ListNFTsResponse returned by the API.
- Defined in api/api.ts:449

getNFTsByContract

getNFTsByContract(chain, address, limit?, next?, retries?): Promise<ListNFTsResponse>
Fetch multiple NFTs for a contract.
Parameters
- chain: Chain
  The NFT's chain.
- address: string
  The NFT's contract address.
- limit: undefined | number = undefined
  The number of NFTs to retrieve. Must be greater than 0 and less than 51.
- next: undefined | string = undefined
  Cursor to retrieve the next page of NFTs.
- retries: number = 1
  Number of times to retry if the service is unavailable for any reason.
Returns Promise<ListNFTsResponse>
The ListNFTsResponse returned by the API.
- Defined in api/api.ts:482

getOrder

getOrder(options): Promise<OrderV2>
Gets an order from API based on query options.
Parameters
- options: Omit<OrdersQueryOptions, "limit">
Returns Promise<OrderV2>
The first OrderV2 returned by the API

Throws
An error if there are no matching orders.
- Defined in api/api.ts:128

getOrders

getOrders(options): Promise<GetOrdersResponse>
Gets a list of orders from API based on query options.
Parameters
- options: Omit<OrdersQueryOptions, "limit">
Returns Promise<GetOrdersResponse>
The GetOrdersResponse returned by the API.
- Defined in api/api.ts:166

getPaymentTokens

getPaymentTokens(query?, page?, retries?): Promise<GetPaymentTokensResponse>
Fetch list of fungible tokens.
Parameters
- query: OpenSeaFungibleTokenQuery = {}
  Query to use for getting tokens. See OpenSeaFungibleTokenQuery.
- page: number = 1
  Page number to fetch. Defaults to 1.
- retries: number = 1
  Number of times to retry if the service is unavailable for any reason.
Returns Promise<GetPaymentTokensResponse>
The GetPaymentTokensResponse returned by the API.

Throws
An error if the function is called on an unsupported chain.
- Defined in api/api.ts:629

post

post<T>(apiPath, body?, opts?): Promise<T>
Generic post method for any API endpoint.
Type Parameters
- T
  The response from the API.
Parameters
- apiPath: string
  Path to URL endpoint under API
- Optional body: object
  Data to send.
- Optional opts: ConnectionInfo
  ethers ConnectionInfo, similar to Fetch API.
Returns Promise<T>
- Defined in api/api.ts:747

postCollectionOffer

postCollectionOffer(order, slug, retries?): Promise<null | CollectionOffer>
Post a collection offer to OpenSea.
Parameters
- order: OrderWithCounter
  The collection offer to post.
- slug: string
  The slug (identifier) of the collection to post the offer for.
- retries: number = 0
  Number of times to retry if the service is unavailable for any reason.
Returns Promise<null | CollectionOffer>
The Offer returned to the API.
- Defined in api/api.ts:385

postOrder

postOrder(order, apiOptions, options?): Promise<OrderV2>
Post an order to OpenSea.
Parameters
- order: OrderWithCounter
  The order to post
- apiOptions: OrderAPIOptions
- options: {
  retries?: number;
  } = {}
  - Optional retries?: number
    Number of times to retry if the service is unavailable for any reason.
Returns Promise<OrderV2>
The OrderV2 posted to the API.
- Defined in api/api.ts:312

refreshNFTMetadata

refreshNFTMetadata(chain, address, identifier, retries?): Promise<Response>
Force refresh the metadata for an NFT.
Parameters
- chain: Chain
  The chain where the NFT is located.
- address: string
  The address of the NFT's contract.
- identifier: string
  The identifier of the NFT.
- retries: number = 1
  Number of times to retry if the service is unavailable for any reason.
Returns Promise<Response>
The response from the API.
- Defined in api/api.ts:707

Class OpenSeaAPI

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: OpenSeaAPIConfig

Optional logger: ((arg) => void)

Parameters

arg: string

Returns void

Returns OpenSeaAPI

Properties

Readonly apiBaseUrl

logger

Type declaration

Parameters

arg: string

Returns void

pageSize

Methods

buildOffer

Parameters

offererAddress: string

quantity: number

collectionSlug: string

Returns Promise<BuildOfferResponse>

generateFulfillmentData

Parameters

fulfillerAddress: string

orderHash: string

protocolAddress: string

side: OrderSide

Returns Promise<FulfillmentDataResponse>

Side

get

Type Parameters

T

Parameters

apiPath: string

query: object = {}

Returns Promise<T>

getAllListings

Parameters

collectionSlug: string

Optional limit: number

Optional next: string

Returns Promise<GetListingsResponse>

getAllOffers

Parameters

collectionSlug: string

Optional limit: number

Optional next: string

Returns Promise<GetOffersResponse>

getAsset

Parameters

options: { tokenAddress: string; tokenId: null | string | number; }

tokenAddress: string

tokenId: null | string | number

retries: number = 1

Returns Promise<OpenSeaAsset>

Deprecated

Throws

getAssets

Parameters

query: OpenSeaAssetQuery = {}

Returns Promise<GetAssetsResponse>

Deprecated

Throws

getBestListing

Parameters

collectionSlug: string

tokenId: string | number

Returns Promise<Listing>

getBestOffer

Parameters

collectionSlug: string

tokenId: string | number

`Optional` logger: ((arg) => void)

`Readonly` apiBaseUrl

`Optional` limit: number

`Optional` next: string

`Optional` limit: number

`Optional` next: string

options: {
tokenAddress: string;
tokenId: null | string | number;
}

options: {
slug: string;
}