Get best listings by collection
Changed onGet the best listings for a collection sorted by price ascending. Optionally filter by item traits using the 'traits' query parameter with a JSON array of trait filters. Multiple traits are AND-combined (items must match all). Note: results are not deduplicated by token ID — if a token has multiple listings, each listing is returned individually. Filter client-side if you need unique tokens. Example: ?traits=[{"traitType":"Background","value":"Red"}]
Request
- Base URLhttps://api.opensea.io
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Unique string to identify a collection on OpenSea
Query parameters
Whether to include private listings; defaults to false
JSON array of trait filters to narrow listings by item traits. Each object has 'traitType' and 'value' fields. Multiple traits are AND-combined (items must match all). Example: [{"traitType":"Background","value":"Red"}]
Number of items to return per page
Response
OK
Example response
{
"listings": [
{
"svm_order": {
"id": "5j7s1QzqC8sT4Kz1oB9dYnUZ4qHnKX6h9YmZ6Zt7Zb3Q:CvhyBLWDcNwMatkNvMYuHALvbG1NzYrGw32dGzREaQKc"
}
}
]
}Changes
- breaking
the response property
///became nullable for the status - breaking
the response property
////became nullable for the status - breaking
the response property
became nullable for the status - breaking
the
///response's property type changed fromobjectto no type for status - breaking
removed the required property
////from the response with the status - warning
removed the optional property
////from the response with the status - info
added the media type
*/*for the response with the status - info
added the media type
*/*for the response with the status - info
added the non-success response with the status
- info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
///to the response with the status - info
added the optional property
///to the response with the status - info
added
subschema #2to the///response propertyanyOflist for the response status
- breaking