{ "opencollection": "1.0.0", "info": { "name": "OpenSea Account Endpoints Collection Endpoints API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "x-api-key", "value": "{{x-api-key}}", "placement": "header" } }, "items": [ { "info": { "name": "Collection Endpoints", "type": "folder" }, "items": [ { "info": { "name": "Get collections by slugs", "type": "http" }, "http": { "method": "POST", "url": "https://api.opensea.io/api/v2/collections/batch", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve multiple collections in a single request by providing a list of slugs. Results are returned in the same order as the input slugs. Not-found collections are silently omitted." }, { "info": { "name": "Get collection traits", "type": "http" }, "http": { "method": "GET", "url": "https://api.opensea.io/api/v2/traits/:slug", "params": [ { "name": "slug", "value": "doodles-official", "type": "path", "description": "Unique identifier for the specific collection" } ] }, "docs": "Get all available traits for a collection with their value counts and data types." }, { "info": { "name": "Get multiple collections", "type": "http" }, "http": { "method": "GET", "url": "https://api.opensea.io/api/v2/collections", "params": [ { "name": "limit", "value": "20", "type": "query", "description": "Number of items to return per page" }, { "name": "next.value", "value": "", "type": "query" }, { "name": "chain", "value": "", "type": "query", "description": "Blockchain to filter by" }, { "name": "creator_username", "value": "", "type": "query", "description": "Username of collection creator to filter by" }, { "name": "include_hidden", "value": "", "type": "query", "description": "Include hidden collections in results" }, { "name": "order_by", "value": "created_date", "type": "query", "description": "Field to order results by" } ] }, "docs": "Get a list of collections with filters and sorting options." }, { "info": { "name": "Get a single collection", "type": "http" }, "http": { "method": "GET", "url": "https://api.opensea.io/api/v2/collections/:slug", "params": [ { "name": "slug", "value": "doodles-official", "type": "path", "description": "Unique identifier for the specific collection" } ] }, "docs": "Get a single collection including details such as fees, traits, and links." }, { "info": { "name": "Get collection stats", "type": "http" }, "http": { "method": "GET", "url": "https://api.opensea.io/api/v2/collections/:slug/stats", "params": [ { "name": "slug", "value": "doodles-official", "type": "path", "description": "Unique identifier for the specific collection" } ] }, "docs": "Get comprehensive statistics for a collection including volume, floor price, and trading metrics." }, { "info": { "name": "Get collection offer aggregates", "type": "http" }, "http": { "method": "GET", "url": "https://api.opensea.io/api/v2/collections/:slug/offer_aggregates", "params": [ { "name": "slug", "value": "boredapeyachtclub", "type": "path", "description": "Collection slug" }, { "name": "limit", "value": "20", "type": "query", "description": "Number of results to return (default: 20, max: 100)" }, { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor for next page" }, { "name": "sort_direction", "value": "desc", "type": "query", "description": "Sort direction (asc or desc)" } ] }, "docs": "Get aggregated offer buckets grouped by price level for a collection." }, { "info": { "name": "Get collection holders", "type": "http" }, "http": { "method": "GET", "url": "https://api.opensea.io/api/v2/collections/:slug/holders", "params": [ { "name": "slug", "value": "boredapeyachtclub", "type": "path", "description": "Collection slug" }, { "name": "limit", "value": "20", "type": "query", "description": "Number of results to return (default: 20, max: 100)" }, { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor for next page" }, { "name": "sort_direction", "value": "desc", "type": "query", "description": "Sort direction (asc or desc)" }, { "name": "owned_by", "value": "", "type": "query", "description": "Filter by owner address" } ] }, "docs": "Get a paginated list of holders for a collection." }, { "info": { "name": "Get collection floor price history", "type": "http" }, "http": { "method": "GET", "url": "https://api.opensea.io/api/v2/collections/:slug/floor_prices", "params": [ { "name": "slug", "value": "boredapeyachtclub", "type": "path", "description": "Collection slug" }, { "name": "timeframe", "value": "one_day", "type": "query", "description": "Time window for floor price history. Options: one_minute, five_minutes, fifteen_minutes, one_hour, one_day, seven_days, thirty_days, one_year, all_time" }, { "name": "resolution", "value": "", "type": "query", "description": "Number of data points to return" } ] }, "docs": "Get time-series floor price data for a collection." }, { "info": { "name": "Get trending collections", "type": "http" }, "http": { "method": "GET", "url": "https://api.opensea.io/api/v2/collections/trending", "params": [ { "name": "timeframe", "value": "one_day", "type": "query", "description": "Time window for trending calculation. Options: one_minute, five_minutes, fifteen_minutes, one_hour, one_day, seven_days, thirty_days, one_year, all_time." }, { "name": "chains", "value": "ethereum,base", "type": "query", "description": "Blockchain(s) to filter by. Comma-separated list of chain identifiers. Unsupported chains are silently ignored; a 400 is returned only if all specified chains are unsupported." }, { "name": "category", "value": "pfps", "type": "query", "description": "Category to filter by (e.g. art, gaming, memberships, music, pfps, photography, domain-names, virtual-worlds, sports-collectibles, physical-collectibles)." }, { "name": "limit", "value": "20", "type": "query", "description": "Maximum number of collections to return (1-100)." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor for pagination. Use the 'next' value from a previous response." } ] }, "docs": "Get a list of trending NFT collections sorted by sales activity over a specified timeframe. Trending is determined by sales volume and activity metrics. Available timeframes range from 1 minute to all time. For the one_day timeframe without a chain filter, collections are sorted by a composite trending score; all other timeframes sort by raw sales count. Results are filtered to verified, non-spam, non-NSFW collections with minimum volume thresholds." }, { "info": { "name": "Get top collections", "type": "http" }, "http": { "method": "GET", "url": "https://api.opensea.io/api/v2/collections/top", "params": [ { "name": "sort_by", "value": "one_day_volume", "type": "query", "description": "The stat to sort collections by (always sorted descending). Options: one_day_volume, seven_days_volume, thirty_days_volume, floor_price, one_day_sales, seven_days_sales, thirty_days_sales, total_volume, total_sales" }, { "name": "chains", "value": "ethereum,base", "type": "query", "description": "Blockchain(s) to filter by. Comma-separated list of chain identifiers. Unsupported chains are silently ignored; a 400 is returned only if all specified chains are unsupported." }, { "name": "category", "value": "pfps", "type": "query", "description": "Category to filter by (e.g. art, gaming, memberships, music, pfps, photography, domain-names, virtual-worlds, sports-collectibles, physical-collectibles)." }, { "name": "limit", "value": "50", "type": "query", "description": "Maximum number of collections to return (1-100)." }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor for pagination" } ] }, "docs": "Get top NFT collections ranked by various stats (sorted descending). Unlike /trending, results are not filtered by verification status; spam-tagged collections are excluded via trust-safety enforcement states. Available sort options: one_day_volume, seven_days_volume, thirty_days_volume, floor_price, one_day_sales, seven_days_sales, thirty_days_sales, total_volume, total_sales." }, { "info": { "name": "Get collection by NFT", "type": "http" }, "http": { "method": "GET", "url": "https://api.opensea.io/api/v2/chain/:chain/contract/:address/nfts/:identifier/collection", "params": [ { "name": "chain", "value": "ethereum", "type": "path", "description": "The blockchain on which to filter the results" }, { "name": "address", "value": "0x8ba1f109551bD432803012645Hac136c94C19D6e", "type": "path", "description": "The unique public blockchain identifier for the contract" }, { "name": "identifier", "value": "1", "type": "path", "description": "The NFT token id" } ] }, "docs": "Get the collection that an NFT belongs to. This is useful for multi-contract collections like Art Blocks where the item ID disambiguates which collection the NFT belongs to." } ] } ], "bundled": true }