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