Read-only mirror. This package is developed in a private monorepo and mirrored to ProjectOpenSea/api-types when a version is released, so the public code can trail the internal main branch by weeks.
Pull requests opened on the mirror cannot be merged there. They are read, and a fix worth taking is recreated in the monorepo. Because a fix that has landed internally is not public until the next release, filing an issue before writing a patch is the quickest way to find out whether a bug is already fixed.
Auto-generated TypeScript types from the OpenSea API OpenAPI spec.
# Fetch latest spec from the API (once the endpoint is live)
pnpm --filter @opensea/api-types run update-spec
# Rebuild types
pnpm --filter @opensea/api-types run buildThe opensea-api.json file is committed to git intentionally — it's the versioned source of truth for codegen. The update-spec script fetches the latest version from the API and writes it locally. Commit the updated spec so diffs show exactly what changed in the API.
import type { Schemas, OperationResponse, OperationQueryParams } from "@opensea/api-types";
type Collection = Schemas["CollectionResponse"];
type ListingsResult = OperationResponse<"get_listings_1">;
type ListParams = OperationQueryParams<"list_collections">;