Releases: ProjectOpenSea/api-types
v0.3.0
What's Changed
Sync of the OpenSea OpenAPI spec — bundles two os2-core PRs and four new endpoints picked up since the last release.
Removed (os2-core#40171)
GET /api/v2/orders/{chain}/{protocol}/offers— useGET /api/v2/offers/collection/{slug}/all(or/nfts/{identifier}for per-NFT)GET /api/v2/orders/{chain}/{protocol}/listings— useGET /api/v2/listings/collection/{slug}/all(or/nfts/{identifier}/bestfor per-NFT)orderwrapper field fromPOST /orders/{chain}/{protocol}/{offers,listings}responses — endpoints now return bareOffer/ListingCriteria.trait(singular) — useCriteria.traits[]IntervalStat.{volume_diff, volume_change, sales_diff, average_price}(always returned 0)Total.{market_cap, average_price}(always returned 0)- Schemas:
OrdersResponse,CreateOfferResponse,CreateListingResponse,SimpleOrderV2Serializer,V1ProtocolData,SimpleAccount. Named re-exports forOrdersResponse,CreateOfferResponse,CreateListingResponse,V1ProtocolData, andSimpleAccountremoved fromsrc/index.ts.
Added (os2-core#40190)
- Optional
makerquery param onGET /api/v2/offers/collection/{slug}/allandGET /api/v2/listings/collection/{slug}/all
New endpoints
POST /api/v2/listings/sweep— bulk-buy from a collection. Types:SweepCollectionRequest,SweepCollectionResponse.GET /api/v2/offers/collection/{slug}/nfts/{identifier}— all offers for one NFT.POST /api/v2/swap/execute— multi-asset companion to/swap/quote. Types:SwapExecuteRequest,SwapExecuteResponse,SwapQuoteInput.POST /api/v2/transactions/receipt— fetch transaction status. Types:TransactionReceiptRequest,TransactionReceiptResponse.
Downstream impact
@opensea/sdk@10.4.0 and @opensea/cli@1.6.0 (released alongside) drop the methods backed by the removed endpoints, fix POST shapes, and surface the four new endpoints. Migration paths are documented in their changelogs.
Full Changelog: ProjectOpenSea/opensea-devtools@api-types-v0.2.3...api-types-v0.3.0
v0.2.3
What's Changed
- Add named exports for cross-chain fulfillment schemas:
CrossChainFulfillmentRequest,CrossChainFulfillmentResponse,CrossChainPaymentToken,FulfillerObject,ListingObject(#242) - Refresh OpenAPI spec from production (#234, #242) — picks up the
cross_chain_fulfillment_dataendpoint and related schemas
Full Changelog: ProjectOpenSea/opensea-devtools@api-types-v0.2.2...api-types-v0.2.3
v0.2.2
What's Changed
Patch release. Additive only — no breaking changes.
New traits query param on three collection-scoped GET endpoints
GET /api/v2/collection/{slug}/nftsGET /api/v2/listings/collection/{slug}/bestGET /api/v2/events/collection/{slug}
Accepts a JSON-encoded array of {traitType, value} filters. Multiple entries are AND-combined server-side (returned items must match every trait). Empty result when no items match; 400 if a single trait matches more than 1000 items.
?traits=[{"traitType":"Background","value":"Red"}]
TokenBalanceResponse.status field
New optional enum field: OK | WARNING | SPAM | LOW_LIQUIDITY | LOW_VALUE. Surfaced when callers pass disable_spam_filtering=true on the account tokens endpoint, so they can see why a token would normally have been filtered.
Account tokens endpoint refinements
limitmax raised from 25 → 100.disable_spam_filteringdescription expanded to clarify what does and doesn't get surfaced.
Validation
Live tests against boredapeyachtclub confirmed end-to-end behavior across NFTs, listings, and events — including AND-combined traits, no-match → empty result, pagination with traits, and 400 on invalid JSON. Deployment monitoring shows zero listing-related errors and baseline error rate post-rollout.
Full Changelog: ProjectOpenSea/opensea-devtools@api-types-v0.2.1...api-types-v0.2.2
v0.2.1
What's Changed
Sync OpenAPI spec: add token-groups endpoints (GET /api/v2/token-groups, GET /api/v2/token-groups/{slug}) and instant API key provisioning (POST /api/v2/auth/keys). Exports new TokenGroup*, InstantApiKeyResponse, and RateLimitsResponse types. Non-breaking: some fields on IntervalStat and Total are now marked deprecated.
Full Changelog: ProjectOpenSea/opensea-devtools@api-types-v0.2.0...api-types-v0.2.1
v0.2.0
What's Changed
Initial release
- Auto-generated TypeScript types from the OpenSea API OpenAPI spec
- Drops endpoints, trending/top collections, account resolve schemas
Full Changelog: https://github.com/ProjectOpenSea/opensea-devtools/commits/api-types-v0.2.0