@opensea/sdk 12.2.0 → 12.4.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.
- package/README.md +23 -8
- package/lib/api/api.d.ts +136 -14
- package/lib/api/api.js +233 -114
- package/lib/api/api.js.map +1 -1
- package/lib/api/events.d.ts +0 -3
- package/lib/api/events.js +18 -1
- package/lib/api/events.js.map +1 -1
- package/lib/api/tokens.js +23 -2
- package/lib/api/tokens.js.map +1 -1
- package/lib/api/types.d.ts +30 -5
- package/lib/api/types.js.map +1 -1
- package/lib/types.d.ts +39 -0
- package/lib/types.js.map +1 -1
- package/package.json +2 -2
- package/src/api/api.ts +238 -119
- package/src/api/events.ts +19 -1
- package/src/api/tokens.ts +24 -2
- package/src/api/types.ts +30 -4
- package/src/types.ts +39 -0
package/lib/api/api.d.ts
CHANGED
|
@@ -1,8 +1,20 @@
|
|
|
1
1
|
import type { FulfillmentDataResponse, ProtocolData } from "../orders/types";
|
|
2
2
|
import { Chain, type OpenSeaAccount, type OpenSeaAPIConfig, type OpenSeaCollection, type OpenSeaCollectionStats, type OpenSeaPaymentToken, type OrderSide, type RequestOptions } from "../types";
|
|
3
3
|
import { type Camelize } from "../utils/case";
|
|
4
|
+
import { AccountsAPI } from "./accounts";
|
|
5
|
+
import { AssetsAPI } from "./assets";
|
|
6
|
+
import { ChainsAPI } from "./chains";
|
|
7
|
+
import { CollectionsAPI } from "./collections";
|
|
8
|
+
import { DropsAPI } from "./drops";
|
|
9
|
+
import { EventsAPI } from "./events";
|
|
4
10
|
import type { HttpMethod, PostOptions } from "./fetcher";
|
|
5
|
-
import {
|
|
11
|
+
import { ListingsAPI } from "./listings";
|
|
12
|
+
import { NFTsAPI } from "./nfts";
|
|
13
|
+
import { OffersAPI } from "./offers";
|
|
14
|
+
import { OrdersAPI } from "./orders";
|
|
15
|
+
import { TokensAPI } from "./tokens";
|
|
16
|
+
import { TransactionsAPI } from "./transactions";
|
|
17
|
+
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 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 TransactionReceiptRequest, type TransactionReceiptResponse, type TransferRequest, type TransferResponse, type ValidateMetadataResponse, type WalletClosedPositionsArgs, type WalletPnlResponse, type WalletTokenTransfersArgs } from "./types";
|
|
6
18
|
import { WalletAuthAPI } from "./walletAuth";
|
|
7
19
|
/**
|
|
8
20
|
* The API class for the OpenSea SDK.
|
|
@@ -23,22 +35,33 @@ export declare class OpenSeaAPI {
|
|
|
23
35
|
logger: (arg: string) => void;
|
|
24
36
|
private apiKey;
|
|
25
37
|
private authToken;
|
|
38
|
+
/** Transport for every instance request. See {@link OpenSeaAPIConfig.fetch}. */
|
|
39
|
+
private readonly fetchImpl;
|
|
26
40
|
private chain;
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
41
|
+
/**
|
|
42
|
+
* Per-domain clients. Prefer these over the flat `getCollection` / `getTraits` style methods on
|
|
43
|
+
* this class, which are deprecated and will be removed in the next major.
|
|
44
|
+
*
|
|
45
|
+
* `search` is absent because `SearchAPI` holds a single method also called `search`, so the
|
|
46
|
+
* property and the existing `search()` method want the same name and only one can be added
|
|
47
|
+
* without a break. Call it as `api.search(args)`.
|
|
48
|
+
*/
|
|
49
|
+
readonly orders: OrdersAPI;
|
|
50
|
+
readonly offers: OffersAPI;
|
|
51
|
+
readonly listings: ListingsAPI;
|
|
52
|
+
readonly collections: CollectionsAPI;
|
|
53
|
+
readonly nfts: NFTsAPI;
|
|
54
|
+
readonly accounts: AccountsAPI;
|
|
55
|
+
readonly events: EventsAPI;
|
|
56
|
+
readonly tokens: TokensAPI;
|
|
57
|
+
readonly chains: ChainsAPI;
|
|
58
|
+
readonly drops: DropsAPI;
|
|
59
|
+
readonly transactions: TransactionsAPI;
|
|
60
|
+
readonly assets: AssetsAPI;
|
|
40
61
|
/** Wallet-authenticated scoped REST helpers. */
|
|
41
62
|
readonly walletAuth: WalletAuthAPI;
|
|
63
|
+
/** See the note above: this one stays private, and `api.search(args)` is the call. */
|
|
64
|
+
private searchAPI;
|
|
42
65
|
/**
|
|
43
66
|
* Create an instance of the OpenSeaAPI
|
|
44
67
|
* @param config OpenSeaAPIConfig for setting up the API, including an optional API key, Chain name, and base URL
|
|
@@ -52,6 +75,7 @@ export declare class OpenSeaAPI {
|
|
|
52
75
|
* @param chain The chain where the order is located. Defaults to the chain set in the constructor.
|
|
53
76
|
* @returns The {@link GetOrderByHashResponse} returned by the API (can be Offer or Listing)
|
|
54
77
|
* @throws An error if the order is not found
|
|
78
|
+
* @deprecated Use `api.orders.getOrderByHash()`. Removed in the next major.
|
|
55
79
|
*/
|
|
56
80
|
getOrderByHash(orderHash: string, protocolAddress: string, chain?: Chain): Promise<GetOrderByHashResponse>;
|
|
57
81
|
/**
|
|
@@ -60,6 +84,7 @@ export declare class OpenSeaAPI {
|
|
|
60
84
|
* @param limit The number of offers to return. Must be between 1 and 100. Default: 100
|
|
61
85
|
* @param next The cursor for the next page of results. This is returned from a previous request.
|
|
62
86
|
* @returns The {@link GetOffersResponse} returned by the API.
|
|
87
|
+
* @deprecated Use `api.offers.getAllOffers()`. Removed in the next major.
|
|
63
88
|
*/
|
|
64
89
|
getAllOffers(collectionSlug: string, limit?: number, next?: string): Promise<GetOffersResponse>;
|
|
65
90
|
/**
|
|
@@ -69,6 +94,7 @@ export declare class OpenSeaAPI {
|
|
|
69
94
|
* @param next The cursor for the next page of results. This is returned from a previous request.
|
|
70
95
|
* @param includePrivateListings Whether to include private listings (default: false)
|
|
71
96
|
* @returns The {@link GetListingsResponse} returned by the API.
|
|
97
|
+
* @deprecated Use `api.listings.getAllListings()`. Removed in the next major.
|
|
72
98
|
*/
|
|
73
99
|
getAllListings(collectionSlug: string, limit?: number, next?: string, includePrivateListings?: boolean): Promise<GetListingsResponse>;
|
|
74
100
|
/**
|
|
@@ -81,6 +107,7 @@ export declare class OpenSeaAPI {
|
|
|
81
107
|
* @param floatValue The value of the trait for decimal-based numeric traits.
|
|
82
108
|
* @param intValue The value of the trait for integer-based numeric traits.
|
|
83
109
|
* @returns The {@link GetOffersResponse} returned by the API.
|
|
110
|
+
* @deprecated Use `api.offers.getTraitOffers()`. Removed in the next major.
|
|
84
111
|
*/
|
|
85
112
|
getTraitOffers(collectionSlug: string, type: string, value: string, limit?: number, next?: string, floatValue?: number, intValue?: number): Promise<GetOffersResponse>;
|
|
86
113
|
/**
|
|
@@ -88,6 +115,7 @@ export declare class OpenSeaAPI {
|
|
|
88
115
|
* @param collectionSlug The slug of the collection.
|
|
89
116
|
* @param tokenId The token identifier.
|
|
90
117
|
* @returns The {@link GetBestOfferResponse} returned by the API.
|
|
118
|
+
* @deprecated Use `api.offers.getBestOffer()`. Removed in the next major.
|
|
91
119
|
*/
|
|
92
120
|
getBestOffer(collectionSlug: string, tokenId: string | number): Promise<GetBestOfferResponse>;
|
|
93
121
|
/**
|
|
@@ -96,6 +124,7 @@ export declare class OpenSeaAPI {
|
|
|
96
124
|
* @param tokenId The token identifier.
|
|
97
125
|
* @param includePrivateListings Whether to include private listings (default: false)
|
|
98
126
|
* @returns The {@link GetBestListingResponse} returned by the API.
|
|
127
|
+
* @deprecated Use `api.listings.getBestListing()`. Removed in the next major.
|
|
99
128
|
*/
|
|
100
129
|
getBestListing(collectionSlug: string, tokenId: string | number, includePrivateListings?: boolean): Promise<GetBestListingResponse>;
|
|
101
130
|
/**
|
|
@@ -106,6 +135,7 @@ export declare class OpenSeaAPI {
|
|
|
106
135
|
* @param includePrivateListings Whether to include private listings (default: false)
|
|
107
136
|
* @param traits Optional {@link TraitFilter} array. Returns 400 if a single trait matches more than 1000 items.
|
|
108
137
|
* @returns The {@link GetListingsResponse} returned by the API.
|
|
138
|
+
* @deprecated Use `api.listings.getBestListings()`. Removed in the next major.
|
|
109
139
|
*/
|
|
110
140
|
getBestListings(collectionSlug: string, limit?: number, next?: string, includePrivateListings?: boolean, traits?: TraitFilter[]): Promise<GetListingsResponse>;
|
|
111
141
|
/**
|
|
@@ -114,6 +144,7 @@ export declare class OpenSeaAPI {
|
|
|
114
144
|
* All listings must be EVM (Seaport orders). Payment can be from any chain (EVM or SVM).
|
|
115
145
|
* @param request The cross-chain fulfillment request containing listings, fulfiller, payment, and optional recipient
|
|
116
146
|
* @returns The {@link CrossChainFulfillmentResponse} with ordered transactions to sign and submit
|
|
147
|
+
* @deprecated Use `api.listings.getCrossChainFulfillmentData()`. Removed in the next major.
|
|
117
148
|
*/
|
|
118
149
|
getCrossChainFulfillmentData(request: CrossChainFulfillmentRequest): Promise<CrossChainFulfillmentResponse>;
|
|
119
150
|
/**
|
|
@@ -128,6 +159,7 @@ export declare class OpenSeaAPI {
|
|
|
128
159
|
* @param recipientAddress Optional recipient address for the NFT when fulfilling a listing. Not applicable for offers.
|
|
129
160
|
* @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.
|
|
130
161
|
* @returns The {@link FulfillmentDataResponse}
|
|
162
|
+
* @deprecated Use `api.orders.generateFulfillmentData()`. Removed in the next major.
|
|
131
163
|
*/
|
|
132
164
|
generateFulfillmentData(fulfillerAddress: string, orderHash: string, protocolAddress: string, side: OrderSide, assetContractAddress?: string, tokenId?: string, unitsToFill?: string, recipientAddress?: string, includeOptionalCreatorFees?: boolean): Promise<Camelize<FulfillmentDataResponse>>;
|
|
133
165
|
/**
|
|
@@ -135,6 +167,7 @@ export declare class OpenSeaAPI {
|
|
|
135
167
|
* @param order The order to post
|
|
136
168
|
* @param protocolAddress The contract address of the seaport protocol
|
|
137
169
|
* @returns The {@link Listing} posted to the API.
|
|
170
|
+
* @deprecated Use `api.orders.postListing()`. Removed in the next major.
|
|
138
171
|
*/
|
|
139
172
|
postListing(order: ProtocolData, protocolAddress: string): Promise<Listing>;
|
|
140
173
|
/**
|
|
@@ -142,6 +175,7 @@ export declare class OpenSeaAPI {
|
|
|
142
175
|
* @param order The order to post
|
|
143
176
|
* @param protocolAddress The contract address of the seaport protocol
|
|
144
177
|
* @returns The {@link Offer} posted to the API.
|
|
178
|
+
* @deprecated Use `api.orders.postOffer()`. Removed in the next major.
|
|
145
179
|
*/
|
|
146
180
|
postOffer(order: ProtocolData, protocolAddress: string): Promise<Offer>;
|
|
147
181
|
/**
|
|
@@ -155,6 +189,7 @@ export declare class OpenSeaAPI {
|
|
|
155
189
|
* @param traits If defined, an array of traits to create the multi-trait collection offer for.
|
|
156
190
|
* @param numericTraits If defined, an array of numeric trait criteria with min/max ranges.
|
|
157
191
|
* @returns The {@link BuildOfferResponse} returned by the API.
|
|
192
|
+
* @deprecated Use `api.offers.buildOffer()`. Removed in the next major.
|
|
158
193
|
*/
|
|
159
194
|
buildOffer(offererAddress: string, quantity: number, collectionSlug: string, offerProtectionEnabled?: boolean, traitType?: string, traitValue?: string, traits?: Array<{
|
|
160
195
|
type: string;
|
|
@@ -170,6 +205,7 @@ export declare class OpenSeaAPI {
|
|
|
170
205
|
* @param limit Optional limit for number of results.
|
|
171
206
|
* @param next Optional cursor for pagination.
|
|
172
207
|
* @returns The {@link GetOffersResponse} returned by the API.
|
|
208
|
+
* @deprecated Use `api.offers.getCollectionOffers()`. Removed in the next major.
|
|
173
209
|
*/
|
|
174
210
|
getCollectionOffers(slug: string, limit?: number, next?: string): Promise<GetOffersResponse>;
|
|
175
211
|
/**
|
|
@@ -181,6 +217,7 @@ export declare class OpenSeaAPI {
|
|
|
181
217
|
* @param traits If defined, an array of traits to create the multi-trait collection offer for.
|
|
182
218
|
* @param numericTraits If defined, an array of numeric trait criteria with min/max ranges.
|
|
183
219
|
* @returns The {@link Offer} returned to the API.
|
|
220
|
+
* @deprecated Use `api.offers.postCollectionOffer()`. Removed in the next major.
|
|
184
221
|
*/
|
|
185
222
|
postCollectionOffer(order: ProtocolData, slug: string, traitType?: string, traitValue?: string, traits?: Array<{
|
|
186
223
|
type: string;
|
|
@@ -197,6 +234,7 @@ export declare class OpenSeaAPI {
|
|
|
197
234
|
* @param next Cursor to retrieve the next page of NFTs
|
|
198
235
|
* @param traits Optional {@link TraitFilter} array. Returns 400 if a single trait matches more than 1000 items.
|
|
199
236
|
* @returns The {@link ListNFTsResponse} returned by the API.
|
|
237
|
+
* @deprecated Use `api.nfts.getNFTsByCollection()`. Removed in the next major.
|
|
200
238
|
*/
|
|
201
239
|
getNFTsByCollection(slug: string, limit?: number | undefined, next?: string | undefined, traits?: TraitFilter[] | undefined): Promise<ListNFTsResponse>;
|
|
202
240
|
/**
|
|
@@ -206,6 +244,7 @@ export declare class OpenSeaAPI {
|
|
|
206
244
|
* @param next Cursor to retrieve the next page of NFTs.
|
|
207
245
|
* @param chain The NFT's chain.
|
|
208
246
|
* @returns The {@link ListNFTsResponse} returned by the API.
|
|
247
|
+
* @deprecated Use `api.nfts.getNFTsByContract()`. Removed in the next major.
|
|
209
248
|
*/
|
|
210
249
|
getNFTsByContract(address: string, limit?: number | undefined, next?: string | undefined, chain?: Chain): Promise<ListNFTsResponse>;
|
|
211
250
|
/**
|
|
@@ -215,6 +254,7 @@ export declare class OpenSeaAPI {
|
|
|
215
254
|
* @param next Cursor to retrieve the next page of NFTs
|
|
216
255
|
* @param chain The chain to query. Defaults to the chain set in the constructor.
|
|
217
256
|
* @returns The {@link ListNFTsResponse} returned by the API.
|
|
257
|
+
* @deprecated Use `api.nfts.getNFTsByAccount()`. Removed in the next major.
|
|
218
258
|
*/
|
|
219
259
|
getNFTsByAccount(address: string, limit?: number | undefined, next?: string | undefined, chain?: Chain): Promise<ListNFTsResponse>;
|
|
220
260
|
/**
|
|
@@ -223,12 +263,14 @@ export declare class OpenSeaAPI {
|
|
|
223
263
|
* @param identifier the identifier of the NFT (i.e. Token ID)
|
|
224
264
|
* @param chain The NFT's chain.
|
|
225
265
|
* @returns The {@link GetNFTResponse} returned by the API.
|
|
266
|
+
* @deprecated Use `api.nfts.getNFT()`. Removed in the next major.
|
|
226
267
|
*/
|
|
227
268
|
getNFT(address: string, identifier: string, chain?: Chain): Promise<GetNFTResponse>;
|
|
228
269
|
/**
|
|
229
270
|
* Fetch an OpenSea collection.
|
|
230
271
|
* @param slug The slug (identifier) of the collection.
|
|
231
272
|
* @returns The {@link OpenSeaCollection} returned by the API.
|
|
273
|
+
* @deprecated Use `api.collections.getCollection()`. Removed in the next major.
|
|
232
274
|
*/
|
|
233
275
|
getCollection(slug: string): Promise<OpenSeaCollection>;
|
|
234
276
|
/**
|
|
@@ -240,12 +282,14 @@ export declare class OpenSeaAPI {
|
|
|
240
282
|
* @param limit The limit of collections to return.
|
|
241
283
|
* @param next The cursor for the next page of results. This is returned from a previous request.
|
|
242
284
|
* @returns List of {@link OpenSeaCollection} returned by the API.
|
|
285
|
+
* @deprecated Use `api.collections.getCollections()`. Removed in the next major.
|
|
243
286
|
*/
|
|
244
287
|
getCollections(orderBy?: CollectionOrderByOption, chain?: Chain, creatorUsername?: string, includeHidden?: boolean, limit?: number, next?: string): Promise<GetCollectionsResponse>;
|
|
245
288
|
/**
|
|
246
289
|
* Fetch stats for an OpenSea collection.
|
|
247
290
|
* @param slug The slug (identifier) of the collection.
|
|
248
291
|
* @returns The {@link OpenSeaCollection} returned by the API.
|
|
292
|
+
* @deprecated Use `api.collections.getCollectionStats()`. Removed in the next major.
|
|
249
293
|
*/
|
|
250
294
|
getCollectionStats(slug: string): Promise<OpenSeaCollectionStats>;
|
|
251
295
|
/**
|
|
@@ -253,12 +297,14 @@ export declare class OpenSeaAPI {
|
|
|
253
297
|
* @param address The address of the payment token
|
|
254
298
|
* @param chain The chain of the payment token
|
|
255
299
|
* @returns The {@link OpenSeaPaymentToken} returned by the API.
|
|
300
|
+
* @deprecated Use `api.accounts.getPaymentToken()`. Removed in the next major.
|
|
256
301
|
*/
|
|
257
302
|
getPaymentToken(address: string, chain?: Chain): Promise<OpenSeaPaymentToken>;
|
|
258
303
|
/**
|
|
259
304
|
* Fetch account for an address.
|
|
260
305
|
* @param address The address to fetch the account for
|
|
261
306
|
* @returns The {@link OpenSeaAccount} returned by the API.
|
|
307
|
+
* @deprecated Use `api.accounts.getAccount()`. Removed in the next major.
|
|
262
308
|
*/
|
|
263
309
|
getAccount(address: string): Promise<OpenSeaAccount>;
|
|
264
310
|
/**
|
|
@@ -267,6 +313,7 @@ export declare class OpenSeaAPI {
|
|
|
267
313
|
* @param identifier The identifier of the NFT.
|
|
268
314
|
* @param chain The chain where the NFT is located.
|
|
269
315
|
* @returns The response from the API.
|
|
316
|
+
* @deprecated Use `api.nfts.refreshNFTMetadata()`. Removed in the next major.
|
|
270
317
|
*/
|
|
271
318
|
refreshNFTMetadata(address: string, identifier: string, chain?: Chain): Promise<Record<string, unknown>>;
|
|
272
319
|
/**
|
|
@@ -282,16 +329,19 @@ export declare class OpenSeaAPI {
|
|
|
282
329
|
* name, version, address, and chain. The struct to sign is `OrderHash` containing a
|
|
283
330
|
* single bytes32 field.
|
|
284
331
|
* @returns The response from the API.
|
|
332
|
+
* @deprecated Use `api.orders.offchainCancelOrder()`. Removed in the next major.
|
|
285
333
|
*/
|
|
286
334
|
offchainCancelOrder(protocolAddress: string, orderHash: string, chain?: Chain, offererSignature?: string): Promise<CancelOrderResponse>;
|
|
287
335
|
/**
|
|
288
336
|
* Get ordered actions to cancel an order onchain.
|
|
337
|
+
* @deprecated Use `api.orders.createCancelOrderActions()`. Removed in the next major.
|
|
289
338
|
*/
|
|
290
339
|
createCancelOrderActions(protocolAddress: string, orderIdentifier: string, request: CreateCancelOrderActionsRequest, chain?: Chain): Promise<CreateCancelOrderActionsResponse>;
|
|
291
340
|
/**
|
|
292
341
|
* Gets a list of events based on query parameters.
|
|
293
342
|
* @param args Query parameters for filtering events.
|
|
294
343
|
* @returns The {@link GetEventsResponse} returned by the API.
|
|
344
|
+
* @deprecated Use `api.events.getEvents()`. Removed in the next major.
|
|
295
345
|
*/
|
|
296
346
|
getEvents(args?: GetEventsArgs): Promise<GetEventsResponse>;
|
|
297
347
|
/**
|
|
@@ -299,6 +349,7 @@ export declare class OpenSeaAPI {
|
|
|
299
349
|
* @param address The account address.
|
|
300
350
|
* @param args Query parameters for filtering events.
|
|
301
351
|
* @returns The {@link GetEventsResponse} returned by the API.
|
|
352
|
+
* @deprecated Use `api.events.getEventsByAccount()`. Removed in the next major.
|
|
302
353
|
*/
|
|
303
354
|
getEventsByAccount(address: string, args?: GetEventsArgs): Promise<GetEventsResponse>;
|
|
304
355
|
/**
|
|
@@ -307,6 +358,7 @@ export declare class OpenSeaAPI {
|
|
|
307
358
|
* @param collectionSlug The slug (identifier) of the collection.
|
|
308
359
|
* @param args Query parameters; see {@link GetEventsByCollectionArgs}.
|
|
309
360
|
* @returns The {@link GetEventsResponse} returned by the API.
|
|
361
|
+
* @deprecated Use `api.events.getEventsByCollection()`. Removed in the next major.
|
|
310
362
|
*/
|
|
311
363
|
getEventsByCollection(collectionSlug: string, args?: GetEventsByCollectionArgs): Promise<GetEventsResponse>;
|
|
312
364
|
/**
|
|
@@ -316,6 +368,7 @@ export declare class OpenSeaAPI {
|
|
|
316
368
|
* @param identifier The token identifier.
|
|
317
369
|
* @param args Query parameters for filtering events.
|
|
318
370
|
* @returns The {@link GetEventsResponse} returned by the API.
|
|
371
|
+
* @deprecated Use `api.events.getEventsByNFT()`. Removed in the next major.
|
|
319
372
|
*/
|
|
320
373
|
getEventsByNFT(chain: Chain, address: string, identifier: string, args?: GetEventsArgs): Promise<GetEventsResponse>;
|
|
321
374
|
/**
|
|
@@ -323,30 +376,47 @@ export declare class OpenSeaAPI {
|
|
|
323
376
|
* @param address The contract address.
|
|
324
377
|
* @param chain The chain where the contract is deployed. Defaults to the chain set in the constructor.
|
|
325
378
|
* @returns The {@link GetContractResponse} returned by the API.
|
|
379
|
+
* @deprecated Use `api.nfts.getContract()`. Removed in the next major.
|
|
326
380
|
*/
|
|
327
381
|
getContract(address: string, chain?: Chain): Promise<GetContractResponse>;
|
|
328
382
|
/**
|
|
329
383
|
* Fetch all traits for a collection with their possible values and counts.
|
|
330
384
|
* @param collectionSlug The slug (identifier) of the collection.
|
|
331
385
|
* @returns The {@link GetTraitsResponse} returned by the API.
|
|
386
|
+
* @deprecated Use `api.collections.getTraits()`. Removed in the next major.
|
|
332
387
|
*/
|
|
333
388
|
getTraits(collectionSlug: string): Promise<GetTraitsResponse>;
|
|
389
|
+
/**
|
|
390
|
+
* Fetch floor prices per trait value for a collection.
|
|
391
|
+
*
|
|
392
|
+
* Covers text traits with at least one active listing, ordered by trait type, then value, then
|
|
393
|
+
* price. Numeric traits are not enumerated here; use {@link getTraits} for their min/max range.
|
|
394
|
+
* Every floor is denominated on the collection's own chain, identified by `chain` plus each
|
|
395
|
+
* entry's `paymentTokenSymbol`.
|
|
396
|
+
* @param collectionSlug The slug (identifier) of the collection.
|
|
397
|
+
* @returns The {@link TraitFloorsResponse} returned by the API.
|
|
398
|
+
* @deprecated Use `api.collections.getCollectionTraitFloors()`. Removed in the next major.
|
|
399
|
+
*/
|
|
400
|
+
getCollectionTraitFloors(collectionSlug: string): Promise<TraitFloorsResponse>;
|
|
334
401
|
/**
|
|
335
402
|
* Gets a list of trending tokens.
|
|
336
403
|
* @param args Optional query parameters for pagination.
|
|
337
404
|
* @returns The {@link GetTrendingTokensResponse} returned by the API.
|
|
405
|
+
* @deprecated Use `api.tokens.getTrendingTokens()`. Removed in the next major.
|
|
338
406
|
*/
|
|
339
407
|
getTrendingTokens(args?: GetTokensArgs): Promise<GetTrendingTokensResponse>;
|
|
340
408
|
/**
|
|
341
409
|
* Gets a list of top tokens.
|
|
342
410
|
* @param args Optional query parameters for pagination.
|
|
343
411
|
* @returns The {@link GetTopTokensResponse} returned by the API.
|
|
412
|
+
* @deprecated Use `api.tokens.getTopTokens()`. Removed in the next major.
|
|
344
413
|
*/
|
|
345
414
|
getTopTokens(args?: GetTokensArgs): Promise<GetTopTokensResponse>;
|
|
346
415
|
/**
|
|
347
416
|
* Gets a swap quote for exchanging tokens.
|
|
348
417
|
* @param args Query parameters for the swap quote including token addresses, amount, and chain.
|
|
349
418
|
* @returns The {@link GetSwapQuoteResponse} returned by the API.
|
|
419
|
+
* @deprecated Use `api.tokens.getSwapQuote()`. Removed in the next major.
|
|
350
420
|
*/
|
|
351
421
|
getSwapQuote(args: GetSwapQuoteArgs): Promise<GetSwapQuoteResponse>;
|
|
352
422
|
/**
|
|
@@ -354,6 +424,7 @@ export declare class OpenSeaAPI {
|
|
|
354
424
|
* @param chain The chain the token is on.
|
|
355
425
|
* @param address The token contract address.
|
|
356
426
|
* @returns The {@link GetTokenResponse} returned by the API.
|
|
427
|
+
* @deprecated Use `api.tokens.getToken()`. Removed in the next major.
|
|
357
428
|
*/
|
|
358
429
|
getToken(chain: string, address: string): Promise<GetTokenResponse>;
|
|
359
430
|
/**
|
|
@@ -361,12 +432,14 @@ export declare class OpenSeaAPI {
|
|
|
361
432
|
* chains (e.g. ETH on Ethereum, Base, and Arbitrum share the "eth" group).
|
|
362
433
|
* @param args Optional query parameters (`limit`, `cursor`).
|
|
363
434
|
* @returns The {@link GetTokenGroupsResponse} returned by the API.
|
|
435
|
+
* @deprecated Use `api.tokens.getTokenGroups()`. Removed in the next major.
|
|
364
436
|
*/
|
|
365
437
|
getTokenGroups(args?: GetTokenGroupsArgs): Promise<GetTokenGroupsResponse>;
|
|
366
438
|
/**
|
|
367
439
|
* Gets a single token group by its slug (e.g. "eth").
|
|
368
440
|
* @param slug The token group slug.
|
|
369
441
|
* @returns The {@link GetTokenGroupResponse} returned by the API.
|
|
442
|
+
* @deprecated Use `api.tokens.getTokenGroup()`. Removed in the next major.
|
|
370
443
|
*/
|
|
371
444
|
getTokenGroup(slug: string): Promise<GetTokenGroupResponse>;
|
|
372
445
|
/**
|
|
@@ -379,6 +452,7 @@ export declare class OpenSeaAPI {
|
|
|
379
452
|
/**
|
|
380
453
|
* Gets the list of supported blockchains and their capabilities.
|
|
381
454
|
* @returns The {@link GetChainsResponse} returned by the API.
|
|
455
|
+
* @deprecated Use `api.chains.getChains()`. Removed in the next major.
|
|
382
456
|
*/
|
|
383
457
|
getChains(): Promise<GetChainsResponse>;
|
|
384
458
|
/**
|
|
@@ -386,6 +460,7 @@ export declare class OpenSeaAPI {
|
|
|
386
460
|
* @param address The wallet address to fetch token balances for.
|
|
387
461
|
* @param args Optional query parameters for filtering and pagination.
|
|
388
462
|
* @returns The {@link GetAccountTokensResponse} returned by the API.
|
|
463
|
+
* @deprecated Use `api.accounts.getAccountTokens()`. Removed in the next major.
|
|
389
464
|
*/
|
|
390
465
|
getAccountTokens(address: string, args?: GetAccountTokensArgs): Promise<GetAccountTokensResponse>;
|
|
391
466
|
/**
|
|
@@ -395,6 +470,7 @@ export declare class OpenSeaAPI {
|
|
|
395
470
|
* @param chain The chain where the NFT is located. Defaults to the chain set in the constructor.
|
|
396
471
|
* @param ignoreCachedItemUrls Whether to ignore cached item URLs and re-fetch from source.
|
|
397
472
|
* @returns The {@link ValidateMetadataResponse} returned by the API.
|
|
473
|
+
* @deprecated Use `api.nfts.validateMetadata()`. Removed in the next major.
|
|
398
474
|
*/
|
|
399
475
|
validateNFTMetadata(address: string, identifier: string, chain?: Chain, ignoreCachedItemUrls?: boolean): Promise<ValidateMetadataResponse>;
|
|
400
476
|
/**
|
|
@@ -404,6 +480,7 @@ export declare class OpenSeaAPI {
|
|
|
404
480
|
* @param limit The number of offers to return. Must be between 1 and 200.
|
|
405
481
|
* @param next The cursor for the next page of results.
|
|
406
482
|
* @returns The {@link GetOffersResponse} returned by the API.
|
|
483
|
+
* @deprecated Use `api.offers.getOffersByNFT()`. Removed in the next major.
|
|
407
484
|
*/
|
|
408
485
|
getOffersByNFT(collectionSlug: string, identifier: string | number, limit?: number, next?: string): Promise<GetOffersResponse>;
|
|
409
486
|
/**
|
|
@@ -411,6 +488,7 @@ export declare class OpenSeaAPI {
|
|
|
411
488
|
* cross-chain. Returns an ordered list of transactions to execute.
|
|
412
489
|
* @param request The sweep request containing buyer, collection, payment, and item caps.
|
|
413
490
|
* @returns The {@link SweepCollectionResponse} returned by the API.
|
|
491
|
+
* @deprecated Use `api.listings.sweepCollection()`. Removed in the next major.
|
|
414
492
|
*/
|
|
415
493
|
sweepCollection(request: SweepCollectionRequest): Promise<SweepCollectionResponse>;
|
|
416
494
|
/**
|
|
@@ -418,6 +496,7 @@ export declare class OpenSeaAPI {
|
|
|
418
496
|
* {@link OpenSeaAPI.getSwapQuote} — quote first, then execute.
|
|
419
497
|
* @param request The swap execution request.
|
|
420
498
|
* @returns The {@link SwapExecuteResponse} with transactions and a quote.
|
|
499
|
+
* @deprecated Use `api.tokens.executeSwap()`. Removed in the next major.
|
|
421
500
|
*/
|
|
422
501
|
executeSwap(request: SwapExecuteRequest): Promise<SwapExecuteResponse>;
|
|
423
502
|
/**
|
|
@@ -426,18 +505,21 @@ export declare class OpenSeaAPI {
|
|
|
426
505
|
* fulfillments, and token swaps. Poll this endpoint to check completion status.
|
|
427
506
|
* @param request The transaction receipt request.
|
|
428
507
|
* @returns The {@link TransactionReceiptResponse} returned by the API.
|
|
508
|
+
* @deprecated Use `api.transactions.getTransactionReceipt()`. Removed in the next major.
|
|
429
509
|
*/
|
|
430
510
|
getTransactionReceipt(request: TransactionReceiptRequest): Promise<TransactionReceiptResponse>;
|
|
431
511
|
/**
|
|
432
512
|
* Gets a list of drops (mints).
|
|
433
513
|
* @param args Optional query parameters for filtering and pagination.
|
|
434
514
|
* @returns The {@link GetDropsResponse} returned by the API.
|
|
515
|
+
* @deprecated Use `api.drops.getDrops()`. Removed in the next major.
|
|
435
516
|
*/
|
|
436
517
|
getDrops(args?: GetDropsArgs): Promise<GetDropsResponse>;
|
|
437
518
|
/**
|
|
438
519
|
* Gets detailed drop information for a collection.
|
|
439
520
|
* @param slug The collection slug identifying the drop.
|
|
440
521
|
* @returns The {@link GetDropResponse} returned by the API.
|
|
522
|
+
* @deprecated Use `api.drops.getDrop()`. Removed in the next major.
|
|
441
523
|
*/
|
|
442
524
|
getDrop(slug: string): Promise<GetDropResponse>;
|
|
443
525
|
/**
|
|
@@ -445,6 +527,7 @@ export declare class OpenSeaAPI {
|
|
|
445
527
|
* @param slug The collection slug identifying the drop.
|
|
446
528
|
* @param request The mint request containing minter address and quantity.
|
|
447
529
|
* @returns The {@link DropMintResponse} with ready-to-sign transaction data.
|
|
530
|
+
* @deprecated Use `api.drops.buildMintTransaction()`. Removed in the next major.
|
|
448
531
|
*/
|
|
449
532
|
buildDropMintTransaction(slug: string, request: DropMintRequest): Promise<DropMintResponse>;
|
|
450
533
|
/**
|
|
@@ -455,24 +538,28 @@ export declare class OpenSeaAPI {
|
|
|
455
538
|
* @param slug The collection slug identifying the drop.
|
|
456
539
|
* @param request The payer, minter, quantity, and source payment asset.
|
|
457
540
|
* @returns Transactions to submit and the request used to poll their receipt.
|
|
541
|
+
* @deprecated Use `api.drops.buildCrossChainMintTransactions()`. Removed in the next major.
|
|
458
542
|
*/
|
|
459
543
|
buildCrossChainDropMintTransactions(slug: string, request: CrossChainDropMintRequest): Promise<CrossChainDropMintResponse>;
|
|
460
544
|
/**
|
|
461
545
|
* Gets trending collections sorted by sales activity.
|
|
462
546
|
* @param args Optional query parameters for timeframe, chain, category, and pagination.
|
|
463
547
|
* @returns The {@link GetCollectionsPaginatedResponse} returned by the API.
|
|
548
|
+
* @deprecated Use `api.collections.getTrendingCollections()`. Removed in the next major.
|
|
464
549
|
*/
|
|
465
550
|
getTrendingCollections(args?: GetTrendingCollectionsArgs): Promise<GetCollectionsPaginatedResponse>;
|
|
466
551
|
/**
|
|
467
552
|
* Gets top collections ranked by various stats.
|
|
468
553
|
* @param args Optional query parameters for sort_by, chain, category, and pagination.
|
|
469
554
|
* @returns The {@link GetCollectionsPaginatedResponse} returned by the API.
|
|
555
|
+
* @deprecated Use `api.collections.getTopCollections()`. Removed in the next major.
|
|
470
556
|
*/
|
|
471
557
|
getTopCollections(args?: GetTopCollectionsArgs): Promise<GetCollectionsPaginatedResponse>;
|
|
472
558
|
/**
|
|
473
559
|
* Resolve an ENS name, OpenSea username, or wallet address to canonical account info.
|
|
474
560
|
* @param identifier An ENS name (e.g. vitalik.eth), OpenSea username, or wallet address.
|
|
475
561
|
* @returns The {@link ResolveAccountResponse} returned by the API.
|
|
562
|
+
* @deprecated Use `api.accounts.resolveAccount()`. Removed in the next major.
|
|
476
563
|
*/
|
|
477
564
|
resolveAccount(identifier: string): Promise<ResolveAccountResponse>;
|
|
478
565
|
/**
|
|
@@ -480,6 +567,7 @@ export declare class OpenSeaAPI {
|
|
|
480
567
|
* This is a public read and does not require wallet authentication.
|
|
481
568
|
* @param addressOrUsername An ENS name, OpenSea username, or wallet address.
|
|
482
569
|
* @returns The {@link AgentProfileRelationshipsResponse} returned by the API.
|
|
570
|
+
* @deprecated Use `api.accounts.getAgentProfileRelationships()`. Removed in the next major.
|
|
483
571
|
*/
|
|
484
572
|
getAgentProfileRelationships(addressOrUsername: string): Promise<AgentProfileRelationshipsResponse>;
|
|
485
573
|
/**
|
|
@@ -490,6 +578,7 @@ export declare class OpenSeaAPI {
|
|
|
490
578
|
* @param identifier The token identifier.
|
|
491
579
|
* @param chain The chain where the NFT is located. Defaults to the chain set in the constructor.
|
|
492
580
|
* @returns The {@link OpenSeaCollection} returned by the API.
|
|
581
|
+
* @deprecated Use `api.nfts.getNFTCollection()`. Removed in the next major.
|
|
493
582
|
*/
|
|
494
583
|
getNFTCollection(address: string, identifier: string, chain?: Chain): Promise<OpenSeaCollection>;
|
|
495
584
|
/**
|
|
@@ -499,12 +588,14 @@ export declare class OpenSeaAPI {
|
|
|
499
588
|
* @param tokenId The token identifier.
|
|
500
589
|
* @param chain The chain where the NFT is located. Defaults to the chain set in the constructor.
|
|
501
590
|
* @returns The {@link GetNFTMetadataResponse} returned by the API.
|
|
591
|
+
* @deprecated Use `api.nfts.getNFTMetadata()`. Removed in the next major.
|
|
502
592
|
*/
|
|
503
593
|
getNFTMetadata(address: string, tokenId: string, chain?: Chain): Promise<GetNFTMetadataResponse>;
|
|
504
594
|
/**
|
|
505
595
|
* Fetch multiple tokens in a single request.
|
|
506
596
|
* @param request Batch request listing chain + contract address pairs.
|
|
507
597
|
* @returns The {@link TokenBatchResponse} with detailed token info.
|
|
598
|
+
* @deprecated Use `api.tokens.getTokensBatch()`. Removed in the next major.
|
|
508
599
|
*/
|
|
509
600
|
getTokensBatch(request: BatchTokensRequest): Promise<TokenBatchResponse>;
|
|
510
601
|
/**
|
|
@@ -513,6 +604,7 @@ export declare class OpenSeaAPI {
|
|
|
513
604
|
* @param address Token contract address.
|
|
514
605
|
* @param args Time-series window — `start_time` required, `end_time` defaults to now.
|
|
515
606
|
* @returns The {@link PriceHistoryResponse} returned by the API.
|
|
607
|
+
* @deprecated Use `api.tokens.getTokenPriceHistory()`. Removed in the next major.
|
|
516
608
|
*/
|
|
517
609
|
getTokenPriceHistory(chain: Chain, address: string, args: TokenTimeSeriesArgs): Promise<PriceHistoryResponse>;
|
|
518
610
|
/**
|
|
@@ -521,128 +613,158 @@ export declare class OpenSeaAPI {
|
|
|
521
613
|
* @param address Token contract address.
|
|
522
614
|
* @param args Time-series window plus candle `bucketSize` (required).
|
|
523
615
|
* @returns The {@link OhlcvResponse} returned by the API.
|
|
616
|
+
* @deprecated Use `api.tokens.getTokenOhlcv()`. Removed in the next major.
|
|
524
617
|
*/
|
|
525
618
|
getTokenOhlcv(chain: Chain, address: string, args: TokenTimeSeriesArgs & {
|
|
526
619
|
bucketSize: string;
|
|
527
620
|
}): Promise<OhlcvResponse>;
|
|
528
621
|
/**
|
|
529
622
|
* Fetch recent swap activity for a token.
|
|
623
|
+
* @deprecated Use `api.tokens.getTokenActivity()`. Removed in the next major.
|
|
530
624
|
*/
|
|
531
625
|
getTokenActivity(chain: Chain, address: string, args?: TokenActivityArgs): Promise<TokenSwapActivityPaginatedResponse>;
|
|
532
626
|
/**
|
|
533
627
|
* Fetch materialized trade count, USD volume, and average trade size for a
|
|
534
628
|
* token across the requested windows.
|
|
629
|
+
* @deprecated Use `api.tokens.getTokenActivityStats()`. Removed in the next major.
|
|
535
630
|
*/
|
|
536
631
|
getTokenActivityStats(chain: Chain, address: string, args?: TokenActivityStatsArgs): Promise<TokenActivityStatsResponse>;
|
|
537
632
|
/**
|
|
538
633
|
* Fetch paginated fungible token activity (transfers, swaps, wraps, and
|
|
539
634
|
* unwraps) for an account across all chains.
|
|
635
|
+
* @deprecated Use `api.tokens.getAccountTokenActivity()`. Removed in the next major.
|
|
540
636
|
*/
|
|
541
637
|
getAccountTokenActivity(address: string, args?: GetAccountTokenActivityArgs): Promise<GetAccountTokenActivityResponse>;
|
|
542
638
|
/**
|
|
543
639
|
* Fetch paginated holders for a token, including quantity held, USD value,
|
|
544
640
|
* and aggregate distribution health (STRONG | HEALTHY | CONCERNING | BAD).
|
|
641
|
+
* @deprecated Use `api.tokens.getTokenHolders()`. Removed in the next major.
|
|
545
642
|
*/
|
|
546
643
|
getTokenHolders(chain: Chain, address: string, args?: TokenHoldersArgs): Promise<TokenHoldersResponse>;
|
|
547
644
|
/**
|
|
548
645
|
* Fetch liquidity pools for a token (pool type, USD reserves, and
|
|
549
646
|
* bonding-curve progress / graduation flag where applicable).
|
|
647
|
+
* @deprecated Use `api.tokens.getTokenLiquidityPools()`. Removed in the next major.
|
|
550
648
|
*/
|
|
551
649
|
getTokenLiquidityPools(chain: Chain, address: string, args?: TokenLiquidityPoolsArgs): Promise<TokenLiquidityPoolsResponse>;
|
|
552
650
|
/**
|
|
553
651
|
* Fetch multiple NFTs in a single request.
|
|
652
|
+
* @deprecated Use `api.nfts.getNFTsBatch()`. Removed in the next major.
|
|
554
653
|
*/
|
|
555
654
|
getNFTsBatch(request: BatchNftsRequest): Promise<NftBatchResponse>;
|
|
556
655
|
/**
|
|
557
656
|
* Fetch owners of an NFT.
|
|
657
|
+
* @deprecated Use `api.nfts.getNFTOwners()`. Removed in the next major.
|
|
558
658
|
*/
|
|
559
659
|
getNFTOwners(address: string, identifier: string, chain?: Chain, args?: NFTOwnersArgs): Promise<OwnersPaginatedResponse>;
|
|
560
660
|
/**
|
|
561
661
|
* Fetch analytics (historical sale points) for an NFT.
|
|
662
|
+
* @deprecated Use `api.nfts.getNFTAnalytics()`. Removed in the next major.
|
|
562
663
|
*/
|
|
563
664
|
getNFTAnalytics(address: string, identifier: string, chain?: Chain): Promise<NftAnalyticsResponse>;
|
|
564
665
|
/**
|
|
565
666
|
* Fetch multiple collections in a single request by slug.
|
|
667
|
+
* @deprecated Use `api.collections.getCollectionsBatch()`. Removed in the next major.
|
|
566
668
|
*/
|
|
567
669
|
getCollectionsBatch(request: BatchCollectionsRequest): Promise<CollectionBatchResponse>;
|
|
568
670
|
/**
|
|
569
671
|
* Fetch top offers for a collection grouped by price level.
|
|
672
|
+
* @deprecated Use `api.collections.getCollectionOfferAggregates()`. Removed in the next major.
|
|
570
673
|
*/
|
|
571
674
|
getCollectionOfferAggregates(slug: string, args?: PaginatedAnalyticsArgs): Promise<CollectionOfferAggregatesPaginatedResponse>;
|
|
572
675
|
/**
|
|
573
676
|
* Fetch holders of a collection.
|
|
677
|
+
* @deprecated Use `api.collections.getCollectionHolders()`. Removed in the next major.
|
|
574
678
|
*/
|
|
575
679
|
getCollectionHolders(slug: string, args?: CollectionHoldersArgs): Promise<CollectionHoldersPaginatedResponse>;
|
|
576
680
|
/**
|
|
577
681
|
* Fetch the floor-price history of a collection.
|
|
682
|
+
* @deprecated Use `api.collections.getCollectionFloorPrices()`. Removed in the next major.
|
|
578
683
|
*/
|
|
579
684
|
getCollectionFloorPrices(slug: string, args?: CollectionFloorPricesArgs): Promise<FloorPriceHistoryResponse>;
|
|
580
685
|
/**
|
|
581
686
|
* Get ordered approval + sign actions to create one or more listings.
|
|
687
|
+
* @deprecated Use `api.listings.createListingActions()`. Removed in the next major.
|
|
582
688
|
*/
|
|
583
689
|
createListingActions(request: CreateListingActionsRequest): Promise<CreateListingActionsResponse>;
|
|
584
690
|
/**
|
|
585
691
|
* Get ordered actions to fulfill a listing.
|
|
692
|
+
* @deprecated Use `api.listings.createListingFulfillmentActions()`. Removed in the next major.
|
|
586
693
|
*/
|
|
587
694
|
createListingFulfillmentActions(request: CreateListingFulfillmentActionsRequest): Promise<CreateListingFulfillmentActionsResponse>;
|
|
588
695
|
/**
|
|
589
696
|
* Get ordered actions to create an offer.
|
|
697
|
+
* @deprecated Use `api.offers.createOfferActions()`. Removed in the next major.
|
|
590
698
|
*/
|
|
591
699
|
createOfferActions(request: CreateOfferActionsRequest): Promise<CreateOfferActionsResponse>;
|
|
592
700
|
/**
|
|
593
701
|
* Get ordered actions to fulfill an offer.
|
|
702
|
+
* @deprecated Use `api.offers.createOfferFulfillmentActions()`. Removed in the next major.
|
|
594
703
|
*/
|
|
595
704
|
createOfferFulfillmentActions(request: CreateOfferFulfillmentActionsRequest): Promise<CreateOfferFulfillmentActionsResponse>;
|
|
596
705
|
/**
|
|
597
706
|
* Build a deploy-contract transaction for a new drop.
|
|
707
|
+
* @deprecated Use `api.drops.deployDropContract()`. Removed in the next major.
|
|
598
708
|
*/
|
|
599
709
|
deployDropContract(request: DropDeployRequest): Promise<DropDeployResponse>;
|
|
600
710
|
/**
|
|
601
711
|
* Get the receipt of a previously submitted drop-deploy transaction.
|
|
712
|
+
* @deprecated Use `api.drops.getDeployReceipt()`. Removed in the next major.
|
|
602
713
|
*/
|
|
603
714
|
getDeployContractReceipt(chain: Chain, txHash: string): Promise<DropDeployReceiptResponse>;
|
|
604
715
|
/**
|
|
605
716
|
* Build transactions to transfer NFTs or tokens between wallets.
|
|
717
|
+
* @deprecated Use `api.assets.transferAssets()`. Removed in the next major.
|
|
606
718
|
*/
|
|
607
719
|
transferAssets(request: TransferRequest): Promise<TransferResponse>;
|
|
608
720
|
/**
|
|
609
721
|
* Get portfolio stats (net worth, P&L) for an account.
|
|
722
|
+
* @deprecated Use `api.accounts.getPortfolioStats()`. Removed in the next major.
|
|
610
723
|
*/
|
|
611
724
|
getPortfolioStats(address: string, args?: PortfolioArgs): Promise<PortfolioStatsResponse>;
|
|
612
725
|
/**
|
|
613
726
|
* Get portfolio net-worth history for an account.
|
|
727
|
+
* @deprecated Use `api.accounts.getPortfolioHistory()`. Removed in the next major.
|
|
614
728
|
*/
|
|
615
729
|
getPortfolioHistory(address: string, args?: PortfolioArgs): Promise<PortfolioHistoryResponse>;
|
|
616
730
|
/**
|
|
617
731
|
* Get offers received by an account.
|
|
732
|
+
* @deprecated Use `api.accounts.getProfileOffersReceived()`. Removed in the next major.
|
|
618
733
|
*/
|
|
619
734
|
getProfileOffersReceived(address: string, args?: ProfileOrdersArgs): Promise<ProfileOffersResponse>;
|
|
620
735
|
/**
|
|
621
736
|
* Get active offers made by an account.
|
|
737
|
+
* @deprecated Use `api.accounts.getProfileOffers()`. Removed in the next major.
|
|
622
738
|
*/
|
|
623
739
|
getProfileOffers(address: string, args?: ProfileOrdersArgs): Promise<ProfileOffersResponse>;
|
|
624
740
|
/**
|
|
625
741
|
* Get active listings for an account.
|
|
742
|
+
* @deprecated Use `api.accounts.getProfileListings()`. Removed in the next major.
|
|
626
743
|
*/
|
|
627
744
|
getProfileListings(address: string, args?: ProfileOrdersArgs): Promise<ProfileListingsResponse>;
|
|
628
745
|
/**
|
|
629
746
|
* Get items favorited by an account.
|
|
747
|
+
* @deprecated Use `api.accounts.getProfileFavorites()`. Removed in the next major.
|
|
630
748
|
*/
|
|
631
749
|
getProfileFavorites(address: string, args?: ProfileFavoritesArgs): Promise<ProfileFavoritesResponse>;
|
|
632
750
|
/**
|
|
633
751
|
* Get collections owned by an account.
|
|
752
|
+
* @deprecated Use `api.accounts.getProfileCollections()`. Removed in the next major.
|
|
634
753
|
*/
|
|
635
754
|
getProfileCollections(address: string, args?: ProfileCollectionsArgs): Promise<ProfileCollectionsResponse>;
|
|
636
755
|
/**
|
|
637
756
|
* Get aggregated trading P&L (realized + unrealized) for an account.
|
|
757
|
+
* @deprecated Use `api.accounts.getWalletPnl()`. Removed in the next major.
|
|
638
758
|
*/
|
|
639
759
|
getWalletPnl(address: string): Promise<WalletPnlResponse>;
|
|
640
760
|
/**
|
|
641
761
|
* Get closed (realized) trading positions for an account.
|
|
762
|
+
* @deprecated Use `api.accounts.getWalletClosedPositions()`. Removed in the next major.
|
|
642
763
|
*/
|
|
643
764
|
getWalletClosedPositions(address: string, args?: WalletClosedPositionsArgs): Promise<ClosedPositionsResponse>;
|
|
644
765
|
/**
|
|
645
766
|
* Get the token transfers contributing to a wallet's position in a currency.
|
|
767
|
+
* @deprecated Use `api.accounts.getWalletTokenTransfers()`. Removed in the next major.
|
|
646
768
|
*/
|
|
647
769
|
getWalletTokenTransfers(address: string, args: WalletTokenTransfersArgs): Promise<PositionTokenTransfersResponse>;
|
|
648
770
|
/**
|