@opensea/sdk 13.0.6 → 14.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. package/README.md +127 -131
  2. package/lib/api/api.d.ts +7 -711
  3. package/lib/api/api.js +6 -870
  4. package/lib/api/api.js.map +1 -1
  5. package/lib/api/collections.d.ts +3 -3
  6. package/lib/api/collections.js +5 -4
  7. package/lib/api/collections.js.map +1 -1
  8. package/lib/api/drops.d.ts +1 -1
  9. package/lib/api/drops.js +1 -1
  10. package/lib/api/events.js +1 -1
  11. package/lib/api/events.js.map +1 -1
  12. package/lib/api/fetcher.d.ts +1 -1
  13. package/lib/api/listings.d.ts +2 -3
  14. package/lib/api/listings.js +2 -3
  15. package/lib/api/listings.js.map +1 -1
  16. package/lib/api/nfts.d.ts +1 -1
  17. package/lib/api/nfts.js +1 -1
  18. package/lib/api/orders.d.ts +1 -1
  19. package/lib/api/orders.js +1 -1
  20. package/lib/api/tokens.js +2 -23
  21. package/lib/api/tokens.js.map +1 -1
  22. package/lib/api/types.d.ts +11 -20
  23. package/lib/api/walletAuth.d.ts +2 -2
  24. package/lib/api/walletAuth.js +2 -2
  25. package/lib/auth/index.d.ts +2 -2
  26. package/lib/auth/index.js +1 -3
  27. package/lib/auth/index.js.map +1 -1
  28. package/lib/auth/oauth.d.ts +4 -4
  29. package/lib/auth/oauth.js +4 -4
  30. package/lib/auth/siwx.d.ts +1 -8
  31. package/lib/auth/siwx.js +1 -1
  32. package/lib/auth/siwx.js.map +1 -1
  33. package/lib/auth/types.d.ts +0 -12
  34. package/lib/provider/ethers-adapter.d.ts +1 -1
  35. package/lib/provider/ethers-adapter.js +1 -1
  36. package/lib/provider/seaport-bridge.js +1 -1
  37. package/lib/provider/seaport-bridge.js.map +1 -1
  38. package/lib/provider/viem-adapter.d.ts +1 -1
  39. package/lib/provider/viem-adapter.js +1 -1
  40. package/lib/sdk/assets.d.ts +2 -2
  41. package/lib/sdk/assets.js +2 -2
  42. package/lib/sdk/base.js +2 -2
  43. package/lib/sdk/base.js.map +1 -1
  44. package/lib/sdk/cancellation.d.ts +3 -3
  45. package/lib/sdk/cancellation.js +6 -6
  46. package/lib/sdk/cancellation.js.map +1 -1
  47. package/lib/sdk/fulfillment.d.ts +10 -3
  48. package/lib/sdk/fulfillment.js +39 -8
  49. package/lib/sdk/fulfillment.js.map +1 -1
  50. package/lib/sdk/orders.d.ts +6 -6
  51. package/lib/sdk/orders.js +21 -21
  52. package/lib/sdk/orders.js.map +1 -1
  53. package/lib/stream/client.d.ts +2 -14
  54. package/lib/stream/client.js +3 -19
  55. package/lib/stream/client.js.map +1 -1
  56. package/lib/stream/types.d.ts +3 -26
  57. package/lib/stream/types.js +0 -8
  58. package/lib/stream/types.js.map +1 -1
  59. package/lib/types.d.ts +3 -9
  60. package/lib/types.js +1 -1
  61. package/lib/utils/address.d.ts +2 -2
  62. package/lib/utils/address.js +2 -2
  63. package/lib/utils/case.d.ts +3 -3
  64. package/lib/utils/case.js +1 -1
  65. package/lib/utils/fees.js +1 -1
  66. package/lib/utils/fees.js.map +1 -1
  67. package/lib/utils/rateLimit.d.ts +0 -11
  68. package/lib/utils/rateLimit.js +1 -29
  69. package/lib/utils/rateLimit.js.map +1 -1
  70. package/lib/viem.js +1 -1
  71. package/lib/viem.js.map +1 -1
  72. package/package.json +2 -2
  73. package/src/api/api.ts +12 -1447
  74. package/src/api/collections.ts +7 -4
  75. package/src/api/drops.ts +1 -1
  76. package/src/api/events.ts +1 -1
  77. package/src/api/fetcher.ts +1 -1
  78. package/src/api/listings.ts +2 -3
  79. package/src/api/nfts.ts +1 -1
  80. package/src/api/orders.ts +1 -1
  81. package/src/api/tokens.ts +2 -24
  82. package/src/api/types.ts +15 -23
  83. package/src/api/walletAuth.ts +2 -2
  84. package/src/auth/index.ts +4 -7
  85. package/src/auth/oauth.ts +4 -4
  86. package/src/auth/siwx.ts +1 -8
  87. package/src/auth/types.ts +0 -13
  88. package/src/provider/ethers-adapter.ts +1 -1
  89. package/src/provider/seaport-bridge.ts +1 -1
  90. package/src/provider/viem-adapter.ts +1 -1
  91. package/src/sdk/assets.ts +2 -2
  92. package/src/sdk/base.ts +3 -2
  93. package/src/sdk/cancellation.ts +6 -6
  94. package/src/sdk/fulfillment.ts +70 -21
  95. package/src/sdk/orders.ts +30 -21
  96. package/src/stream/client.ts +2 -26
  97. package/src/stream/types.ts +3 -29
  98. package/src/types.ts +4 -11
  99. package/src/utils/address.ts +2 -2
  100. package/src/utils/case.ts +3 -3
  101. package/src/utils/fees.ts +1 -1
  102. package/src/utils/rateLimit.ts +3 -49
  103. package/src/viem.ts +1 -1
  104. package/src/abi/ERC1155.json +0 -314
  105. package/src/abi/ERC20.json +0 -222
  106. package/src/abi/ERC721.json +0 -333
  107. package/src/abi/Multicall3.json +0 -50
  108. package/src/abi/TransferHelper.json +0 -53
package/lib/api/api.d.ts CHANGED
@@ -1,5 +1,4 @@
1
- import type { FulfillmentDataResponse, ProtocolData } from "../orders/types";
2
- import { Chain, type OpenSeaAccount, type OpenSeaAPIConfig, type OpenSeaCollection, type OpenSeaCollectionStats, type OpenSeaPaymentToken, type OrderSide, type RawResponseOptions, type RequestOptions } from "../types";
1
+ import { type OpenSeaAPIConfig, type RawResponseOptions, type RequestOptions } from "../types";
3
2
  import { type Camelize } from "../utils/case";
4
3
  import { type FetchImpl } from "../utils/fetchTransport";
5
4
  import { AccountsAPI } from "./accounts";
@@ -17,7 +16,7 @@ import { SignalsAPI } from "./signals";
17
16
  import { TokensAPI } from "./tokens";
18
17
  import { ToolsAPI } from "./tools";
19
18
  import { TransactionsAPI } from "./transactions";
20
- import { type AgentProfileRelationshipsResponse, type BatchCollectionsRequest, type BatchNftsRequest, type BatchTokensRequest, type BuildOfferResponse, type CancelOrderResponse, type ClosedPositionsResponse, type CollectionBatchResponse, type CollectionFloorPricesArgs, type CollectionHoldersArgs, type CollectionHoldersPaginatedResponse, type CollectionOffer, type CollectionOfferAggregatesPaginatedResponse, CollectionOrderByOption, type CreateCancelOrderActionsRequest, type CreateCancelOrderActionsResponse, type CreateListingActionsRequest, type CreateListingActionsResponse, type CreateListingFulfillmentActionsRequest, type CreateListingFulfillmentActionsResponse, type CreateOfferActionsRequest, type CreateOfferActionsResponse, type CreateOfferFulfillmentActionsRequest, type CreateOfferFulfillmentActionsResponse, type CrossChainDropMintRequest, type CrossChainDropMintResponse, type CrossChainFulfillmentRequest, type CrossChainFulfillmentResponse, type DropDeployReceiptResponse, type DropDeployRequest, type DropDeployResponse, type DropMintRequest, type DropMintResponse, type FloorPriceHistoryResponse, type GetAccountTokenActivityArgs, type GetAccountTokenActivityResponse, 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 GetEventsByCollectionArgs, type GetEventsResponse, type GetListingsResponse, type GetNFTMetadataResponse, type GetNFTResponse, type GetNFTsByAccountOptions, type GetOffersResponse, type GetOrderByHashResponse, type GetSwapQuoteArgs, type GetSwapQuoteResponse, type GetTokenGroupResponse, type GetTokenGroupsArgs, type GetTokenGroupsResponse, type GetTokenResponse, type GetTokensArgs, type GetTopCollectionsArgs, type GetTopTokensResponse, type GetTraitsResponse, type GetTrendingCollectionsArgs, type GetTrendingTokensResponse, type Listing, type ListNFTsResponse, type NFTOwnersArgs, type NftAnalyticsResponse, type NftBatchResponse, type Offer, type OhlcvResponse, type OwnersPaginatedResponse, type PaginatedAnalyticsArgs, type PortfolioArgs, type PortfolioHistoryResponse, type PortfolioStatsResponse, type PositionTokenTransfersResponse, type PriceHistoryResponse, type ProfileCollectionsArgs, type ProfileCollectionsResponse, type ProfileFavoritesArgs, type ProfileFavoritesResponse, type ProfileListingsResponse, type ProfileOffersResponse, type ProfileOrdersArgs, type RequestInstantApiKeyResponse, type ResolveAccountResponse, type SearchArgs, type SearchResponse, type SwapExecuteRequest, type SwapExecuteResponse, type SweepCollectionRequest, type SweepCollectionResponse, type TokenActivityArgs, type TokenActivityStatsArgs, type TokenActivityStatsResponse, type TokenBatchResponse, type TokenHoldersArgs, type TokenHoldersResponse, type TokenLiquidityPoolsArgs, type TokenLiquidityPoolsResponse, type TokenSwapActivityPaginatedResponse, type TokenTimeSeriesArgs, type TraitFilter, type TraitFloorsResponse, type TraitOffersFilters, type TransactionReceiptRequest, type TransactionReceiptResponse, type TransferRequest, type TransferResponse, type ValidateMetadataResponse, type WalletClosedPositionsArgs, type WalletPnlResponse, type WalletTokenTransfersArgs } from "./types";
19
+ import type { RequestInstantApiKeyResponse, SearchArgs, SearchResponse } from "./types";
21
20
  import { WalletAuthAPI } from "./walletAuth";
22
21
  /**
23
22
  * The API class for the OpenSea SDK.
@@ -54,8 +53,8 @@ export declare class OpenSeaAPI {
54
53
  private readonly fetchImpl;
55
54
  private chain;
56
55
  /**
57
- * Per-domain clients. Prefer these over the flat `getCollection` / `getTraits` style methods on
58
- * this class, which are deprecated and will be removed in the next major.
56
+ * Per-domain clients. Every endpoint is reached through one of these, for example
57
+ * `api.collections.getCollection(slug)`.
59
58
  *
60
59
  * `search` is absent because `SearchAPI` holds a single method also called `search`, so the
61
60
  * property and the existing `search()` method want the same name and only one can be added
@@ -87,389 +86,6 @@ export declare class OpenSeaAPI {
87
86
  * @param logger Optional function for logging debug strings before and after requests are made. Defaults to no logging
88
87
  */
89
88
  constructor(config: OpenSeaAPIConfig, logger?: (arg: string) => void);
90
- /**
91
- * Gets a single order by its order hash.
92
- * @param orderHash The hash of the order to fetch
93
- * @param protocolAddress The address of the seaport contract
94
- * @param chain The chain where the order is located. Defaults to the chain set in the constructor.
95
- * @returns The {@link GetOrderByHashResponse} returned by the API (can be Offer or Listing)
96
- * @throws An error if the order is not found
97
- * @deprecated Use `api.orders.getOrderByHash()`. Removed in the next major.
98
- */
99
- getOrderByHash(orderHash: string, protocolAddress: string, chain?: Chain): Promise<GetOrderByHashResponse>;
100
- /**
101
- * Gets all offers for a given collection.
102
- * @param collectionSlug The slug of the collection.
103
- * @param limit The number of offers to return. Must be between 1 and 100. Default: 100
104
- * @param next The cursor for the next page of results. This is returned from a previous request.
105
- * @param maker Only return offers made by this wallet address.
106
- * @returns The {@link GetOffersResponse} returned by the API.
107
- * @deprecated Use `api.offers.getAllOffers()`. Removed in the next major.
108
- */
109
- getAllOffers(collectionSlug: string, limit?: number, next?: string, maker?: string): Promise<GetOffersResponse>;
110
- /**
111
- * Gets all listings for a given collection.
112
- * @param collectionSlug The slug of the collection.
113
- * @param limit The number of listings to return. Must be between 1 and 100. Default: 100
114
- * @param next The cursor for the next page of results. This is returned from a previous request.
115
- * @param includePrivateListings Whether to include private listings (default: false)
116
- * @param maker Only return listings made by this wallet address.
117
- * @returns The {@link GetListingsResponse} returned by the API.
118
- * @deprecated Use `api.listings.getAllListings()`. Removed in the next major.
119
- */
120
- getAllListings(collectionSlug: string, limit?: number, next?: string, includePrivateListings?: boolean, maker?: string): Promise<GetListingsResponse>;
121
- /**
122
- * Gets trait offers for a given collection.
123
- * @param collectionSlug The slug of the collection.
124
- * @param type The name of the trait (e.g. 'Background').
125
- * @param value The value of the trait (e.g. 'Red').
126
- * @param limit The number of offers to return. Must be between 1 and 100. Default: 100
127
- * @param next The cursor for the next page of results. This is returned from a previous request.
128
- * @param floatValue The value of the trait for decimal-based numeric traits.
129
- * @param intValue The value of the trait for integer-based numeric traits.
130
- * @param filters Optional {@link TraitOffersFilters}: `mode`, a numeric range, or multi-trait `traits`.
131
- * @returns The {@link GetOffersResponse} returned by the API.
132
- * @deprecated Use `api.offers.getTraitOffers()`. Removed in the next major.
133
- */
134
- getTraitOffers(collectionSlug: string, type: string | undefined, value: string | undefined, limit?: number, next?: string, floatValue?: number, intValue?: number, filters?: TraitOffersFilters): Promise<GetOffersResponse>;
135
- /**
136
- * Gets the best offer for a given token.
137
- * @param collectionSlug The slug of the collection.
138
- * @param tokenId The token identifier.
139
- * @returns The {@link GetBestOfferResponse} returned by the API.
140
- * @deprecated Use `api.offers.getBestOffer()`. Removed in the next major.
141
- */
142
- getBestOffer(collectionSlug: string, tokenId: string | number): Promise<GetBestOfferResponse>;
143
- /**
144
- * Gets the best listing for a given token.
145
- * @param collectionSlug The slug of the collection.
146
- * @param tokenId The token identifier.
147
- * @param includePrivateListings Whether to include private listings (default: false)
148
- * @returns The {@link GetBestListingResponse} returned by the API.
149
- * @deprecated Use `api.listings.getBestListing()`. Removed in the next major.
150
- */
151
- getBestListing(collectionSlug: string, tokenId: string | number, includePrivateListings?: boolean): Promise<GetBestListingResponse>;
152
- /**
153
- * Gets the best listings for a given collection.
154
- * @param collectionSlug The slug of the collection.
155
- * @param limit The number of listings to return. Must be between 1 and 100. Default: 100
156
- * @param next The cursor for the next page of results. This is returned from a previous request.
157
- * @param includePrivateListings Whether to include private listings (default: false)
158
- * @param traits Optional {@link TraitFilter} array. Returns 400 if a single trait matches more than 1000 items.
159
- * @returns The {@link GetListingsResponse} returned by the API.
160
- * @deprecated Use `api.listings.getBestListings()`. Removed in the next major.
161
- */
162
- getBestListings(collectionSlug: string, limit?: number, next?: string, includePrivateListings?: boolean, traits?: TraitFilter[]): Promise<GetListingsResponse>;
163
- /**
164
- * Get cross-chain fulfillment data for one or more listings.
165
- * Supports same-chain, cross-token, and cross-chain purchases (up to 50 listings).
166
- * All listings must be EVM (Seaport orders). Payment can be from any chain (EVM or SVM).
167
- * @param request The cross-chain fulfillment request containing listings, fulfiller, payment, and optional recipient
168
- * @returns The {@link CrossChainFulfillmentResponse} with ordered transactions to sign and submit
169
- * @deprecated Use `api.listings.getCrossChainFulfillmentData()`. Removed in the next major.
170
- */
171
- getCrossChainFulfillmentData(request: CrossChainFulfillmentRequest): Promise<CrossChainFulfillmentResponse>;
172
- /**
173
- * Generate the data needed to fulfill a listing or an offer onchain.
174
- * @param fulfillerAddress The wallet address which will be used to fulfill the order
175
- * @param orderHash The hash of the order to fulfill
176
- * @param protocolAddress The address of the seaport contract
177
- * @param side The side of the order (buy or sell)
178
- * @param assetContractAddress Optional address of the NFT contract for criteria offers (e.g., collection offers)
179
- * @param tokenId Optional token ID for criteria offers (e.g., collection offers)
180
- * @param unitsToFill Optional number of units to fill. Defaults to 1 for both listings and offers.
181
- * @param recipientAddress Optional recipient address for the NFT when fulfilling a listing. Not applicable for offers.
182
- * @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.
183
- * @returns The {@link FulfillmentDataResponse}
184
- * @deprecated Use `api.orders.generateFulfillmentData()`. Removed in the next major.
185
- */
186
- generateFulfillmentData(fulfillerAddress: string, orderHash: string, protocolAddress: string, side: OrderSide, assetContractAddress?: string, tokenId?: string, unitsToFill?: string, recipientAddress?: string, includeOptionalCreatorFees?: boolean): Promise<Camelize<FulfillmentDataResponse>>;
187
- /**
188
- * Post a listing to OpenSea. Returns the new v2 Listing response format.
189
- * @param order The order to post
190
- * @param protocolAddress The contract address of the seaport protocol
191
- * @returns The {@link Listing} posted to the API.
192
- * @deprecated Use `api.orders.postListing()`. Removed in the next major.
193
- */
194
- postListing(order: ProtocolData, protocolAddress: string): Promise<Listing>;
195
- /**
196
- * Post an offer to OpenSea. Returns the new v2 Offer response format.
197
- * @param order The order to post
198
- * @param protocolAddress The contract address of the seaport protocol
199
- * @returns The {@link Offer} posted to the API.
200
- * @deprecated Use `api.orders.postOffer()`. Removed in the next major.
201
- */
202
- postOffer(order: ProtocolData, protocolAddress: string): Promise<Offer>;
203
- /**
204
- * Build a OpenSea collection offer.
205
- * @param offererAddress The wallet address which is creating the offer.
206
- * @param quantity The number of NFTs requested in the offer.
207
- * @param collectionSlug The slug (identifier) of the collection to build the offer for.
208
- * @param offerProtectionEnabled Build the offer on OpenSea's signed zone to provide offer protections from receiving an item which is disabled from trading.
209
- * @param traitType If defined, the trait name to create the collection offer for.
210
- * @param traitValue If defined, the trait value to create the collection offer for.
211
- * @param traits If defined, an array of traits to create the multi-trait collection offer for.
212
- * @param numericTraits If defined, an array of numeric trait criteria with min/max ranges.
213
- * @returns The {@link BuildOfferResponse} returned by the API.
214
- * @deprecated Use `api.offers.buildOffer()`. Removed in the next major.
215
- */
216
- buildOffer(offererAddress: string, quantity: number, collectionSlug: string, offerProtectionEnabled?: boolean, traitType?: string, traitValue?: string, traits?: Array<{
217
- type: string;
218
- value: string;
219
- }>, numericTraits?: Array<{
220
- type: string;
221
- min?: number;
222
- max?: number;
223
- }>): Promise<BuildOfferResponse>;
224
- /**
225
- * Get a list collection offers for a given slug.
226
- * @param slug The slug (identifier) of the collection to list offers for
227
- * @param limit Optional limit for number of results.
228
- * @param next Optional cursor for pagination.
229
- * @returns The {@link GetOffersResponse} returned by the API.
230
- * @deprecated Use `api.offers.getCollectionOffers()`. Removed in the next major.
231
- */
232
- getCollectionOffers(slug: string, limit?: number, next?: string): Promise<GetOffersResponse>;
233
- /**
234
- * Post a collection offer to OpenSea.
235
- * @param order The collection offer to post.
236
- * @param slug The slug (identifier) of the collection to post the offer for.
237
- * @param traitType If defined, the trait name to create the collection offer for.
238
- * @param traitValue If defined, the trait value to create the collection offer for.
239
- * @param traits If defined, an array of traits to create the multi-trait collection offer for.
240
- * @param numericTraits If defined, an array of numeric trait criteria with min/max ranges.
241
- * @returns The {@link Offer} returned to the API.
242
- * @deprecated Use `api.offers.postCollectionOffer()`. Removed in the next major.
243
- */
244
- postCollectionOffer(order: ProtocolData, slug: string, traitType?: string, traitValue?: string, traits?: Array<{
245
- type: string;
246
- value: string;
247
- }>, numericTraits?: Array<{
248
- type: string;
249
- min?: number;
250
- max?: number;
251
- }>): Promise<CollectionOffer | null>;
252
- /**
253
- * Fetch multiple NFTs for a collection.
254
- * @param slug The slug (identifier) of the collection
255
- * @param limit The number of NFTs to retrieve. Must be greater than 0 and less than 51.
256
- * @param next Cursor to retrieve the next page of NFTs
257
- * @param traits Optional {@link TraitFilter} array. Returns 400 if a single trait matches more than 1000 items.
258
- * @param hasAgentBinding Only return NFTs that do (`true`) or do not (`false`) have an ERC-8217 agent binding.
259
- * @returns The {@link ListNFTsResponse} returned by the API.
260
- * @deprecated Use `api.nfts.getNFTsByCollection()`. Removed in the next major.
261
- */
262
- getNFTsByCollection(slug: string, limit?: number | undefined, next?: string | undefined, traits?: TraitFilter[] | undefined, hasAgentBinding?: boolean | undefined): Promise<ListNFTsResponse>;
263
- /**
264
- * Fetch multiple NFTs for a contract.
265
- * @param address The NFT's contract address.
266
- * @param limit The number of NFTs to retrieve. Must be greater than 0 and less than 51.
267
- * @param next Cursor to retrieve the next page of NFTs.
268
- * @param chain The NFT's chain.
269
- * @returns The {@link ListNFTsResponse} returned by the API.
270
- * @deprecated Use `api.nfts.getNFTsByContract()`. Removed in the next major.
271
- */
272
- getNFTsByContract(address: string, limit?: number | undefined, next?: string | undefined, chain?: Chain): Promise<ListNFTsResponse>;
273
- /**
274
- * Fetch NFTs owned by an account.
275
- * @param address The address of the account
276
- * @param limit The number of NFTs to retrieve. Must be greater than 0 and less than 51.
277
- * @param next Cursor to retrieve the next page of NFTs
278
- * @param chain The chain to query. Defaults to the chain set in the constructor.
279
- * @param options Non-pagination filters, currently `includeAutoHidden`.
280
- * @returns The {@link ListNFTsResponse} returned by the API.
281
- * @deprecated Use `api.nfts.getNFTsByAccount()`. Removed in the next major.
282
- */
283
- getNFTsByAccount(address: string, limit?: number | undefined, next?: string | undefined, chain?: Chain, options?: GetNFTsByAccountOptions): Promise<ListNFTsResponse>;
284
- /**
285
- * Fetch metadata, traits, ownership information, and rarity for a single NFT.
286
- * @param address The NFT's contract address.
287
- * @param identifier the identifier of the NFT (i.e. Token ID)
288
- * @param chain The NFT's chain.
289
- * @returns The {@link GetNFTResponse} returned by the API.
290
- * @deprecated Use `api.nfts.getNFT()`. Removed in the next major.
291
- */
292
- getNFT(address: string, identifier: string, chain?: Chain): Promise<GetNFTResponse>;
293
- /**
294
- * Fetch an OpenSea collection.
295
- * @param slug The slug (identifier) of the collection.
296
- * @returns The {@link OpenSeaCollection} returned by the API.
297
- * @deprecated Use `api.collections.getCollection()`. Removed in the next major.
298
- */
299
- getCollection(slug: string): Promise<OpenSeaCollection>;
300
- /**
301
- * Fetch a list of OpenSea collections.
302
- * @param orderBy The order to return the collections in. Default: CREATED_DATE
303
- * @param chain The chain to filter the collections on. Default: all chains
304
- * @param creatorUsername The creator's OpenSea username to filter the collections on.
305
- * @param includeHidden If hidden collections should be returned. Default: false
306
- * @param limit The limit of collections to return.
307
- * @param next The cursor for the next page of results. This is returned from a previous request.
308
- * @returns List of {@link OpenSeaCollection} returned by the API.
309
- * @deprecated Use `api.collections.getCollections()`. Removed in the next major.
310
- */
311
- getCollections(orderBy?: CollectionOrderByOption, chain?: Chain, creatorUsername?: string, includeHidden?: boolean, limit?: number, next?: string): Promise<GetCollectionsResponse>;
312
- /**
313
- * Fetch stats for an OpenSea collection.
314
- * @param slug The slug (identifier) of the collection.
315
- * @returns The {@link OpenSeaCollection} returned by the API.
316
- * @deprecated Use `api.collections.getCollectionStats()`. Removed in the next major.
317
- */
318
- getCollectionStats(slug: string): Promise<OpenSeaCollectionStats>;
319
- /**
320
- * Fetch a payment token.
321
- * @param address The address of the payment token
322
- * @param chain The chain of the payment token
323
- * @returns The {@link OpenSeaPaymentToken} returned by the API.
324
- * @deprecated Use `api.accounts.getPaymentToken()`. Removed in the next major.
325
- */
326
- getPaymentToken(address: string, chain?: Chain): Promise<OpenSeaPaymentToken>;
327
- /**
328
- * Fetch account for an address.
329
- * @param address The address to fetch the account for
330
- * @returns The {@link OpenSeaAccount} returned by the API.
331
- * @deprecated Use `api.accounts.getAccount()`. Removed in the next major.
332
- */
333
- getAccount(address: string): Promise<OpenSeaAccount>;
334
- /**
335
- * Force refresh the metadata for an NFT.
336
- * @param address The address of the NFT's contract.
337
- * @param identifier The identifier of the NFT.
338
- * @param chain The chain where the NFT is located.
339
- * @returns The response from the API.
340
- * @deprecated Use `api.nfts.refreshNFTMetadata()`. Removed in the next major.
341
- */
342
- refreshNFTMetadata(address: string, identifier: string, chain?: Chain): Promise<Record<string, unknown>>;
343
- /**
344
- * Offchain cancel an order, offer or listing, by its order hash when protected by the SignedZone.
345
- *
346
- * The API refuses an offchain cancel for a recently created order ("Orders created recently
347
- * must be cancelled onchain"). Cancel it onchain instead with `sdk.cancelOrder()`, or build the
348
- * steps with `api.orders.createCancelOrderActions()`.
349
- * Protocol and Chain are required to prevent hash collisions.
350
- * Please note cancellation is only assured if a fulfillment signature was not vended prior to cancellation.
351
- * @param protocolAddress The Seaport address for the order.
352
- * @param orderHash The order hash, or external identifier, of the order.
353
- * @param chain The chain where the order is located.
354
- * @param offererSignature An EIP-712 signature from the offerer of the order.
355
- * If this is not provided, the user associated with the API Key will be checked instead.
356
- * The signature must be a EIP-712 signature consisting of the order's Seaport contract's
357
- * name, version, address, and chain. The struct to sign is `OrderHash` containing a
358
- * single bytes32 field.
359
- * @returns The response from the API.
360
- * @deprecated Use `api.orders.offchainCancelOrder()`. Removed in the next major.
361
- */
362
- offchainCancelOrder(protocolAddress: string, orderHash: string, chain?: Chain, offererSignature?: string): Promise<CancelOrderResponse>;
363
- /**
364
- * Get ordered actions to cancel an order onchain.
365
- * @deprecated Use `api.orders.createCancelOrderActions()`. Removed in the next major.
366
- */
367
- createCancelOrderActions(protocolAddress: string, orderIdentifier: string, request: CreateCancelOrderActionsRequest, chain?: Chain): Promise<CreateCancelOrderActionsResponse>;
368
- /**
369
- * Gets a list of events based on query parameters.
370
- * @param args Query parameters for filtering events.
371
- * @returns The {@link GetEventsResponse} returned by the API.
372
- * @deprecated Use `api.events.getEvents()`. Removed in the next major.
373
- */
374
- getEvents(args?: GetEventsArgs): Promise<GetEventsResponse>;
375
- /**
376
- * Gets a list of events for a specific account.
377
- * @param address The account address.
378
- * @param args Query parameters for filtering events.
379
- * @returns The {@link GetEventsResponse} returned by the API.
380
- * @deprecated Use `api.events.getEventsByAccount()`. Removed in the next major.
381
- */
382
- getEventsByAccount(address: string, args?: GetEventsArgs): Promise<GetEventsResponse>;
383
- /**
384
- * Gets a list of events for a specific collection. Pass `args.traits` to
385
- * filter server-side by item traits (multiple entries are AND-combined).
386
- * @param collectionSlug The slug (identifier) of the collection.
387
- * @param args Query parameters; see {@link GetEventsByCollectionArgs}.
388
- * @returns The {@link GetEventsResponse} returned by the API.
389
- * @deprecated Use `api.events.getEventsByCollection()`. Removed in the next major.
390
- */
391
- getEventsByCollection(collectionSlug: string, args?: GetEventsByCollectionArgs): Promise<GetEventsResponse>;
392
- /**
393
- * Gets a list of events for a specific NFT.
394
- * @param chain The chain where the NFT is located.
395
- * @param address The contract address of the NFT.
396
- * @param identifier The token identifier.
397
- * @param args Query parameters for filtering events.
398
- * @returns The {@link GetEventsResponse} returned by the API.
399
- * @deprecated Use `api.events.getEventsByNFT()`. Removed in the next major.
400
- */
401
- getEventsByNFT(chain: Chain, address: string, identifier: string, args?: GetEventsArgs): Promise<GetEventsResponse>;
402
- /**
403
- * Fetch smart contract information for a given chain and address.
404
- * @param address The contract address.
405
- * @param chain The chain where the contract is deployed. Defaults to the chain set in the constructor.
406
- * @returns The {@link GetContractResponse} returned by the API.
407
- * @deprecated Use `api.nfts.getContract()`. Removed in the next major.
408
- */
409
- getContract(address: string, chain?: Chain): Promise<GetContractResponse>;
410
- /**
411
- * Fetch all traits for a collection with their possible values and counts.
412
- * @param collectionSlug The slug (identifier) of the collection.
413
- * @returns The {@link GetTraitsResponse} returned by the API.
414
- * @deprecated Use `api.collections.getTraits()`. Removed in the next major.
415
- */
416
- getTraits(collectionSlug: string): Promise<GetTraitsResponse>;
417
- /**
418
- * Fetch floor prices per trait value for a collection.
419
- *
420
- * Covers text traits with at least one active listing, ordered by trait type, then value, then
421
- * price. Numeric traits are not enumerated here; use {@link getTraits} for their min/max range.
422
- * Every floor is denominated on the collection's own chain, identified by `chain` plus each
423
- * entry's `paymentTokenSymbol`.
424
- * @param collectionSlug The slug (identifier) of the collection.
425
- * @returns The {@link TraitFloorsResponse} returned by the API.
426
- * @deprecated Use `api.collections.getCollectionTraitFloors()`. Removed in the next major.
427
- */
428
- getCollectionTraitFloors(collectionSlug: string): Promise<TraitFloorsResponse>;
429
- /**
430
- * Gets a list of trending tokens.
431
- * @param args Optional query parameters for pagination.
432
- * @returns The {@link GetTrendingTokensResponse} returned by the API.
433
- * @deprecated Use `api.tokens.getTrendingTokens()`. Removed in the next major.
434
- */
435
- getTrendingTokens(args?: GetTokensArgs): Promise<GetTrendingTokensResponse>;
436
- /**
437
- * Gets a list of top tokens.
438
- * @param args Optional query parameters for pagination.
439
- * @returns The {@link GetTopTokensResponse} returned by the API.
440
- * @deprecated Use `api.tokens.getTopTokens()`. Removed in the next major.
441
- */
442
- getTopTokens(args?: GetTokensArgs): Promise<GetTopTokensResponse>;
443
- /**
444
- * Gets a swap quote for exchanging tokens.
445
- * @param args Query parameters for the swap quote including token addresses, amount, and chain.
446
- * @returns The {@link GetSwapQuoteResponse} returned by the API.
447
- * @deprecated Use `api.tokens.getSwapQuote()`. Removed in the next major.
448
- */
449
- getSwapQuote(args: GetSwapQuoteArgs): Promise<GetSwapQuoteResponse>;
450
- /**
451
- * Gets details for a specific token.
452
- * @param chain The chain the token is on.
453
- * @param address The token contract address.
454
- * @returns The {@link GetTokenResponse} returned by the API.
455
- * @deprecated Use `api.tokens.getToken()`. Removed in the next major.
456
- */
457
- getToken(chain: string, address: string): Promise<GetTokenResponse>;
458
- /**
459
- * Gets a paginated list of token groups — equivalent currencies across
460
- * chains (e.g. ETH on Ethereum, Base, and Arbitrum share the "eth" group).
461
- * @param args Optional query parameters (`limit`, `cursor`).
462
- * @returns The {@link GetTokenGroupsResponse} returned by the API.
463
- * @deprecated Use `api.tokens.getTokenGroups()`. Removed in the next major.
464
- */
465
- getTokenGroups(args?: GetTokenGroupsArgs): Promise<GetTokenGroupsResponse>;
466
- /**
467
- * Gets a single token group by its slug (e.g. "eth").
468
- * @param slug The token group slug.
469
- * @returns The {@link GetTokenGroupResponse} returned by the API.
470
- * @deprecated Use `api.tokens.getTokenGroup()`. Removed in the next major.
471
- */
472
- getTokenGroup(slug: string): Promise<GetTokenGroupResponse>;
473
89
  /**
474
90
  * Search across collections, tokens, NFTs, and accounts.
475
91
  * Results are ranked by relevance.
@@ -477,326 +93,6 @@ export declare class OpenSeaAPI {
477
93
  * @returns The {@link SearchResponse} returned by the API.
478
94
  */
479
95
  search(args: SearchArgs): Promise<SearchResponse>;
480
- /**
481
- * Gets the list of supported blockchains and their capabilities.
482
- * @returns The {@link GetChainsResponse} returned by the API.
483
- * @deprecated Use `api.chains.getChains()`. Removed in the next major.
484
- */
485
- getChains(): Promise<GetChainsResponse>;
486
- /**
487
- * Gets token balances for a given account.
488
- * @param address The wallet address to fetch token balances for.
489
- * @param args Optional query parameters for filtering and pagination.
490
- * @returns The {@link GetAccountTokensResponse} returned by the API.
491
- * @deprecated Use `api.accounts.getAccountTokens()`. Removed in the next major.
492
- */
493
- getAccountTokens(address: string, args?: GetAccountTokensArgs): Promise<GetAccountTokensResponse>;
494
- /**
495
- * Validate NFT metadata by fetching and parsing it.
496
- * @param address The NFT contract address.
497
- * @param identifier The token identifier.
498
- * @param chain The chain where the NFT is located. Defaults to the chain set in the constructor.
499
- * @param ignoreCachedItemUrls Whether to ignore cached item URLs and re-fetch from source.
500
- * @returns The {@link ValidateMetadataResponse} returned by the API.
501
- * @deprecated Use `api.nfts.validateMetadata()`. Removed in the next major.
502
- */
503
- validateNFTMetadata(address: string, identifier: string, chain?: Chain, ignoreCachedItemUrls?: boolean): Promise<ValidateMetadataResponse>;
504
- /**
505
- * Gets all active offers for a specific NFT (not just the best offer).
506
- * @param collectionSlug The collection slug.
507
- * @param identifier The NFT token id.
508
- * @param limit The number of offers to return. Must be between 1 and 200.
509
- * @param next The cursor for the next page of results.
510
- * @returns The {@link GetOffersResponse} returned by the API.
511
- * @deprecated Use `api.offers.getOffersByNFT()`. Removed in the next major.
512
- */
513
- getOffersByNFT(collectionSlug: string, identifier: string | number, limit?: number, next?: string): Promise<GetOffersResponse>;
514
- /**
515
- * Bulk-buy items from a collection using any payment token, including
516
- * cross-chain. Returns an ordered list of transactions to execute.
517
- * @param request The sweep request containing buyer, collection, payment, and item caps.
518
- * @returns The {@link SweepCollectionResponse} returned by the API.
519
- * @deprecated Use `api.listings.sweepCollection()`. Removed in the next major.
520
- */
521
- sweepCollection(request: SweepCollectionRequest): Promise<SweepCollectionResponse>;
522
- /**
523
- * Get executable transactions for a token swap. Companion to
524
- * {@link OpenSeaAPI.getSwapQuote} — quote first, then execute.
525
- * @param request The swap execution request.
526
- * @returns The {@link SwapExecuteResponse} with transactions and a quote.
527
- * @deprecated Use `api.tokens.executeSwap()`. Removed in the next major.
528
- */
529
- executeSwap(request: SwapExecuteRequest): Promise<SwapExecuteResponse>;
530
- /**
531
- * Get the receipt/status for a submitted transaction. Works for all transaction
532
- * types: listing fulfillments, cross-chain buys and mints, sweeps, offer
533
- * fulfillments, and token swaps. Poll this endpoint to check completion status.
534
- * @param request The transaction receipt request.
535
- * @returns The {@link TransactionReceiptResponse} returned by the API.
536
- * @deprecated Use `api.transactions.getTransactionReceipt()`. Removed in the next major.
537
- */
538
- getTransactionReceipt(request: TransactionReceiptRequest): Promise<TransactionReceiptResponse>;
539
- /**
540
- * Gets a list of drops (mints).
541
- * @param args Optional query parameters for filtering and pagination.
542
- * @returns The {@link GetDropsResponse} returned by the API.
543
- * @deprecated Use `api.drops.getDrops()`. Removed in the next major.
544
- */
545
- getDrops(args?: GetDropsArgs): Promise<GetDropsResponse>;
546
- /**
547
- * Gets detailed drop information for a collection.
548
- * @param slug The collection slug identifying the drop.
549
- * @returns The {@link GetDropResponse} returned by the API.
550
- * @deprecated Use `api.drops.getDrop()`. Removed in the next major.
551
- */
552
- getDrop(slug: string): Promise<GetDropResponse>;
553
- /**
554
- * Builds a mint transaction for a drop.
555
- * @param slug The collection slug identifying the drop.
556
- * @param request The mint request containing minter address and quantity.
557
- * @returns The {@link DropMintResponse} with ready-to-sign transaction data.
558
- * @deprecated Use `api.drops.buildMintTransaction()`. Removed in the next major.
559
- */
560
- buildDropMintTransaction(slug: string, request: DropMintRequest): Promise<DropMintResponse>;
561
- /**
562
- * Builds ordered transactions for paying on one chain and minting a drop on
563
- * another. Submit each transaction in order, then pass the returned
564
- * `receiptRequest` unchanged to {@link OpenSeaAPI.getTransactionReceipt}
565
- * until the status is terminal.
566
- * @param slug The collection slug identifying the drop.
567
- * @param request The payer, minter, quantity, and source payment asset.
568
- * @returns Transactions to submit and the request used to poll their receipt.
569
- * @deprecated Use `api.drops.buildCrossChainMintTransactions()`. Removed in the next major.
570
- */
571
- buildCrossChainDropMintTransactions(slug: string, request: CrossChainDropMintRequest): Promise<CrossChainDropMintResponse>;
572
- /**
573
- * Gets trending collections sorted by sales activity.
574
- * @param args Optional query parameters for timeframe, chain, category, and pagination.
575
- * @returns The {@link GetCollectionsPaginatedResponse} returned by the API.
576
- * @deprecated Use `api.collections.getTrendingCollections()`. Removed in the next major.
577
- */
578
- getTrendingCollections(args?: GetTrendingCollectionsArgs): Promise<GetCollectionsPaginatedResponse>;
579
- /**
580
- * Gets top collections ranked by various stats.
581
- * @param args Optional query parameters for sort_by, chain, category, and pagination.
582
- * @returns The {@link GetCollectionsPaginatedResponse} returned by the API.
583
- * @deprecated Use `api.collections.getTopCollections()`. Removed in the next major.
584
- */
585
- getTopCollections(args?: GetTopCollectionsArgs): Promise<GetCollectionsPaginatedResponse>;
586
- /**
587
- * Resolve an ENS name, OpenSea username, or wallet address to canonical account info.
588
- * @param identifier An ENS name (e.g. vitalik.eth), OpenSea username, or wallet address.
589
- * @returns The {@link ResolveAccountResponse} returned by the API.
590
- * @deprecated Use `api.accounts.resolveAccount()`. Removed in the next major.
591
- */
592
- resolveAccount(identifier: string): Promise<ResolveAccountResponse>;
593
- /**
594
- * Get the public agent ownership relationships for a profile.
595
- * This is a public read and does not require wallet authentication.
596
- * @param addressOrUsername An ENS name, OpenSea username, or wallet address.
597
- * @returns The {@link AgentProfileRelationshipsResponse} returned by the API.
598
- * @deprecated Use `api.accounts.getAgentProfileRelationships()`. Removed in the next major.
599
- */
600
- getAgentProfileRelationships(addressOrUsername: string): Promise<AgentProfileRelationshipsResponse>;
601
- /**
602
- * Get the collection that an NFT belongs to.
603
- * Useful for multi-contract collections where the token ID disambiguates
604
- * which collection the NFT belongs to.
605
- * @param address The NFT contract address.
606
- * @param identifier The token identifier.
607
- * @param chain The chain where the NFT is located. Defaults to the chain set in the constructor.
608
- * @returns The {@link OpenSeaCollection} returned by the API.
609
- * @deprecated Use `api.nfts.getNFTCollection()`. Removed in the next major.
610
- */
611
- getNFTCollection(address: string, identifier: string, chain?: Chain): Promise<OpenSeaCollection>;
612
- /**
613
- * Get detailed metadata for an NFT including name, description, image, traits,
614
- * and external links.
615
- * @param address The NFT contract address.
616
- * @param tokenId The token identifier.
617
- * @param chain The chain where the NFT is located. Defaults to the chain set in the constructor.
618
- * @returns The {@link GetNFTMetadataResponse} returned by the API.
619
- * @deprecated Use `api.nfts.getNFTMetadata()`. Removed in the next major.
620
- */
621
- getNFTMetadata(address: string, tokenId: string, chain?: Chain): Promise<GetNFTMetadataResponse>;
622
- /**
623
- * Fetch multiple tokens in a single request.
624
- * @param request Batch request listing chain + contract address pairs.
625
- * @returns The {@link TokenBatchResponse} with detailed token info.
626
- * @deprecated Use `api.tokens.getTokensBatch()`. Removed in the next major.
627
- */
628
- getTokensBatch(request: BatchTokensRequest): Promise<TokenBatchResponse>;
629
- /**
630
- * Fetch the price history of a token.
631
- * @param chain Chain the token lives on.
632
- * @param address Token contract address.
633
- * @param args Time-series window — `start_time` required, `end_time` defaults to now.
634
- * @returns The {@link PriceHistoryResponse} returned by the API.
635
- * @deprecated Use `api.tokens.getTokenPriceHistory()`. Removed in the next major.
636
- */
637
- getTokenPriceHistory(chain: Chain, address: string, args: TokenTimeSeriesArgs): Promise<PriceHistoryResponse>;
638
- /**
639
- * Fetch OHLCV candles for a token.
640
- * @param chain Chain the token lives on.
641
- * @param address Token contract address.
642
- * @param args Time-series window plus candle `bucketSize` (required).
643
- * @returns The {@link OhlcvResponse} returned by the API.
644
- * @deprecated Use `api.tokens.getTokenOhlcv()`. Removed in the next major.
645
- */
646
- getTokenOhlcv(chain: Chain, address: string, args: TokenTimeSeriesArgs & {
647
- bucketSize: string;
648
- }): Promise<OhlcvResponse>;
649
- /**
650
- * Fetch recent swap activity for a token.
651
- * @deprecated Use `api.tokens.getTokenActivity()`. Removed in the next major.
652
- */
653
- getTokenActivity(chain: Chain, address: string, args?: TokenActivityArgs): Promise<TokenSwapActivityPaginatedResponse>;
654
- /**
655
- * Fetch materialized trade count, USD volume, and average trade size for a
656
- * token across the requested windows.
657
- * @deprecated Use `api.tokens.getTokenActivityStats()`. Removed in the next major.
658
- */
659
- getTokenActivityStats(chain: Chain, address: string, args?: TokenActivityStatsArgs): Promise<TokenActivityStatsResponse>;
660
- /**
661
- * Fetch paginated fungible token activity (transfers, swaps, wraps, and
662
- * unwraps) for an account across all chains.
663
- * @deprecated Use `api.tokens.getAccountTokenActivity()`. Removed in the next major.
664
- */
665
- getAccountTokenActivity(address: string, args?: GetAccountTokenActivityArgs): Promise<GetAccountTokenActivityResponse>;
666
- /**
667
- * Fetch paginated holders for a token, including quantity held, USD value,
668
- * and holder distribution: top-holder concentration and a health label
669
- * (STRONG | HEALTHY | CONCERNING | BAD). See `api.tokens.getTokenHolders()`
670
- * for the distribution fields.
671
- * @deprecated Use `api.tokens.getTokenHolders()`. Removed in the next major.
672
- */
673
- getTokenHolders(chain: Chain, address: string, args?: TokenHoldersArgs): Promise<TokenHoldersResponse>;
674
- /**
675
- * Fetch liquidity pools for a token (pool type, USD reserves, and
676
- * bonding-curve progress / graduation flag where applicable).
677
- * @deprecated Use `api.tokens.getTokenLiquidityPools()`. Removed in the next major.
678
- */
679
- getTokenLiquidityPools(chain: Chain, address: string, args?: TokenLiquidityPoolsArgs): Promise<TokenLiquidityPoolsResponse>;
680
- /**
681
- * Fetch multiple NFTs in a single request.
682
- * @deprecated Use `api.nfts.getNFTsBatch()`. Removed in the next major.
683
- */
684
- getNFTsBatch(request: BatchNftsRequest): Promise<NftBatchResponse>;
685
- /**
686
- * Fetch owners of an NFT.
687
- * @deprecated Use `api.nfts.getNFTOwners()`. Removed in the next major.
688
- */
689
- getNFTOwners(address: string, identifier: string, chain?: Chain, args?: NFTOwnersArgs): Promise<OwnersPaginatedResponse>;
690
- /**
691
- * Fetch analytics (historical sale points) for an NFT.
692
- * @deprecated Use `api.nfts.getNFTAnalytics()`. Removed in the next major.
693
- */
694
- getNFTAnalytics(address: string, identifier: string, chain?: Chain): Promise<NftAnalyticsResponse>;
695
- /**
696
- * Fetch multiple collections in a single request by slug.
697
- * @deprecated Use `api.collections.getCollectionsBatch()`. Removed in the next major.
698
- */
699
- getCollectionsBatch(request: BatchCollectionsRequest): Promise<CollectionBatchResponse>;
700
- /**
701
- * Fetch top offers for a collection grouped by price level.
702
- * @deprecated Use `api.collections.getCollectionOfferAggregates()`. Removed in the next major.
703
- */
704
- getCollectionOfferAggregates(slug: string, args?: PaginatedAnalyticsArgs): Promise<CollectionOfferAggregatesPaginatedResponse>;
705
- /**
706
- * Fetch holders of a collection.
707
- * @deprecated Use `api.collections.getCollectionHolders()`. Removed in the next major.
708
- */
709
- getCollectionHolders(slug: string, args?: CollectionHoldersArgs): Promise<CollectionHoldersPaginatedResponse>;
710
- /**
711
- * Fetch the floor-price history of a collection.
712
- * @deprecated Use `api.collections.getCollectionFloorPrices()`. Removed in the next major.
713
- */
714
- getCollectionFloorPrices(slug: string, args?: CollectionFloorPricesArgs): Promise<FloorPriceHistoryResponse>;
715
- /**
716
- * Get ordered approval + sign actions to create one or more listings.
717
- * @deprecated Use `api.listings.createListingActions()`. Removed in the next major.
718
- */
719
- createListingActions(request: CreateListingActionsRequest): Promise<CreateListingActionsResponse>;
720
- /**
721
- * Get ordered actions to fulfill a listing.
722
- * @deprecated Use `api.listings.createListingFulfillmentActions()`. Removed in the next major.
723
- */
724
- createListingFulfillmentActions(request: CreateListingFulfillmentActionsRequest): Promise<CreateListingFulfillmentActionsResponse>;
725
- /**
726
- * Get ordered actions to create an offer.
727
- * @deprecated Use `api.offers.createOfferActions()`. Removed in the next major.
728
- */
729
- createOfferActions(request: CreateOfferActionsRequest): Promise<CreateOfferActionsResponse>;
730
- /**
731
- * Get ordered actions to fulfill an offer.
732
- * @deprecated Use `api.offers.createOfferFulfillmentActions()`. Removed in the next major.
733
- */
734
- createOfferFulfillmentActions(request: CreateOfferFulfillmentActionsRequest): Promise<CreateOfferFulfillmentActionsResponse>;
735
- /**
736
- * Build a deploy-contract transaction for a new drop.
737
- * @deprecated Use `api.drops.deployDropContract()`. Removed in the next major.
738
- */
739
- deployDropContract(request: DropDeployRequest): Promise<DropDeployResponse>;
740
- /**
741
- * Get the receipt of a previously submitted drop-deploy transaction.
742
- * @deprecated Use `api.drops.getDeployReceipt()`. Removed in the next major.
743
- */
744
- getDeployContractReceipt(chain: Chain, txHash: string): Promise<DropDeployReceiptResponse>;
745
- /**
746
- * Build transactions to transfer NFTs or tokens between wallets.
747
- * @deprecated Use `api.assets.transferAssets()`. Removed in the next major.
748
- */
749
- transferAssets(request: TransferRequest): Promise<TransferResponse>;
750
- /**
751
- * Get portfolio stats (net worth, P&L) for an account.
752
- * @deprecated Use `api.accounts.getPortfolioStats()`. Removed in the next major.
753
- */
754
- getPortfolioStats(address: string, args?: PortfolioArgs): Promise<PortfolioStatsResponse>;
755
- /**
756
- * Get portfolio net-worth history for an account.
757
- * @deprecated Use `api.accounts.getPortfolioHistory()`. Removed in the next major.
758
- */
759
- getPortfolioHistory(address: string, args?: PortfolioArgs): Promise<PortfolioHistoryResponse>;
760
- /**
761
- * Get offers received by an account.
762
- * @deprecated Use `api.accounts.getProfileOffersReceived()`. Removed in the next major.
763
- */
764
- getProfileOffersReceived(address: string, args?: ProfileOrdersArgs): Promise<ProfileOffersResponse>;
765
- /**
766
- * Get active offers made by an account.
767
- * @deprecated Use `api.accounts.getProfileOffers()`. Removed in the next major.
768
- */
769
- getProfileOffers(address: string, args?: ProfileOrdersArgs): Promise<ProfileOffersResponse>;
770
- /**
771
- * Get active listings for an account.
772
- * @deprecated Use `api.accounts.getProfileListings()`. Removed in the next major.
773
- */
774
- getProfileListings(address: string, args?: ProfileOrdersArgs): Promise<ProfileListingsResponse>;
775
- /**
776
- * Get items favorited by an account.
777
- * @deprecated Use `api.accounts.getProfileFavorites()`. Removed in the next major.
778
- */
779
- getProfileFavorites(address: string, args?: ProfileFavoritesArgs): Promise<ProfileFavoritesResponse>;
780
- /**
781
- * Get collections owned by an account.
782
- * @deprecated Use `api.accounts.getProfileCollections()`. Removed in the next major.
783
- */
784
- getProfileCollections(address: string, args?: ProfileCollectionsArgs): Promise<ProfileCollectionsResponse>;
785
- /**
786
- * Get aggregated trading P&L (realized + unrealized) for an account.
787
- * @deprecated Use `api.accounts.getWalletPnl()`. Removed in the next major.
788
- */
789
- getWalletPnl(address: string): Promise<WalletPnlResponse>;
790
- /**
791
- * Get closed (realized) trading positions for an account.
792
- * @deprecated Use `api.accounts.getWalletClosedPositions()`. Removed in the next major.
793
- */
794
- getWalletClosedPositions(address: string, args?: WalletClosedPositionsArgs): Promise<ClosedPositionsResponse>;
795
- /**
796
- * Get the token transfers contributing to a wallet's position in a currency.
797
- * @deprecated Use `api.accounts.getWalletTokenTransfers()`. Removed in the next major.
798
- */
799
- getWalletTokenTransfers(address: string, args: WalletTokenTransfersArgs): Promise<PositionTokenTransfersResponse>;
800
96
  /**
801
97
  * Generic fetch method for any API endpoint with automatic rate limit retry,
802
98
  * with the response left in its wire shape.
@@ -896,7 +192,7 @@ export declare class OpenSeaAPI {
896
192
  */
897
193
  private static readonly MAX_RETRY_AFTER_SECONDS;
898
194
  /**
899
- * Parses the retry-after header from the response with robust error handling.
195
+ * Parses the retry-after header, tolerating missing or malformed values.
900
196
  * @param response The HTTP response object from the API
901
197
  * @returns The retry-after value in seconds (capped at 5 minutes), or undefined if not present or invalid
902
198
  */
@@ -914,8 +210,8 @@ export declare class OpenSeaAPI {
914
210
  /**
915
211
  * Creates a rate limit error with status code and retry-after information.
916
212
  * This is async because it attempts to parse the response body. If the body
917
- * is malformed JSON, responseBody will be undefined (intentional — the error
918
- * itself is more important than the body).
213
+ * is malformed JSON, responseBody is undefined (on purpose: the error
214
+ * matters more than the body).
919
215
  * @param response The HTTP response object from the API
920
216
  * @returns An enhanced Error object with statusCode, retryAfter and responseBody properties
921
217
  */