@opensea/sdk 14.1.0 → 14.3.0
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 +8 -0
- package/lib/api/accounts.d.ts +2 -2
- package/lib/api/accounts.js +2 -2
- package/lib/api/accounts.js.map +1 -1
- package/lib/api/collections.d.ts +3 -3
- package/lib/api/collections.js +2 -2
- package/lib/api/collections.js.map +1 -1
- package/lib/api/nfts.d.ts +2 -2
- package/lib/api/nfts.js +8 -2
- package/lib/api/nfts.js.map +1 -1
- package/lib/api/types.d.ts +10 -0
- package/lib/scopes.d.ts +1 -0
- package/lib/scopes.js +1 -0
- package/lib/scopes.js.map +1 -1
- package/lib/sdk/base.d.ts +13 -0
- package/package.json +2 -2
- package/src/api/accounts.ts +6 -1
- package/src/api/collections.ts +8 -4
- package/src/api/nfts.ts +9 -1
- package/src/api/types.ts +31 -0
- package/src/scopes.ts +1 -0
package/README.md
CHANGED
|
@@ -106,6 +106,14 @@ Version 14 removed the older flat methods such as `sdk.api.getCollection(slug)`.
|
|
|
106
106
|
the namespaced method of the same name, except four that were renamed; see the
|
|
107
107
|
[API reference](developerDocs/api-reference.md#calling-the-api).
|
|
108
108
|
|
|
109
|
+
### Optional discovery data
|
|
110
|
+
|
|
111
|
+
Existing methods accept opt-in data without changing their defaults. `api.collections.getCollectionStats(slug, { volumeTimeframe: "seven_days" })` adds volume history; `api.collections.getCollectionOfferAggregates(slug, { includeDepth: true })` adds capped two-sided depth. `api.nfts.getNFTsByGroup(group, { includeCatalog: true })` requests optional catalog identities. The response omits them before unrestricted public launch or when no identity is available; this option does not bypass lab gating. `api.accounts.getAccount(address, { include: ["wallets"] })` expands public registered wallets.
|
|
112
|
+
|
|
113
|
+
Volume history is oldest first. Each bucket has a numeric Unix-seconds `time`, decimal-string `usd`, and `native` currency amount. Missing buckets are omitted, and the current bucket can be incomplete.
|
|
114
|
+
|
|
115
|
+
`api.nfts.getNFTsByCollection` keeps its first five positional arguments and accepts listing, price, rarity, numeric-trait and ordering filters as a sixth argument. See [the collection NFT parameters](developerDocs/api-reference.md#get-nfts-by-collection). Keep filters and ordering unchanged across cursor pages.
|
|
116
|
+
|
|
109
117
|
## Response casing
|
|
110
118
|
|
|
111
119
|
The API uses snake_case. The SDK converts response keys to camelCase, and converts camelCase
|
package/lib/api/accounts.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Chain, OpenSeaAccount, OpenSeaPaymentToken } from "../types";
|
|
2
2
|
import type { Fetcher } from "./fetcher";
|
|
3
|
-
import type { AgentProfileRelationshipsResponse, ClosedPositionsResponse, GetAccountTokensArgs, GetAccountTokensResponse, PortfolioArgs, PortfolioHistoryResponse, PortfolioStatsResponse, PositionTokenTransfersResponse, ProfileCollectionsArgs, ProfileCollectionsResponse, ProfileFavoritesArgs, ProfileFavoritesResponse, ProfileListingsResponse, ProfileOffersResponse, ProfileOrdersArgs, ResolveAccountResponse, WalletClosedPositionsArgs, WalletPnlResponse, WalletTokenTransfersArgs } from "./types";
|
|
3
|
+
import type { AgentProfileRelationshipsResponse, ClosedPositionsResponse, GetAccountArgs, GetAccountTokensArgs, GetAccountTokensResponse, PortfolioArgs, PortfolioHistoryResponse, PortfolioStatsResponse, PositionTokenTransfersResponse, ProfileCollectionsArgs, ProfileCollectionsResponse, ProfileFavoritesArgs, ProfileFavoritesResponse, ProfileListingsResponse, ProfileOffersResponse, ProfileOrdersArgs, ResolveAccountResponse, WalletClosedPositionsArgs, WalletPnlResponse, WalletTokenTransfersArgs } from "./types";
|
|
4
4
|
/**
|
|
5
5
|
* Account and payment token related API operations
|
|
6
6
|
*/
|
|
@@ -15,7 +15,7 @@ export declare class AccountsAPI {
|
|
|
15
15
|
/**
|
|
16
16
|
* Fetch account for an address.
|
|
17
17
|
*/
|
|
18
|
-
getAccount(address: string): Promise<OpenSeaAccount>;
|
|
18
|
+
getAccount(address: string, args?: GetAccountArgs): Promise<OpenSeaAccount>;
|
|
19
19
|
/**
|
|
20
20
|
* Get the public agent ownership relationships for a profile. This is a public
|
|
21
21
|
* read and does not require wallet authentication.
|
package/lib/api/accounts.js
CHANGED
|
@@ -24,8 +24,8 @@ class AccountsAPI {
|
|
|
24
24
|
/**
|
|
25
25
|
* Fetch account for an address.
|
|
26
26
|
*/
|
|
27
|
-
async getAccount(address) {
|
|
28
|
-
const response = await this.fetcher.get((0, apiPaths_1.getAccountPath)(address));
|
|
27
|
+
async getAccount(address, args) {
|
|
28
|
+
const response = await this.fetcher.get((0, apiPaths_1.getAccountPath)(address), args);
|
|
29
29
|
// The api-types schema marks `social_media_accounts` as a required
|
|
30
30
|
// non-nullable array, but the live API returns `null` for accounts that
|
|
31
31
|
// haven't linked any socials. Normalize to `[]` so callers can safely map.
|
package/lib/api/accounts.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"accounts.js","sourceRoot":"","sources":["../../src/api/accounts.ts"],"names":[],"mappings":";;;AACA,yCAgBmB;
|
|
1
|
+
{"version":3,"file":"accounts.js","sourceRoot":"","sources":["../../src/api/accounts.ts"],"names":[],"mappings":";;;AACA,yCAgBmB;AAyBnB,SAAS,SAAS,CAAC,KAA2B;IAC5C,OAAO,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;AAChE,CAAC;AAED;;GAEG;AACH;IAEY,OAAO;IACP,KAAK;IAFf,YACU,OAAgB,EAChB,KAAY;uBADZ,OAAO;qBACP,KAAK;IACZ,CAAC;IAEJ;;OAEG;IACH,KAAK,CAAC,eAAe,CACnB,OAAe,EACf,KAAK,GAAG,IAAI,CAAC,KAAK;QAElB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,8BAAmB,EAAC,KAAK,EAAE,OAAO,CAAC,CACpC,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CACd,OAAe,EACf,IAAqB;QAErB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,yBAAc,EAAC,OAAO,CAAC,EACvB,IAAI,CACL,CAAA;QACD,mEAAmE;QACnE,wEAAwE;QACxE,2EAA2E;QAC3E,OAAO;YACL,GAAG,QAAQ;YACX,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,IAAI,EAAE;SACxD,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,4BAA4B,CAChC,iBAAyB;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,2CAAgC,EAAC,iBAAiB,CAAC,CACpD,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAe,EACf,IAA2B;QAE3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,+BAAoB,EAAC,OAAO,CAAC,EAC7B,IAAI,CACL,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,UAAkB;QACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,gCAAqB,EAAC,UAAU,CAAC,CAClC,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe,EACf,IAAoB;QAEpB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,gCAAqB,EAAC,OAAO,CAAC,EAC9B,IAAI,CACL,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAe,EACf,IAAoB;QAEpB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,kCAAuB,EAAC,OAAO,CAAC,EAChC,IAAI,CACL,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAe,EACf,IAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,uCAA4B,EAAC,OAAO,CAAC,EACrC;YACE,GAAG,IAAI;YACP,eAAe,EAAE,SAAS,CAAC,IAAI,EAAE,eAAe,CAAC;YACjD,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC;SAChC,CACF,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAe,EACf,IAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,+BAAoB,EAAC,OAAO,CAAC,EAC7B;YACE,GAAG,IAAI;YACP,eAAe,EAAE,SAAS,CAAC,IAAI,EAAE,eAAe,CAAC;YACjD,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC;SAChC,CACF,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAe,EACf,IAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,iCAAsB,EAAC,OAAO,CAAC,EAC/B;YACE,GAAG,IAAI;YACP,eAAe,EAAE,SAAS,CAAC,IAAI,EAAE,eAAe,CAAC;YACjD,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC;SAChC,CACF,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAe,EACf,IAA2B;QAE3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,kCAAuB,EAAC,OAAO,CAAC,EAChC;YACE,GAAG,IAAI;YACP,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC;SAChC,CACF,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,OAAe;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAoB,IAAA,2BAAgB,EAAC,OAAO,CAAC,CAAC,CAAA;IACvE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAAe,EACf,IAAgC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,uCAA4B,EAAC,OAAO,CAAC,EACrC,IAAI,CACL,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAAe,EACf,IAA8B;QAE9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,sCAA2B,EAAC,OAAO,CAAC,EACpC,IAAI,CACL,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,qBAAqB,CACzB,OAAe,EACf,IAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,oCAAyB,EAAC,OAAO,CAAC,EAClC;YACE,GAAG,IAAI;YACP,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,MAAM,CAAC;SAChC,CACF,CAAA;IACH,CAAC;CACF"}
|
package/lib/api/collections.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Chain, OpenSeaCollection, OpenSeaCollectionStats } from "../types";
|
|
2
2
|
import type { Fetcher } from "./fetcher";
|
|
3
|
-
import { type BatchCollectionsRequest, type CollectionBatchResponse, type CollectionFloorPricesArgs, type CollectionHoldersArgs, type CollectionHoldersPaginatedResponse, type CollectionOfferAggregatesPaginatedResponse, CollectionOrderByOption, type CollectionPfpProfilesResponse, type CreatorFeeEnforcementStatusResponse, type FloorPriceHistoryResponse, type GetCollectionPfpProfilesArgs, type GetCollectionsPaginatedResponse, type GetCollectionsResponse, type GetTopCollectionsArgs, type GetTopPfpCollectionsArgs, type GetTraitsResponse, type GetTrendingCollectionsArgs, type
|
|
3
|
+
import { type BatchCollectionsRequest, type CollectionBatchResponse, type CollectionFloorPricesArgs, type CollectionHoldersArgs, type CollectionHoldersPaginatedResponse, type CollectionOfferAggregatesArgs, type CollectionOfferAggregatesPaginatedResponse, CollectionOrderByOption, type CollectionPfpProfilesResponse, type CollectionStatsArgs, type CreatorFeeEnforcementStatusResponse, type FloorPriceHistoryResponse, type GetCollectionPfpProfilesArgs, type GetCollectionsPaginatedResponse, type GetCollectionsResponse, type GetTopCollectionsArgs, type GetTopPfpCollectionsArgs, type GetTraitsResponse, type GetTrendingCollectionsArgs, type TopPfpCollectionsResponse, type TraitFloorsResponse } from "./types";
|
|
4
4
|
/**
|
|
5
5
|
* Collection-related API operations
|
|
6
6
|
*/
|
|
@@ -27,7 +27,7 @@ export declare class CollectionsAPI {
|
|
|
27
27
|
/**
|
|
28
28
|
* Fetch stats for an OpenSea collection.
|
|
29
29
|
*/
|
|
30
|
-
getCollectionStats(slug: string): Promise<OpenSeaCollectionStats>;
|
|
30
|
+
getCollectionStats(slug: string, args?: CollectionStatsArgs): Promise<OpenSeaCollectionStats>;
|
|
31
31
|
/**
|
|
32
32
|
* Fetch all traits for a collection with their possible values and counts.
|
|
33
33
|
*
|
|
@@ -55,7 +55,7 @@ export declare class CollectionsAPI {
|
|
|
55
55
|
* Fetch aggregated offers for a collection: top offers grouped by price
|
|
56
56
|
* level, for displaying offer-book depth.
|
|
57
57
|
*/
|
|
58
|
-
getCollectionOfferAggregates(slug: string, args?:
|
|
58
|
+
getCollectionOfferAggregates(slug: string, args?: CollectionOfferAggregatesArgs): Promise<CollectionOfferAggregatesPaginatedResponse>;
|
|
59
59
|
/**
|
|
60
60
|
* Fetch holders of a collection, ranked by quantity owned. Optionally
|
|
61
61
|
* filter to a single owner via `args.owned_by`.
|
package/lib/api/collections.js
CHANGED
|
@@ -47,9 +47,9 @@ class CollectionsAPI {
|
|
|
47
47
|
/**
|
|
48
48
|
* Fetch stats for an OpenSea collection.
|
|
49
49
|
*/
|
|
50
|
-
async getCollectionStats(slug) {
|
|
50
|
+
async getCollectionStats(slug, args) {
|
|
51
51
|
const path = (0, apiPaths_1.getCollectionStatsPath)(slug);
|
|
52
|
-
const response = await this.fetcher.get(path);
|
|
52
|
+
const response = await this.fetcher.get(path, args);
|
|
53
53
|
return response;
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"collections.js","sourceRoot":"","sources":["../../src/api/collections.ts"],"names":[],"mappings":";;;AACA,yCAemB;AAEnB,
|
|
1
|
+
{"version":3,"file":"collections.js","sourceRoot":"","sources":["../../src/api/collections.ts"],"names":[],"mappings":";;;AACA,yCAemB;AAEnB,mCAwBgB;AAEhB;;GAEG;AACH;IACsB,OAAO;IAA3B,YAAoB,OAAgB;uBAAhB,OAAO;IAAY,CAAC;IAExC;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,IAAY;QAC9B,MAAM,IAAI,GAAG,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAwB,IAAI,CAAC,CAAA;IACtD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,wBAAwB,CAAC,IAAY;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,uCAA4B,EAAC,IAAI,CAAC,CACnC,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAClB,OAAO,GAA4B,+BAAuB,CAAC,YAAY,EACvE,KAAa,EACb,eAAwB,EACxB,aAAa,GAAY,KAAK,EAC9B,KAAc,EACd,IAAa;QAEb,MAAM,IAAI,GAAG,IAAA,6BAAkB,GAAE,CAAA;QACjC,MAAM,IAAI,GAAuB;YAC/B,OAAO;YACP,KAAK;YACL,eAAe;YACf,aAAa;YACb,KAAK;YACL,IAAI;SACL,CAAA;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAyB,IAAI,EAAE,IAAI,CAAC,CAAA;IAC7D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,kBAAkB,CACtB,IAAY,EACZ,IAA0B;QAE1B,MAAM,IAAI,GAAG,IAAA,iCAAsB,EAAC,IAAI,CAAC,CAAA;QACzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAyB,IAAI,EAAE,IAAI,CAAC,CAAA;QAC3E,OAAO,QAAkC,CAAA;IAC3C,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,SAAS,CAAC,cAAsB;QACpC,MAAM,IAAI,GAAG,IAAA,wBAAa,EAAC,cAAc,CAAC,CAAA;QAC1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAI,EACJ,SAAS,EACT;YACE,gBAAgB,EAAE,KAAK;SACxB,CACF,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,sBAAsB,CAC1B,IAAiC;QAEjC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,qCAA0B,GAAE,EAC5B;YACE,GAAG,IAAI;YACP,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC;SAChC,CACF,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB,CACrB,IAA4B;QAE5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,gCAAqB,GAAE,EACvB;YACE,GAAG,IAAI;YACP,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC;SAChC,CACF,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAgC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,kCAAuB,GAAE,EACzB,OAAO,CACR,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,4BAA4B,CAChC,IAAY,EACZ,IAAoC;QAEpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,2CAAgC,EAAC,IAAI,CAAC,EACtC,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CACxB,IAAY,EACZ,IAA4B;QAE5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,mCAAwB,EAAC,IAAI,CAAC,EAC9B,IAAI,CACL,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAC5B,IAAY,EACZ,IAAgC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,uCAA4B,EAAC,IAAI,CAAC,EAClC,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,wBAAwB,CAC5B,IAAY;QAEZ,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,uCAA4B,EAAC,IAAI,CAAC,CACnC,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,wBAAwB,CAC5B,IAAY,EACZ,IAAmC;QAEnC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,uCAA4B,EAAC,IAAI,CAAC,EAClC,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,oBAAoB,CACxB,IAA8B;QAE9B,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,IAEnC,CAAA;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,mCAAwB,GAAE,EAC1B,KAAK,CACN,CAAA;IACH,CAAC;CACF"}
|
package/lib/api/nfts.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Chain, OpenSeaCollection } from "../types";
|
|
2
2
|
import type { Fetcher } from "./fetcher";
|
|
3
|
-
import { type BatchNftsRequest, type GetContractResponse, type GetNFTGroupFacetsArgs, type GetNFTGroupFacetsResponse, type GetNFTMetadataResponse, type GetNFTResponse, type GetNFTsByAccountOptions, type GetNFTsByGroupArgs, type GetNFTsByGroupResponse, type ListNFTsResponse, type NFTOwnersArgs, type NftAnalyticsResponse, type NftBatchResponse, type OwnersPaginatedResponse, type TraitFilter, type ValidateMetadataResponse } from "./types";
|
|
3
|
+
import { type BatchNftsRequest, type CollectionNFTFilters, type GetContractResponse, type GetNFTGroupFacetsArgs, type GetNFTGroupFacetsResponse, type GetNFTMetadataResponse, type GetNFTResponse, type GetNFTsByAccountOptions, type GetNFTsByGroupArgs, type GetNFTsByGroupResponse, type ListNFTsResponse, type NFTOwnersArgs, type NftAnalyticsResponse, type NftBatchResponse, type OwnersPaginatedResponse, type TraitFilter, type ValidateMetadataResponse } from "./types";
|
|
4
4
|
/**
|
|
5
5
|
* NFT-related API operations
|
|
6
6
|
*/
|
|
@@ -12,7 +12,7 @@ export declare class NFTsAPI {
|
|
|
12
12
|
* Fetch multiple NFTs for a collection. Pass `traits` to filter server-side
|
|
13
13
|
* by item traits (multiple entries are AND-combined).
|
|
14
14
|
*/
|
|
15
|
-
getNFTsByCollection(slug: string, limit?: number | undefined, next?: string | undefined, traits?: TraitFilter[] | undefined, hasAgentBinding?: boolean | undefined): Promise<ListNFTsResponse>;
|
|
15
|
+
getNFTsByCollection(slug: string, limit?: number | undefined, next?: string | undefined, traits?: TraitFilter[] | undefined, hasAgentBinding?: boolean | undefined, filters?: CollectionNFTFilters): Promise<ListNFTsResponse>;
|
|
16
16
|
/**
|
|
17
17
|
* Fetch multiple NFTs for a contract.
|
|
18
18
|
*/
|
package/lib/api/nfts.js
CHANGED
|
@@ -17,8 +17,14 @@ class NFTsAPI {
|
|
|
17
17
|
* Fetch multiple NFTs for a collection. Pass `traits` to filter server-side
|
|
18
18
|
* by item traits (multiple entries are AND-combined).
|
|
19
19
|
*/
|
|
20
|
-
async getNFTsByCollection(slug, limit = undefined, next = undefined, traits = undefined, hasAgentBinding = undefined) {
|
|
21
|
-
const response = await this.fetcher.get((0, apiPaths_1.getListNFTsByCollectionPath)(slug), {
|
|
20
|
+
async getNFTsByCollection(slug, limit = undefined, next = undefined, traits = undefined, hasAgentBinding = undefined, filters) {
|
|
21
|
+
const response = await this.fetcher.get((0, apiPaths_1.getListNFTsByCollectionPath)(slug), {
|
|
22
|
+
...filters,
|
|
23
|
+
limit,
|
|
24
|
+
next,
|
|
25
|
+
traits: (0, types_1.encodeTraitsParam)(traits),
|
|
26
|
+
hasAgentBinding,
|
|
27
|
+
});
|
|
22
28
|
return response;
|
|
23
29
|
}
|
|
24
30
|
/**
|
package/lib/api/nfts.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"nfts.js","sourceRoot":"","sources":["../../src/api/nfts.ts"],"names":[],"mappings":";;;AACA,yCAemB;AAEnB,
|
|
1
|
+
{"version":3,"file":"nfts.js","sourceRoot":"","sources":["../../src/api/nfts.ts"],"names":[],"mappings":";;;AACA,yCAemB;AAEnB,mCAoBgB;AAEhB;;GAEG;AACH;IAEY,OAAO;IACP,KAAK;IAFf,YACU,OAAgB,EAChB,KAAY;uBADZ,OAAO;qBACP,KAAK;IACZ,CAAC;IAEJ;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CACvB,IAAY,EACZ,KAAK,GAAuB,SAAS,EACrC,IAAI,GAAuB,SAAS,EACpC,MAAM,GAA8B,SAAS,EAC7C,eAAe,GAAwB,SAAS,EAChD,OAA8B;QAE9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,sCAA2B,EAAC,IAAI,CAAC,EACjC;YACE,GAAG,OAAO;YACV,KAAK;YACL,IAAI;YACJ,MAAM,EAAE,IAAA,yBAAiB,EAAC,MAAM,CAAC;YACjC,eAAe;SAChB,CACF,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAe,EACf,KAAK,GAAuB,SAAS,EACrC,IAAI,GAAuB,SAAS,EACpC,KAAK,GAAU,IAAI,CAAC,KAAK;QAEzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,oCAAyB,EAAC,KAAK,EAAE,OAAO,CAAC,EACzC;YACE,KAAK;YACL,IAAI;SACL,CACF,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAe,EACf,KAAK,GAAuB,SAAS,EACrC,IAAI,GAAuB,SAAS,EACpC,KAAK,GAAG,IAAI,CAAC,KAAK,EAClB,OAAiC;QAEjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,mCAAwB,EAAC,KAAK,EAAE,OAAO,CAAC,EACxC;YACE,KAAK;YACL,IAAI;YACJ,oEAAoE;YACpE,oEAAoE;YACpE,6CAA6C;YAC7C,iBAAiB,EAAE,OAAO,EAAE,iBAAiB;SAC9C,CACF,CAAA;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,KAAa,EACb,IAAI,GAAuB,EAAE;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,iCAAsB,EAAC,KAAK,CAAC,EAC7B,IAAI,CACL,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,iBAAiB,CACrB,KAAa,EACb,IAAI,GAA0B,EAAE;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,gCAAqB,EAAC,KAAK,CAAC,EAC5B,IAAI,CACL,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,OAAe,EACf,UAAkB,EAClB,KAAK,GAAG,IAAI,CAAC,KAAK;QAElB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,qBAAU,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,CACvC,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,kBAAkB,CACtB,OAAe,EACf,UAAkB,EAClB,KAAK,GAAU,IAAI,CAAC,KAAK;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,iCAAsB,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAClD,EAAE,CACH,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CACf,OAAe,EACf,KAAK,GAAU,IAAI,CAAC,KAAK;QAEzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,0BAAe,EAAC,KAAK,EAAE,OAAO,CAAC,CAChC,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAe,EACf,UAAkB,EAClB,KAAK,GAAU,IAAI,CAAC,KAAK,EACzB,oBAA8B;QAE9B,IAAI,IAAI,GAAG,IAAA,kCAAuB,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;QAC9D,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,IAAI,yBAAyB,oBAAoB,EAAE,CAAA;QACzD,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAA2B,IAAI,CAAC,CAAA;QACxE,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAAe,EACf,UAAkB,EAClB,KAAK,GAAU,IAAI,CAAC,KAAK;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,+BAAoB,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,CACjD,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAClB,OAAe,EACf,OAAe,EACf,KAAK,GAAU,IAAI,CAAC,KAAK;QAEzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CACrC,IAAA,6BAAkB,EAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAC5C,CAAA;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY,CAAC,OAAyB;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAmB,IAAA,2BAAgB,GAAE,EAAE,OAAO,CAAC,CAAA;IACzE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAChB,OAAe,EACf,UAAkB,EAClB,KAAK,GAAU,IAAI,CAAC,KAAK,EACzB,IAAoB;QAEpB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,2BAAgB,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAC5C,IAAI,CACL,CAAA;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CACnB,OAAe,EACf,UAAkB,EAClB,KAAK,GAAU,IAAI,CAAC,KAAK;QAEzB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,8BAAmB,EAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,CAChD,CAAA;IACH,CAAC;CACF"}
|
package/lib/api/types.d.ts
CHANGED
|
@@ -1246,6 +1246,8 @@ export type NFTGroupSortBy = "price" | "top_offer" | "last_sale" | "last_sale_da
|
|
|
1246
1246
|
* @category API Query Args
|
|
1247
1247
|
*/
|
|
1248
1248
|
export interface GetNFTsByGroupArgs extends NFTGroupFacetFilters {
|
|
1249
|
+
/** Request optional catalog identities; omitted before unrestricted public launch. */
|
|
1250
|
+
includeCatalog?: OperationQueryParams<"list_nfts_by_group">["include_catalog"];
|
|
1249
1251
|
/** Restrict results to these collections in the group (max 10). Defaults to the whole group. */
|
|
1250
1252
|
collectionSlugs?: string[];
|
|
1251
1253
|
/** Full-text match on NFT name, up to 100 characters. */
|
|
@@ -1445,4 +1447,12 @@ export type GetSignalResponse = Camelize<SignalResponse>;
|
|
|
1445
1447
|
* @category API Response Types
|
|
1446
1448
|
*/
|
|
1447
1449
|
export type ListSignalsResponse = Camelize<SignalsResponse>;
|
|
1450
|
+
/** Indexed filters for collection NFTs. Numeric traits is a JSON array of traitType/min/max ranges. */
|
|
1451
|
+
export type CollectionNFTFilters = Camelize<Pick<OperationQueryParams<"get_nfts_by_collection">, "is_listed" | "price_min" | "price_max" | "rarity_min" | "rarity_max" | "sort_by" | "sort_direction" | "numeric_traits">>;
|
|
1452
|
+
/** Optional volume buckets: numeric Unix seconds and decimal-string USD values. */
|
|
1453
|
+
export type CollectionStatsArgs = Camelize<OperationQueryParams<"get_collection_stats">>;
|
|
1454
|
+
/** Optional capped two-sided collection depth. */
|
|
1455
|
+
export type CollectionOfferAggregatesArgs = PaginatedAnalyticsArgs & Camelize<Pick<OperationQueryParams<"get_collection_offer_aggregates">, "include_depth">>;
|
|
1456
|
+
/** Public account expansion; private registered wallets remain excluded. */
|
|
1457
|
+
export type GetAccountArgs = OperationQueryParams<"get_account">;
|
|
1448
1458
|
export {};
|
package/lib/scopes.d.ts
CHANGED
|
@@ -15,6 +15,7 @@ export declare const OPENSEA_SCOPES: {
|
|
|
15
15
|
readonly READ_TOOLS: "read:tools";
|
|
16
16
|
readonly READ_WALLETS: "read:wallets";
|
|
17
17
|
readonly WRITE_FAVORITES: "write:favorites";
|
|
18
|
+
readonly WRITE_POSTS: "write:posts";
|
|
18
19
|
readonly WRITE_SOCIAL: "write:social";
|
|
19
20
|
readonly WRITE_TOOLS: "write:tools";
|
|
20
21
|
readonly WRITE_ORDERS: "write:orders";
|
package/lib/scopes.js
CHANGED
package/lib/scopes.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"scopes.js","sourceRoot":"","sources":["../src/scopes.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;GAQG;AACU,QAAA,cAAc,GAAG;IAC5B,gBAAgB,EAAE,kBAAkB;IACpC,cAAc,EAAE,gBAAgB;IAChC,WAAW,EAAE,aAAa;IAC1B,UAAU,EAAE,YAAY;IACxB,YAAY,EAAE,cAAc;IAC5B,eAAe,EAAE,iBAAiB;IAClC,YAAY,EAAE,cAAc;IAC5B,WAAW,EAAE,aAAa;IAC1B,YAAY,EAAE,cAAc;IAC5B,WAAW,EAAE,aAAa;IAC1B,iBAAiB,EAAE,mBAAmB;IACtC,aAAa,EAAE,eAAe;IAC9B,aAAa,EAAE,eAAe;CACc,CAAA;AAc9C,MAAM,2BAA2B,GAAgC,IAAI,CAAA;AAErE;;;GAGG;AACU,QAAA,UAAU,GAA4B,MAAM,CAAC,MAAM,CAAC,QAAA,cAAc,CAAC,CAAA"}
|
|
1
|
+
{"version":3,"file":"scopes.js","sourceRoot":"","sources":["../src/scopes.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;GAQG;AACU,QAAA,cAAc,GAAG;IAC5B,gBAAgB,EAAE,kBAAkB;IACpC,cAAc,EAAE,gBAAgB;IAChC,WAAW,EAAE,aAAa;IAC1B,UAAU,EAAE,YAAY;IACxB,YAAY,EAAE,cAAc;IAC5B,eAAe,EAAE,iBAAiB;IAClC,WAAW,EAAE,aAAa;IAC1B,YAAY,EAAE,cAAc;IAC5B,WAAW,EAAE,aAAa;IAC1B,YAAY,EAAE,cAAc;IAC5B,WAAW,EAAE,aAAa;IAC1B,iBAAiB,EAAE,mBAAmB;IACtC,aAAa,EAAE,eAAe;IAC9B,aAAa,EAAE,eAAe;CACc,CAAA;AAc9C,MAAM,2BAA2B,GAAgC,IAAI,CAAA;AAErE;;;GAGG;AACU,QAAA,UAAU,GAA4B,MAAM,CAAC,MAAM,CAAC,QAAA,cAAc,CAAC,CAAA"}
|
package/lib/sdk/base.d.ts
CHANGED
|
@@ -285,6 +285,7 @@ export declare class BaseOpenSeaSDK {
|
|
|
285
285
|
gasLimit?: string | null | undefined;
|
|
286
286
|
svm?: {
|
|
287
287
|
addressLookupTables: string[];
|
|
288
|
+
blockhash?: string | null | undefined;
|
|
288
289
|
from: string;
|
|
289
290
|
instructions: {
|
|
290
291
|
accounts: {
|
|
@@ -295,6 +296,18 @@ export declare class BaseOpenSeaSDK {
|
|
|
295
296
|
data?: string | null | undefined;
|
|
296
297
|
programId: string;
|
|
297
298
|
}[];
|
|
299
|
+
lastValidBlockHeight?: number | null | undefined;
|
|
300
|
+
marketplaceFeeTransfer?: {
|
|
301
|
+
decimals: number;
|
|
302
|
+
nativeToken: boolean;
|
|
303
|
+
rawAmount: string;
|
|
304
|
+
recipient: string;
|
|
305
|
+
recipientOwner?: string | null | undefined;
|
|
306
|
+
settlement: "separate_transfer" | "unknown";
|
|
307
|
+
tokenAddress: string;
|
|
308
|
+
} | null | undefined;
|
|
309
|
+
requiresJitoBundle: boolean;
|
|
310
|
+
serializedTransaction?: string | null | undefined;
|
|
298
311
|
transactionConfig?: {
|
|
299
312
|
computeUnitLimit?: number | null | undefined;
|
|
300
313
|
heapSizeBytes?: number | null | undefined;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@opensea/sdk",
|
|
3
|
-
"version": "14.
|
|
3
|
+
"version": "14.3.0",
|
|
4
4
|
"description": "TypeScript SDK for the OpenSea marketplace helps developers build new experiences using NFTs, tokens, and our marketplace data",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "OpenSea Developers",
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
"types": "lib/index.d.ts",
|
|
48
48
|
"dependencies": {
|
|
49
49
|
"@noble/hashes": "^2.0.1",
|
|
50
|
-
"@opensea/api-types": "^0.20.
|
|
50
|
+
"@opensea/api-types": "^0.20.2",
|
|
51
51
|
"@opensea/seaport-js": "^4.2.0",
|
|
52
52
|
"ethers": "^6.16.0"
|
|
53
53
|
},
|
package/src/api/accounts.ts
CHANGED
|
@@ -20,6 +20,7 @@ import type { Fetcher } from "./fetcher"
|
|
|
20
20
|
import type {
|
|
21
21
|
AgentProfileRelationshipsResponse,
|
|
22
22
|
ClosedPositionsResponse,
|
|
23
|
+
GetAccountArgs,
|
|
23
24
|
GetAccountTokensArgs,
|
|
24
25
|
GetAccountTokensResponse,
|
|
25
26
|
PortfolioArgs,
|
|
@@ -67,9 +68,13 @@ export class AccountsAPI {
|
|
|
67
68
|
/**
|
|
68
69
|
* Fetch account for an address.
|
|
69
70
|
*/
|
|
70
|
-
async getAccount(
|
|
71
|
+
async getAccount(
|
|
72
|
+
address: string,
|
|
73
|
+
args?: GetAccountArgs,
|
|
74
|
+
): Promise<OpenSeaAccount> {
|
|
71
75
|
const response = await this.fetcher.get<OpenSeaAccount>(
|
|
72
76
|
getAccountPath(address),
|
|
77
|
+
args,
|
|
73
78
|
)
|
|
74
79
|
// The api-types schema marks `social_media_accounts` as a required
|
|
75
80
|
// non-nullable array, but the live API returns `null` for accounts that
|
package/src/api/collections.ts
CHANGED
|
@@ -22,9 +22,11 @@ import {
|
|
|
22
22
|
type CollectionFloorPricesArgs,
|
|
23
23
|
type CollectionHoldersArgs,
|
|
24
24
|
type CollectionHoldersPaginatedResponse,
|
|
25
|
+
type CollectionOfferAggregatesArgs,
|
|
25
26
|
type CollectionOfferAggregatesPaginatedResponse,
|
|
26
27
|
CollectionOrderByOption,
|
|
27
28
|
type CollectionPfpProfilesResponse,
|
|
29
|
+
type CollectionStatsArgs,
|
|
28
30
|
type CreatorFeeEnforcementStatusResponse,
|
|
29
31
|
type FloorPriceHistoryResponse,
|
|
30
32
|
type GetCollectionPfpProfilesArgs,
|
|
@@ -36,7 +38,6 @@ import {
|
|
|
36
38
|
type GetTopPfpCollectionsArgs,
|
|
37
39
|
type GetTraitsResponse,
|
|
38
40
|
type GetTrendingCollectionsArgs,
|
|
39
|
-
type PaginatedAnalyticsArgs,
|
|
40
41
|
type TopPfpCollectionsResponse,
|
|
41
42
|
type TraitFloorsResponse,
|
|
42
43
|
} from "./types"
|
|
@@ -95,9 +96,12 @@ export class CollectionsAPI {
|
|
|
95
96
|
/**
|
|
96
97
|
* Fetch stats for an OpenSea collection.
|
|
97
98
|
*/
|
|
98
|
-
async getCollectionStats(
|
|
99
|
+
async getCollectionStats(
|
|
100
|
+
slug: string,
|
|
101
|
+
args?: CollectionStatsArgs,
|
|
102
|
+
): Promise<OpenSeaCollectionStats> {
|
|
99
103
|
const path = getCollectionStatsPath(slug)
|
|
100
|
-
const response = await this.fetcher.get<OpenSeaCollectionStats>(path)
|
|
104
|
+
const response = await this.fetcher.get<OpenSeaCollectionStats>(path, args)
|
|
101
105
|
return response as OpenSeaCollectionStats
|
|
102
106
|
}
|
|
103
107
|
|
|
@@ -171,7 +175,7 @@ export class CollectionsAPI {
|
|
|
171
175
|
*/
|
|
172
176
|
async getCollectionOfferAggregates(
|
|
173
177
|
slug: string,
|
|
174
|
-
args?:
|
|
178
|
+
args?: CollectionOfferAggregatesArgs,
|
|
175
179
|
): Promise<CollectionOfferAggregatesPaginatedResponse> {
|
|
176
180
|
return this.fetcher.get<CollectionOfferAggregatesPaginatedResponse>(
|
|
177
181
|
getCollectionOfferAggregatesPath(slug),
|
package/src/api/nfts.ts
CHANGED
|
@@ -18,6 +18,7 @@ import {
|
|
|
18
18
|
import type { Fetcher } from "./fetcher"
|
|
19
19
|
import {
|
|
20
20
|
type BatchNftsRequest,
|
|
21
|
+
type CollectionNFTFilters,
|
|
21
22
|
encodeTraitsParam,
|
|
22
23
|
type GetCollectionResponse,
|
|
23
24
|
type GetContractResponse,
|
|
@@ -56,10 +57,17 @@ export class NFTsAPI {
|
|
|
56
57
|
next: string | undefined = undefined,
|
|
57
58
|
traits: TraitFilter[] | undefined = undefined,
|
|
58
59
|
hasAgentBinding: boolean | undefined = undefined,
|
|
60
|
+
filters?: CollectionNFTFilters,
|
|
59
61
|
): Promise<ListNFTsResponse> {
|
|
60
62
|
const response = await this.fetcher.get<ListNFTsResponse>(
|
|
61
63
|
getListNFTsByCollectionPath(slug),
|
|
62
|
-
{
|
|
64
|
+
{
|
|
65
|
+
...filters,
|
|
66
|
+
limit,
|
|
67
|
+
next,
|
|
68
|
+
traits: encodeTraitsParam(traits),
|
|
69
|
+
hasAgentBinding,
|
|
70
|
+
},
|
|
63
71
|
)
|
|
64
72
|
return response
|
|
65
73
|
}
|
package/src/api/types.ts
CHANGED
|
@@ -1582,6 +1582,8 @@ export type NFTGroupSortBy =
|
|
|
1582
1582
|
* @category API Query Args
|
|
1583
1583
|
*/
|
|
1584
1584
|
export interface GetNFTsByGroupArgs extends NFTGroupFacetFilters {
|
|
1585
|
+
/** Request optional catalog identities; omitted before unrestricted public launch. */
|
|
1586
|
+
includeCatalog?: OperationQueryParams<"list_nfts_by_group">["include_catalog"]
|
|
1585
1587
|
/** Restrict results to these collections in the group (max 10). Defaults to the whole group. */
|
|
1586
1588
|
collectionSlugs?: string[]
|
|
1587
1589
|
/** Full-text match on NFT name, up to 100 characters. */
|
|
@@ -1812,3 +1814,32 @@ export type GetSignalResponse = Camelize<SignalResponse>
|
|
|
1812
1814
|
* @category API Response Types
|
|
1813
1815
|
*/
|
|
1814
1816
|
export type ListSignalsResponse = Camelize<SignalsResponse>
|
|
1817
|
+
|
|
1818
|
+
/** Indexed filters for collection NFTs. Numeric traits is a JSON array of traitType/min/max ranges. */
|
|
1819
|
+
export type CollectionNFTFilters = Camelize<
|
|
1820
|
+
Pick<
|
|
1821
|
+
OperationQueryParams<"get_nfts_by_collection">,
|
|
1822
|
+
| "is_listed"
|
|
1823
|
+
| "price_min"
|
|
1824
|
+
| "price_max"
|
|
1825
|
+
| "rarity_min"
|
|
1826
|
+
| "rarity_max"
|
|
1827
|
+
| "sort_by"
|
|
1828
|
+
| "sort_direction"
|
|
1829
|
+
| "numeric_traits"
|
|
1830
|
+
>
|
|
1831
|
+
>
|
|
1832
|
+
/** Optional volume buckets: numeric Unix seconds and decimal-string USD values. */
|
|
1833
|
+
export type CollectionStatsArgs = Camelize<
|
|
1834
|
+
OperationQueryParams<"get_collection_stats">
|
|
1835
|
+
>
|
|
1836
|
+
/** Optional capped two-sided collection depth. */
|
|
1837
|
+
export type CollectionOfferAggregatesArgs = PaginatedAnalyticsArgs &
|
|
1838
|
+
Camelize<
|
|
1839
|
+
Pick<
|
|
1840
|
+
OperationQueryParams<"get_collection_offer_aggregates">,
|
|
1841
|
+
"include_depth"
|
|
1842
|
+
>
|
|
1843
|
+
>
|
|
1844
|
+
/** Public account expansion; private registered wallets remain excluded. */
|
|
1845
|
+
export type GetAccountArgs = OperationQueryParams<"get_account">
|
package/src/scopes.ts
CHANGED