@opensea/sdk 9.0.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Ozone Networks, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+<p align="center">
+  <img src="./img/banner.png" />
+</p>
+
+[![Version][version-badge]][version-link]
+[![npm][npm-badge]][npm-link]
+[![Test CI][ci-badge]][ci-link]
+[![Coverage Status][coverage-badge]][coverage-link]
+[![License][license-badge]][license-link]
+[![Docs][docs-badge]][docs-link]
+[![Discussions][discussions-badge]][discussions-link]
+
+# @opensea/sdk <!-- omit in toc -->
+
+> **Note:** This package was previously published as `opensea-js`. The API is unchanged.
+
+This is the TypeScript SDK for [OpenSea](https://opensea.io), the largest marketplace for NFTs.
+
+It allows developers to access the official orderbook, filter it, create listings and offers, and complete trades programmatically.
+
+Get started by [requesting an API key](https://docs.opensea.io/reference/api-keys) and instantiating your own OpenSea SDK instance. Then you can create orders off-chain or fulfill orders onchain, and listen to events in the process.
+
+Happy seafaring!
+
+## Documentation
+
+- [Quick Start Guide](developerDocs/quick-start.md)
+- [Getting Started Guide](developerDocs/getting-started.md)
+- [API Reference](developerDocs/api-reference.md)
+- [Advanced Use Cases](developerDocs/advanced-use-cases.md)
+- [SDK Reference](https://projectopensea.github.io/opensea-js/)
+- [Frequently Asked Questions](developerDocs/faq.md)
+- [Contributing](CONTRIBUTING.md)
+
+### Security Warning
+
+**Do not use this SDK directly in client-side/frontend applications.**
+
+The OpenSea SDK requires an API key for initialization. If you embed your API key in frontend code (e.g., browser applications, mobile apps), it will be publicly exposed and could be extracted by anyone, leading to potential abuse and rate limit issues.
+
+#### Recommended Architecture
+
+For frontend applications that need to interact with OpenSea functionality:
+
+1. **Create a backend API wrapper**: Set up your own backend server that securely stores your OpenSea API key
+2. **Call OpenSea SDK server-side**: Use `@opensea/sdk` on your backend to interact with OpenSea's APIs
+3. **Return data to your frontend**: Send the necessary data (like transaction parameters) back to your frontend
+4. **Execute transactions in the browser**: Have users sign transactions with their own wallets (e.g., MetaMask) in the browser
+
+## Changelog
+
+The changelog for recent versions can be found at:
+
+- @opensea/sdk: https://github.com/ProjectOpenSea/opensea-js/releases
+- OpenSea API: https://docs.opensea.io/changelog
+
+[version-badge]: https://img.shields.io/github/package-json/v/ProjectOpenSea/opensea-js
+[version-link]: https://github.com/ProjectOpenSea/opensea-js/releases
+[npm-badge]: https://img.shields.io/npm/v/@opensea/sdk?color=red
+[npm-link]: https://www.npmjs.com/package/@opensea/sdk
+[ci-badge]: https://github.com/ProjectOpenSea/opensea-js/actions/workflows/code-quality.yml/badge.svg
+[ci-link]: https://github.com/ProjectOpenSea/opensea-js/actions/workflows/code-quality.yml
+[coverage-badge]: https://coveralls.io/repos/github/ProjectOpenSea/opensea-js/badge.svg?branch=main
+[coverage-link]: https://coveralls.io/github/ProjectOpenSea/opensea-js?branch=main
+[license-badge]: https://img.shields.io/github/license/ProjectOpenSea/opensea-js
+[license-link]: https://github.com/ProjectOpenSea/opensea-js/blob/main/LICENSE
+[docs-badge]: https://img.shields.io/badge/@opensea/sdk-documentation-informational
+[docs-link]: https://github.com/ProjectOpenSea/opensea-js#documentation
+[discussions-badge]: https://img.shields.io/badge/@opensea/sdk-discussions-blueviolet
+[discussions-link]: https://github.com/ProjectOpenSea/opensea-js/discussions

package/lib/api/accounts.d.ts

@@ -0,0 +1,27 @@
+import type { Chain, OpenSeaAccount, OpenSeaPaymentToken } from "../types";
+import type { Fetcher } from "./fetcher";
+import type { GetAccountTokensArgs, GetAccountTokensResponse, ResolveAccountResponse } from "./types";
+/**
+ * Account and payment token related API operations
+ */
+export declare class AccountsAPI {
+    private fetcher;
+    private chain;
+    constructor(fetcher: Fetcher, chain: Chain);
+    /**
+     * Fetch a payment token.
+     */
+    getPaymentToken(address: string, chain?: Chain): Promise<OpenSeaPaymentToken>;
+    /**
+     * Fetch account for an address.
+     */
+    getAccount(address: string): Promise<OpenSeaAccount>;
+    /**
+     * Fetch token balances for an account.
+     */
+    getAccountTokens(address: string, args?: GetAccountTokensArgs): Promise<GetAccountTokensResponse>;
+    /**
+     * Resolve an ENS name, OpenSea username, or wallet address to canonical account info.
+     */
+    resolveAccount(identifier: string): Promise<ResolveAccountResponse>;
+}

package/lib/api/accounts.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountsAPI = void 0;
+const converters_1 = require("../utils/converters");
+const apiPaths_1 = require("./apiPaths");
+/**
+ * Account and payment token related API operations
+ */
+class AccountsAPI {
+    fetcher;
+    chain;
+    constructor(fetcher, chain) {
+        this.fetcher = fetcher;
+        this.chain = chain;
+    }
+    /**
+     * Fetch a payment token.
+     */
+    async getPaymentToken(address, chain = this.chain) {
+        const json = await this.fetcher.get((0, apiPaths_1.getPaymentTokenPath)(chain, address));
+        return (0, converters_1.paymentTokenFromJSON)(json);
+    }
+    /**
+     * Fetch account for an address.
+     */
+    async getAccount(address) {
+        const json = await this.fetcher.get((0, apiPaths_1.getAccountPath)(address));
+        return (0, converters_1.accountFromJSON)(json);
+    }
+    /**
+     * Fetch token balances for an account.
+     */
+    async getAccountTokens(address, args) {
+        const response = await this.fetcher.get((0, apiPaths_1.getAccountTokensPath)(address), args);
+        return response;
+    }
+    /**
+     * Resolve an ENS name, OpenSea username, or wallet address to canonical account info.
+     */
+    async resolveAccount(identifier) {
+        const response = await this.fetcher.get((0, apiPaths_1.getResolveAccountPath)(identifier));
+        return response;
+    }
+}
+exports.AccountsAPI = AccountsAPI;
+//# sourceMappingURL=accounts.js.map

package/lib/api/accounts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounts.js","sourceRoot":"","sources":["../../src/api/accounts.ts"],"names":[],"mappings":";;;AACA,oDAA2E;AAC3E,yCAKmB;AAQnB;;GAEG;AACH,MAAa,WAAW;IAEZ;IACA;IAFV,YACU,OAAgB,EAChB,KAAY;QADZ,YAAO,GAAP,OAAO,CAAS;QAChB,UAAK,GAAL,KAAK,CAAO;IACnB,CAAC;IAEJ;;OAEG;IACH,KAAK,CAAC,eAAe,CACnB,OAAe,EACf,KAAK,GAAG,IAAI,CAAC,KAAK;QAElB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACjC,IAAA,8BAAmB,EAAC,KAAK,EAAE,OAAO,CAAC,CACpC,CAAA;QACD,OAAO,IAAA,iCAAoB,EAAC,IAAI,CAAC,CAAA;IACnC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,OAAe;QAC9B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAiB,IAAA,yBAAc,EAAC,OAAO,CAAC,CAAC,CAAA;QAC5E,OAAO,IAAA,4BAAe,EAAC,IAAI,CAAC,CAAA;IAC9B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAe,EACf,IAA2B;QAE3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,+BAAoB,EAAC,OAAO,CAAC,EAC7B,IAAI,CACL,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,UAAkB;QACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,gCAAqB,EAAC,UAAU,CAAC,CAClC,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF;AAlDD,kCAkDC"}

package/lib/api/api.d.ts

@@ -0,0 +1,489 @@
+import type { FulfillmentDataResponse, OrderAPIOptions, OrdersQueryOptions, OrderV2, ProtocolData } from "../orders/types";
+import { Chain, type OpenSeaAccount, type OpenSeaAPIConfig, type OpenSeaCollection, type OpenSeaCollectionStats, type OpenSeaPaymentToken, type OrderSide, type RequestOptions } from "../types";
+import { type BuildOfferResponse, type CancelOrderResponse, type CollectionOffer, CollectionOrderByOption, type DropMintRequest, type DropMintResponse, type GetAccountTokensArgs, type GetAccountTokensResponse, type GetBestListingResponse, type GetBestOfferResponse, type GetChainsResponse, type GetCollectionsPaginatedResponse, type GetCollectionsResponse, type GetContractResponse, type GetDropResponse, type GetDropsArgs, type GetDropsResponse, type GetEventsArgs, type GetEventsResponse, type GetListingsResponse, type GetNFTResponse, type GetOffersResponse, type GetOrderByHashResponse, type GetOrdersResponse, type GetSwapQuoteArgs, type GetSwapQuoteResponse, type GetTokenResponse, type GetTokensArgs, type GetTopCollectionsArgs, type GetTopTokensResponse, type GetTraitsResponse, type GetTrendingCollectionsArgs, type GetTrendingTokensResponse, type Listing, type ListNFTsResponse, type Offer, type ResolveAccountResponse, type SearchArgs, type SearchResponse, type ValidateMetadataResponse } from "./types";
+/**
+ * The API class for the OpenSea SDK.
+ * @category Main Classes
+ */
+export declare class OpenSeaAPI {
+    /**
+     * Base url for the API
+     */
+    readonly apiBaseUrl: string;
+    /**
+     * Default size to use for fetching orders
+     */
+    pageSize: number;
+    /**
+     * Logger function to use when debugging
+     */
+    logger: (arg: string) => void;
+    private apiKey;
+    private chain;
+    private ordersAPI;
+    private offersAPI;
+    private listingsAPI;
+    private collectionsAPI;
+    private nftsAPI;
+    private accountsAPI;
+    private eventsAPI;
+    private searchAPI;
+    private tokensAPI;
+    private chainsAPI;
+    private dropsAPI;
+    /**
+     * Create an instance of the OpenSeaAPI
+     * @param config OpenSeaAPIConfig for setting up the API, including an optional API key, Chain name, and base URL
+     * @param logger Optional function for logging debug strings before and after requests are made. Defaults to no logging
+     */
+    constructor(config: OpenSeaAPIConfig, logger?: (arg: string) => void);
+    /**
+     * Gets an order from API based on query options.
+     * @deprecated Use collection-based endpoints instead: getAllOffers, getAllListings, getBestOffer, getBestListing.
+     * @param options Query options for fetching an order
+     * @returns The first {@link OrderV2} returned by the API
+     *
+     * @throws An error if there are no matching orders.
+     */
+    getOrder(options: Omit<OrdersQueryOptions, "limit">): Promise<OrderV2>;
+    /**
+     * Gets a single order by its order hash.
+     * @param orderHash The hash of the order to fetch
+     * @param protocolAddress The address of the seaport contract
+     * @param chain The chain where the order is located. Defaults to the chain set in the constructor.
+     * @returns The {@link GetOrderByHashResponse} returned by the API (can be Offer or Listing)
+     * @throws An error if the order is not found
+     */
+    getOrderByHash(orderHash: string, protocolAddress: string, chain?: Chain): Promise<GetOrderByHashResponse>;
+    /**
+     * Gets a list of orders from API based on query options.
+     * @deprecated Use collection-based endpoints instead: getAllOffers, getAllListings, getBestOffer, getBestListing.
+     * @param options Query options for fetching orders
+     * @returns The {@link GetOrdersResponse} returned by the API.
+     */
+    getOrders(options: Omit<OrdersQueryOptions, "limit">): Promise<GetOrdersResponse>;
+    /**
+     * Gets all offers for a given collection.
+     * @param collectionSlug The slug of the collection.
+     * @param limit The number of offers to return. Must be between 1 and 100. Default: 100
+     * @param next The cursor for the next page of results. This is returned from a previous request.
+     * @returns The {@link GetOffersResponse} returned by the API.
+     */
+    getAllOffers(collectionSlug: string, limit?: number, next?: string): Promise<GetOffersResponse>;
+    /**
+     * Gets all listings for a given collection.
+     * @param collectionSlug The slug of the collection.
+     * @param limit The number of listings to return. Must be between 1 and 100. Default: 100
+     * @param next The cursor for the next page of results. This is returned from a previous request.
+     * @param includePrivateListings Whether to include private listings (default: false)
+     * @returns The {@link GetListingsResponse} returned by the API.
+     */
+    getAllListings(collectionSlug: string, limit?: number, next?: string, includePrivateListings?: boolean): Promise<GetListingsResponse>;
+    /**
+     * Gets trait offers for a given collection.
+     * @param collectionSlug The slug of the collection.
+     * @param type The name of the trait (e.g. 'Background').
+     * @param value The value of the trait (e.g. 'Red').
+     * @param limit The number of offers to return. Must be between 1 and 100. Default: 100
+     * @param next The cursor for the next page of results. This is returned from a previous request.
+     * @param floatValue The value of the trait for decimal-based numeric traits.
+     * @param intValue The value of the trait for integer-based numeric traits.
+     * @returns The {@link GetOffersResponse} returned by the API.
+     */
+    getTraitOffers(collectionSlug: string, type: string, value: string, limit?: number, next?: string, floatValue?: number, intValue?: number): Promise<GetOffersResponse>;
+    /**
+     * Gets the best offer for a given token.
+     * @param collectionSlug The slug of the collection.
+     * @param tokenId The token identifier.
+     * @returns The {@link GetBestOfferResponse} returned by the API.
+     */
+    getBestOffer(collectionSlug: string, tokenId: string | number): Promise<GetBestOfferResponse>;
+    /**
+     * Gets the best listing for a given token.
+     * @param collectionSlug The slug of the collection.
+     * @param tokenId The token identifier.
+     * @param includePrivateListings Whether to include private listings (default: false)
+     * @returns The {@link GetBestListingResponse} returned by the API.
+     */
+    getBestListing(collectionSlug: string, tokenId: string | number, includePrivateListings?: boolean): Promise<GetBestListingResponse>;
+    /**
+     * Gets the best listings for a given collection.
+     * @param collectionSlug The slug of the collection.
+     * @param limit The number of listings to return. Must be between 1 and 100. Default: 100
+     * @param next The cursor for the next page of results. This is returned from a previous request.
+     * @param includePrivateListings Whether to include private listings (default: false)
+     * @returns The {@link GetListingsResponse} returned by the API.
+     */
+    getBestListings(collectionSlug: string, limit?: number, next?: string, includePrivateListings?: boolean): Promise<GetListingsResponse>;
+    /**
+     * Generate the data needed to fulfill a listing or an offer onchain.
+     * @param fulfillerAddress The wallet address which will be used to fulfill the order
+     * @param orderHash The hash of the order to fulfill
+     * @param protocolAddress The address of the seaport contract
+     * @param side The side of the order (buy or sell)
+     * @param assetContractAddress Optional address of the NFT contract for criteria offers (e.g., collection offers)
+     * @param tokenId Optional token ID for criteria offers (e.g., collection offers)
+     * @param unitsToFill Optional number of units to fill. Defaults to 1 for both listings and offers.
+     * @param recipientAddress Optional recipient address for the NFT when fulfilling a listing. Not applicable for offers.
+     * @param includeOptionalCreatorFees Whether to include optional creator fees in the fulfillment. If creator fees are already required, this is a no-op. Defaults to false.
+     * @returns The {@link FulfillmentDataResponse}
+     */
+    generateFulfillmentData(fulfillerAddress: string, orderHash: string, protocolAddress: string, side: OrderSide, assetContractAddress?: string, tokenId?: string, unitsToFill?: string, recipientAddress?: string, includeOptionalCreatorFees?: boolean): Promise<FulfillmentDataResponse>;
+    /**
+     * Post an order to OpenSea.
+     * @deprecated Use postListing or postOffer instead.
+     * @param order The order to post
+     * @param apiOptions API options for the order
+     * @returns The {@link OrderV2} posted to the API.
+     */
+    postOrder(order: ProtocolData, apiOptions: OrderAPIOptions): Promise<OrderV2>;
+    /**
+     * Post a listing to OpenSea. Returns the new v2 Listing response format.
+     * @param order The order to post
+     * @param protocolAddress The contract address of the seaport protocol
+     * @returns The {@link Listing} posted to the API.
+     */
+    postListing(order: ProtocolData, protocolAddress: string): Promise<Listing>;
+    /**
+     * Post an offer to OpenSea. Returns the new v2 Offer response format.
+     * @param order The order to post
+     * @param protocolAddress The contract address of the seaport protocol
+     * @returns The {@link Offer} posted to the API.
+     */
+    postOffer(order: ProtocolData, protocolAddress: string): Promise<Offer>;
+    /**
+     * Build a OpenSea collection offer.
+     * @param offererAddress The wallet address which is creating the offer.
+     * @param quantity The number of NFTs requested in the offer.
+     * @param collectionSlug The slug (identifier) of the collection to build the offer for.
+     * @param offerProtectionEnabled Build the offer on OpenSea's signed zone to provide offer protections from receiving an item which is disabled from trading.
+     * @param traitType If defined, the trait name to create the collection offer for.
+     * @param traitValue If defined, the trait value to create the collection offer for.
+     * @param traits If defined, an array of traits to create the multi-trait collection offer for.
+     * @param numericTraits If defined, an array of numeric trait criteria with min/max ranges.
+     * @returns The {@link BuildOfferResponse} returned by the API.
+     */
+    buildOffer(offererAddress: string, quantity: number, collectionSlug: string, offerProtectionEnabled?: boolean, traitType?: string, traitValue?: string, traits?: Array<{
+        type: string;
+        value: string;
+    }>, numericTraits?: Array<{
+        type: string;
+        min?: number;
+        max?: number;
+    }>): Promise<BuildOfferResponse>;
+    /**
+     * Get a list collection offers for a given slug.
+     * @param slug The slug (identifier) of the collection to list offers for
+     * @param limit Optional limit for number of results.
+     * @param next Optional cursor for pagination.
+     * @returns The {@link GetOffersResponse} returned by the API.
+     */
+    getCollectionOffers(slug: string, limit?: number, next?: string): Promise<GetOffersResponse>;
+    /**
+     * Post a collection offer to OpenSea.
+     * @param order The collection offer to post.
+     * @param slug The slug (identifier) of the collection to post the offer for.
+     * @param traitType If defined, the trait name to create the collection offer for.
+     * @param traitValue If defined, the trait value to create the collection offer for.
+     * @param traits If defined, an array of traits to create the multi-trait collection offer for.
+     * @param numericTraits If defined, an array of numeric trait criteria with min/max ranges.
+     * @returns The {@link Offer} returned to the API.
+     */
+    postCollectionOffer(order: ProtocolData, slug: string, traitType?: string, traitValue?: string, traits?: Array<{
+        type: string;
+        value: string;
+    }>, numericTraits?: Array<{
+        type: string;
+        min?: number;
+        max?: number;
+    }>): Promise<CollectionOffer | null>;
+    /**
+     * Fetch multiple NFTs for a collection.
+     * @param slug The slug (identifier) of the collection
+     * @param limit The number of NFTs to retrieve. Must be greater than 0 and less than 51.
+     * @param next Cursor to retrieve the next page of NFTs
+     * @returns The {@link ListNFTsResponse} returned by the API.
+     */
+    getNFTsByCollection(slug: string, limit?: number | undefined, next?: string | undefined): Promise<ListNFTsResponse>;
+    /**
+     * Fetch multiple NFTs for a contract.
+     * @param address The NFT's contract address.
+     * @param limit The number of NFTs to retrieve. Must be greater than 0 and less than 51.
+     * @param next Cursor to retrieve the next page of NFTs.
+     * @param chain The NFT's chain.
+     * @returns The {@link ListNFTsResponse} returned by the API.
+     */
+    getNFTsByContract(address: string, limit?: number | undefined, next?: string | undefined, chain?: Chain): Promise<ListNFTsResponse>;
+    /**
+     * Fetch NFTs owned by an account.
+     * @param address The address of the account
+     * @param limit The number of NFTs to retrieve. Must be greater than 0 and less than 51.
+     * @param next Cursor to retrieve the next page of NFTs
+     * @param chain The chain to query. Defaults to the chain set in the constructor.
+     * @returns The {@link ListNFTsResponse} returned by the API.
+     */
+    getNFTsByAccount(address: string, limit?: number | undefined, next?: string | undefined, chain?: Chain): Promise<ListNFTsResponse>;
+    /**
+     * Fetch metadata, traits, ownership information, and rarity for a single NFT.
+     * @param address The NFT's contract address.
+     * @param identifier the identifier of the NFT (i.e. Token ID)
+     * @param chain The NFT's chain.
+     * @returns The {@link GetNFTResponse} returned by the API.
+     */
+    getNFT(address: string, identifier: string, chain?: Chain): Promise<GetNFTResponse>;
+    /**
+     * Fetch an OpenSea collection.
+     * @param slug The slug (identifier) of the collection.
+     * @returns The {@link OpenSeaCollection} returned by the API.
+     */
+    getCollection(slug: string): Promise<OpenSeaCollection>;
+    /**
+     * Fetch a list of OpenSea collections.
+     * @param orderBy The order to return the collections in. Default: CREATED_DATE
+     * @param chain The chain to filter the collections on. Default: all chains
+     * @param creatorUsername The creator's OpenSea username to filter the collections on.
+     * @param includeHidden If hidden collections should be returned. Default: false
+     * @param limit The limit of collections to return.
+     * @param next The cursor for the next page of results. This is returned from a previous request.
+     * @returns List of {@link OpenSeaCollection} returned by the API.
+     */
+    getCollections(orderBy?: CollectionOrderByOption, chain?: Chain, creatorUsername?: string, includeHidden?: boolean, limit?: number, next?: string): Promise<GetCollectionsResponse>;
+    /**
+     * Fetch stats for an OpenSea collection.
+     * @param slug The slug (identifier) of the collection.
+     * @returns The {@link OpenSeaCollection} returned by the API.
+     */
+    getCollectionStats(slug: string): Promise<OpenSeaCollectionStats>;
+    /**
+     * Fetch a payment token.
+     * @param address The address of the payment token
+     * @param chain The chain of the payment token
+     * @returns The {@link OpenSeaPaymentToken} returned by the API.
+     */
+    getPaymentToken(address: string, chain?: Chain): Promise<OpenSeaPaymentToken>;
+    /**
+     * Fetch account for an address.
+     * @param address The address to fetch the account for
+     * @returns The {@link OpenSeaAccount} returned by the API.
+     */
+    getAccount(address: string): Promise<OpenSeaAccount>;
+    /**
+     * Force refresh the metadata for an NFT.
+     * @param address The address of the NFT's contract.
+     * @param identifier The identifier of the NFT.
+     * @param chain The chain where the NFT is located.
+     * @returns The response from the API.
+     */
+    refreshNFTMetadata(address: string, identifier: string, chain?: Chain): Promise<Response>;
+    /**
+     * Offchain cancel an 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.
+     * @param protocolAddress The Seaport address for the order.
+     * @param orderHash The order hash, or external identifier, of the order.
+     * @param chain The chain where the order is located.
+     * @param offererSignature An EIP-712 signature from the offerer of the order.
+     *                         If this is not provided, the user associated with the API Key will be checked instead.
+     *                         The signature must be a EIP-712 signature consisting of the order's Seaport contract's
+     *                         name, version, address, and chain. The struct to sign is `OrderHash` containing a
+     *                         single bytes32 field.
+     * @returns The response from the API.
+     */
+    offchainCancelOrder(protocolAddress: string, orderHash: string, chain?: Chain, offererSignature?: string): Promise<CancelOrderResponse>;
+    /**
+     * Gets a list of events based on query parameters.
+     * @param args Query parameters for filtering events.
+     * @returns The {@link GetEventsResponse} returned by the API.
+     */
+    getEvents(args?: GetEventsArgs): Promise<GetEventsResponse>;
+    /**
+     * Gets a list of events for a specific account.
+     * @param address The account address.
+     * @param args Query parameters for filtering events.
+     * @returns The {@link GetEventsResponse} returned by the API.
+     */
+    getEventsByAccount(address: string, args?: GetEventsArgs): Promise<GetEventsResponse>;
+    /**
+     * Gets a list of events for a specific collection.
+     * @param collectionSlug The slug (identifier) of the collection.
+     * @param args Query parameters for filtering events.
+     * @returns The {@link GetEventsResponse} returned by the API.
+     */
+    getEventsByCollection(collectionSlug: string, args?: GetEventsArgs): Promise<GetEventsResponse>;
+    /**
+     * Gets a list of events for a specific NFT.
+     * @param chain The chain where the NFT is located.
+     * @param address The contract address of the NFT.
+     * @param identifier The token identifier.
+     * @param args Query parameters for filtering events.
+     * @returns The {@link GetEventsResponse} returned by the API.
+     */
+    getEventsByNFT(chain: Chain, address: string, identifier: string, args?: GetEventsArgs): Promise<GetEventsResponse>;
+    /**
+     * Fetch smart contract information for a given chain and address.
+     * @param address The contract address.
+     * @param chain The chain where the contract is deployed. Defaults to the chain set in the constructor.
+     * @returns The {@link GetContractResponse} returned by the API.
+     */
+    getContract(address: string, chain?: Chain): Promise<GetContractResponse>;
+    /**
+     * Fetch all traits for a collection with their possible values and counts.
+     * @param collectionSlug The slug (identifier) of the collection.
+     * @returns The {@link GetTraitsResponse} returned by the API.
+     */
+    getTraits(collectionSlug: string): Promise<GetTraitsResponse>;
+    /**
+     * Gets a list of trending tokens.
+     * @param args Optional query parameters for pagination.
+     * @returns The {@link GetTrendingTokensResponse} returned by the API.
+     */
+    getTrendingTokens(args?: GetTokensArgs): Promise<GetTrendingTokensResponse>;
+    /**
+     * Gets a list of top tokens.
+     * @param args Optional query parameters for pagination.
+     * @returns The {@link GetTopTokensResponse} returned by the API.
+     */
+    getTopTokens(args?: GetTokensArgs): Promise<GetTopTokensResponse>;
+    /**
+     * Gets a swap quote for exchanging tokens.
+     * @param args Query parameters for the swap quote including token addresses, amount, and chain.
+     * @returns The {@link GetSwapQuoteResponse} returned by the API.
+     */
+    getSwapQuote(args: GetSwapQuoteArgs): Promise<GetSwapQuoteResponse>;
+    /**
+     * Gets details for a specific token.
+     * @param chain The chain the token is on.
+     * @param address The token contract address.
+     * @returns The {@link GetTokenResponse} returned by the API.
+     */
+    getToken(chain: string, address: string): Promise<GetTokenResponse>;
+    /**
+     * Search across collections, tokens, NFTs, and accounts.
+     * Results are ranked by relevance.
+     * @param args Query parameters including query text, optional chain/asset type filters, and limit.
+     * @returns The {@link SearchResponse} returned by the API.
+     */
+    search(args: SearchArgs): Promise<SearchResponse>;
+    /**
+     * Gets the list of supported blockchains and their capabilities.
+     * @returns The {@link GetChainsResponse} returned by the API.
+     */
+    getChains(): Promise<GetChainsResponse>;
+    /**
+     * Gets token balances for a given account.
+     * @param address The wallet address to fetch token balances for.
+     * @param args Optional query parameters for filtering and pagination.
+     * @returns The {@link GetAccountTokensResponse} returned by the API.
+     */
+    getAccountTokens(address: string, args?: GetAccountTokensArgs): Promise<GetAccountTokensResponse>;
+    /**
+     * Validate NFT metadata by fetching and parsing it.
+     * @param address The NFT contract address.
+     * @param identifier The token identifier.
+     * @param chain The chain where the NFT is located. Defaults to the chain set in the constructor.
+     * @param ignoreCachedItemUrls Whether to ignore cached item URLs and re-fetch from source.
+     * @returns The {@link ValidateMetadataResponse} returned by the API.
+     */
+    validateNFTMetadata(address: string, identifier: string, chain?: Chain, ignoreCachedItemUrls?: boolean): Promise<ValidateMetadataResponse>;
+    /**
+     * Gets all active offers for a specific NFT (not just the best offer).
+     * @param assetContractAddress The NFT contract address.
+     * @param tokenId The token identifier.
+     * @param limit The number of offers to return. Must be between 1 and 100.
+     * @param next The cursor for the next page of results. This is returned from a previous request.
+     * @param chain The chain where the NFT is located. Defaults to the chain set in the constructor.
+     * @returns The {@link GetOffersResponse} returned by the API.
+     */
+    getNFTOffers(assetContractAddress: string, tokenId: string, limit?: number, next?: string, chain?: Chain): Promise<GetOffersResponse>;
+    /**
+     * Gets all active listings for a specific NFT (not just the best listing).
+     * @param assetContractAddress The NFT contract address.
+     * @param tokenId The token identifier.
+     * @param limit The number of listings to return. Must be between 1 and 100.
+     * @param next The cursor for the next page of results. This is returned from a previous request.
+     * @param chain The chain where the NFT is located. Defaults to the chain set in the constructor.
+     * @param includePrivateListings Whether to include private listings (default: false)
+     * @returns The {@link GetListingsResponse} returned by the API.
+     */
+    getNFTListings(assetContractAddress: string, tokenId: string, limit?: number, next?: string, chain?: Chain, includePrivateListings?: boolean): Promise<GetListingsResponse>;
+    /**
+     * Gets a list of drops (mints).
+     * @param args Optional query parameters for filtering and pagination.
+     * @returns The {@link GetDropsResponse} returned by the API.
+     */
+    getDrops(args?: GetDropsArgs): Promise<GetDropsResponse>;
+    /**
+     * Gets detailed drop information for a collection.
+     * @param slug The collection slug identifying the drop.
+     * @returns The {@link GetDropResponse} returned by the API.
+     */
+    getDrop(slug: string): Promise<GetDropResponse>;
+    /**
+     * Builds a mint transaction for a drop.
+     * @param slug The collection slug identifying the drop.
+     * @param request The mint request containing minter address and quantity.
+     * @returns The {@link DropMintResponse} with ready-to-sign transaction data.
+     */
+    buildDropMintTransaction(slug: string, request: DropMintRequest): Promise<DropMintResponse>;
+    /**
+     * Gets trending collections sorted by sales activity.
+     * @param args Optional query parameters for timeframe, chain, category, and pagination.
+     * @returns The {@link GetCollectionsPaginatedResponse} returned by the API.
+     */
+    getTrendingCollections(args?: GetTrendingCollectionsArgs): Promise<GetCollectionsPaginatedResponse>;
+    /**
+     * Gets top collections ranked by various stats.
+     * @param args Optional query parameters for sort_by, chain, category, and pagination.
+     * @returns The {@link GetCollectionsPaginatedResponse} returned by the API.
+     */
+    getTopCollections(args?: GetTopCollectionsArgs): Promise<GetCollectionsPaginatedResponse>;
+    /**
+     * Resolve an ENS name, OpenSea username, or wallet address to canonical account info.
+     * @param identifier An ENS name (e.g. vitalik.eth), OpenSea username, or wallet address.
+     * @returns The {@link ResolveAccountResponse} returned by the API.
+     */
+    resolveAccount(identifier: string): Promise<ResolveAccountResponse>;
+    /**
+     * Generic fetch method for any API endpoint with automatic rate limit retry
+     * @param apiPath Path to URL endpoint under API
+     * @param query URL query params. Will be used to create a URLSearchParams object.
+     * @param options Request options like timeout and abort signal.
+     * @returns @typeParam T The response from the API.
+     */
+    get<T>(apiPath: string, query?: object, options?: RequestOptions): Promise<T>;
+    /**
+     * Generic post method for any API endpoint with automatic rate limit retry
+     * @param apiPath Path to URL endpoint under API
+     * @param body Data to send.
+     * @param headers Additional headers to send with the request.
+     * @param options Request options like timeout and abort signal.
+     * @returns @typeParam T The response from the API.
+     */
+    post<T>(apiPath: string, body?: object, headers?: object, options?: RequestOptions): Promise<T>;
+    private objectToSearchParams;
+    /**
+     * Fetch from an API Endpoint, sending auth token in headers
+     * @param url The URL to fetch
+     * @param headers Additional headers to send with the request
+     * @param body Optional body to send. If set, will POST, otherwise GET
+     * @param options Request options like timeout and abort signal
+     */
+    private _fetch;
+    /**
+     * Maximum retry-after value in seconds (5 minutes).
+     * Prevents excessively long waits from buggy or malicious servers.
+     */
+    private static readonly MAX_RETRY_AFTER_SECONDS;
+    /**
+     * Parses the retry-after header from the response with robust error handling.
+     * @param response The HTTP response object from the API
+     * @returns The retry-after value in seconds (capped at 5 minutes), or undefined if not present or invalid
+     */
+    private _parseRetryAfter;
+    /**
+     * Creates a rate limit error with status code and retry-after information.
+     * @param response The HTTP response object from the API
+     * @returns An enhanced Error object with statusCode, retryAfter and responseBody properties
+     */
+    private _createRateLimitError;
+}