Skip to content

Releases: ProjectOpenSea/api-types

v0.8.2

Choose a tag to compare

@ryanio ryanio released this 20 Jul 21:12

What changed

  • Add generated types for the beta saved-tools read, save, and remove endpoints.
  • Add the canonical read:tools and write:tools scopes.
  • Add new token metadata fields from the current public OpenAPI schema.

Full diff: ProjectOpenSea/opensea-devtools@api-types-v0.8.1...api-types-v0.8.2

v0.8.1

Choose a tag to compare

@ryanio ryanio released this 17 Jul 17:33

What's changed

  • Added isVerified, followerCount, and followingCount to generated account response types.
  • Added the canonical read:social and write:social wallet auth scopes.
  • Refreshed the production OpenAPI snapshot and normalized schema examples.

Full changelog: ProjectOpenSea/opensea-devtools@api-types-v0.8.0...api-types-v0.8.1

v0.8.0

Choose a tag to compare

@ryanio ryanio released this 11 Jul 21:50

What's changed

  • Added generated types for the full scoped wallet API and SIWX wallet linking.
  • Added generated scope groups, endpoint mappings, and MCP tool metadata.
  • Refreshed wallet-auth scope metadata from the production OpenAPI specification.

Full changelog: ProjectOpenSea/opensea-devtools@api-types-v0.7.0...api-types-v0.8.0

v0.7.0

Choose a tag to compare

@ryanio ryanio released this 09 Jul 01:11

What's Changed

  • Sync OpenAPI spec: add SIWX wallet-link endpoint schema updates including nonce generation, message signing, and wallet-link verification endpoints with new request/response types.

Full Changelog: v0.6.0...v0.7.0

v0.6.0

Choose a tag to compare

@ryanio ryanio released this 06 Jul 21:06

What's Changed

  • feat: add wallet trading P&L endpoints and schemas: GET /api/v2/account/{address}/pnl (WalletPnlResponse), /pnl/closed-positions (ClosedPositionsResponse), and /pnl/token-transfers (PositionTokenTransfersResponse). Also adds ListingPriceInput (#468)
  • feat: add the AuthScope schema with per-scope display names and descriptions, plus the package's first runtime export, AUTH_SCOPES (#415)
  • feat: sync OpenAPI spec: tool activity endpoint, robinhood chain, source/collection search filters, calldata_suffix on fulfillment calldata, SIWX wallet-link endpoint (POST /api/v2/accounts/wallets/siwx), re-published GET /api/v2/account/{address}/favorites, and the new write:wallets auth scope (#483)

Full Changelog: ProjectOpenSea/opensea-devtools@api-types-v0.5.0...api-types-v0.6.0

v0.5.0

Choose a tag to compare

@ryanio ryanio released this 06 Jun 02:06

What's Changed

Sync of the OpenSea API v2 OpenAPI spec. All changes are additive / non-breaking.

  • New endpoint: POST /api/v2/tools/usage[Beta] Report tool usage (metrics only) (report_tool_usage)
  • New schema types: Eip3009Fields, X402SettlementFields, ToolUsageRequest, ToolUsageResponse
  • Changed schemas: DropResponse and DropDetailedResponse gained active_stage and next_stage (refs to DropStageResponse)

Full Changelog: ProjectOpenSea/opensea-devtools@api-types-v0.4.4...api-types-v0.5.0

v0.4.4

Choose a tag to compare

@ryanio ryanio released this 04 Jun 23:00

What's Changed

  • Add [Beta] tool registry endpoint schemas to the OpenAPI spec and generated types: GET /api/v2/tools (list) and the tool search endpoint, along with RegisteredToolResponse, ToolSearchPaginatedResponse, ToolListPaginatedResponse, and supporting tool response types. All additive; no consumer breakage.

Full Changelog: ProjectOpenSea/opensea-devtools@api-types-v0.4.3...api-types-v0.4.4

v0.4.3

Choose a tag to compare

@ryanio ryanio released this 27 May 20:58

What's Changed

Two patch changesets:

Auto-generated schema exports (#345)

  • New src/schemas-generated.ts (auto-built from opensea-api.json) — every components.schemas.* is now a named export. The previous hand-curated list covered 147 of 199 schemas; the remaining 52 are now surfaced.
  • pnpm run generate invokes the new scripts/generate-schema-exports.mjs after openapi-typescript so the schema-export list always tracks the spec.
  • New CI guard scripts/check-consumer-imports.mjs verifies every named @opensea/api-types import across the workspace exists in the built dist/index.d.ts.

Spec sync — token holders / liquidity pools, agent_binding (#347)

New endpoints:

  • GET /api/v2/chain/{chain}/token/{address}/holders — paginated holders (TokenHoldersResponseTokenHolderResponse[]) plus aggregate TokenHolderDistributionResponse (total holders, top-1% concentration, STRONG | HEALTHY | CONCERNING | BAD health label).
  • GET /api/v2/chain/{chain}/token/{address}/liquidity-pools — paginated pools with pool type, USD reserves, bonding-curve progress, graduation flag.

Schema additions:

  • NftDetailed.agent_binding?: AgentBindingResponse — ERC-8217 agent binding (agent_id, binding_contract, the bound AgentNftResponse, optional registered_by).
  • Token.twitter_follower_count?: int64.
  • NFT list endpoint: optional has_agent_binding: boolean query filter.
  • New named exports: AgentBindingResponse, AgentNftResponse, TokenHolderResponse, TokenHoldersResponse, TokenHolderDistributionResponse, TokenLiquidityPoolResponse, TokenLiquidityPoolsResponse.

All changes are additive — no consumer breakage.

Full Changelog: ProjectOpenSea/opensea-devtools@api-types-v0.4.2...api-types-v0.4.3

v0.4.2

Choose a tag to compare

@ryanio ryanio released this 27 May 02:20

What's Changed

  • Add named exports for BuildOfferResponse, CancelRequest, CancelResponse, and PartialParameters — these were in the generated schemas but not surfaced. Pure additive (#343).

Full Changelog: ProjectOpenSea/opensea-devtools@api-types-v0.4.1...api-types-v0.4.2

v0.4.1

Choose a tag to compare

@ryanio ryanio released this 26 May 21:36

What's Changed

Sync OpenAPI spec — pure additive: Order.asset and NftDetailed.subscription field additions plus pagination defaults loosened on /api/v2/collections.

New on Order

  • asset?: OrderAsset{ identifier?: string; contract: string }. Surfaces the NFT contract + token ID without loading protocol_data. identifier is null for collection/criteria offers. Powers the profile endpoints (/account/{address}/listings, /offers, /offers_received) where protocol_data is intentionally null for performance. Source: ProjectOpenSea/os2-core#42022.

New on NftDetailed

  • subscription?: SubscriptionInfoResponse{ expires_at?: string; is_renewable: boolean; is_expired: boolean }.

Loosened on GET /api/v2/collections

  • limit default 1020, max 100200.

Named exports added

OrderAsset, SubscriptionInfoResponse.

Tooling

update-spec now runs biome format on the output so future syncs don't churn on formatter differences.

Full Changelog: ProjectOpenSea/opensea-devtools@api-types-v0.4.0...api-types-v0.4.1