Get filter facets for a collection group
Changed onGet the values of each normalized attribute in a collection group with the number of matching NFTs. Each facet is narrowed by the filters of the other types, so a facet keeps listing all of its own values.
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
Collection group
Query parameters
Facet types to return. Defaults to all: franchise, grader, grade, subject, year, set, language, edition, product_type
Restrict results to these collections in the group (max 10). Defaults to the whole group.
Only return NFTs whose normalized franchise is one of these values, as returned by the facets endpoint. Repeat the parameter to match any of several values.
Only return NFTs whose normalized grader is one of these values, as returned by the facets endpoint. Repeat the parameter to match any of several values.
Only return NFTs whose normalized grade is one of these values, as returned by the facets endpoint. Repeat the parameter to match any of several values.
Only return NFTs whose normalized subject is one of these values, as returned by the facets endpoint. Repeat the parameter to match any of several values.
Only return NFTs whose normalized year is one of these values, as returned by the facets endpoint. Repeat the parameter to match any of several values.
Only return NFTs whose normalized set is one of these values, as returned by the facets endpoint. Repeat the parameter to match any of several values.
Only return NFTs whose normalized language is one of these values, as returned by the facets endpoint. Repeat the parameter to match any of several values.
Only return NFTs whose normalized edition is one of these values, as returned by the facets endpoint. Repeat the parameter to match any of several values.
Only return NFTs whose normalized product type is one of these values, as returned by the facets endpoint. Repeat the parameter to match any of several values.
Response
OK
Example response
{
"facets": [
{
"type": "grader"
}
]
}Changes
- info
endpoint added
- info