Skip to content
scrapeatlas.Dashboard

List categories and tags

Try in Playground

List the category tree (with subcategories) and the browse tags with live viewer counts; sort=viewers returns the tags in trending order.

GET/v1/whatnot/categoriesx-api-key
x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters
1
sortenumdefault: "source"query

source (default) keeps the site's order; viewers orders tags by live viewer count (the trending view).

one of: source, viewers · default: "source"

Response fields
34
requestIdstring

Random operational correlation ID.

Upstream GraphQL requests, response bytes and elapsed milliseconds.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

True when usable public data was retrieved.

statusenum

success, partial, failed or challenged. Inspect coverage even for HTTP 200.

one of: success, partial

sourceUrlstring

Public www.whatnot.com URL the data belongs to.

absolute HTTPS URL

fetchedAtstring

UTC retrieval timestamp.

Complete means this bounded page had no known omissions; warnings name each omission.

coverage.sourcestring

Always public_api (Whatnot's public web GraphQL endpoint).

coverage.completeboolean

False when any warning is present.

coverage.warningsstring[]

Machine-readable omission codes such as sections_skipped or record_limit.

Top-level categories with subcategories.

up to 500 items

categories.idstring

Category node id.

categories.typestringnullable

Category slug.

categories.labelstringnullable

Display label.

categories.parentIdstringnullable

Parent category id.

Category image.

categories.image.idstringnullable

Always included.

categories.image.urlstringnullable

Always included.

Child categories (id, type, label).

up to 200 items

categories.subcategories.idstring

Always included.

categories.subcategories.typestringnullable

Always included.

categories.subcategories.labelstringnullable

Always included.

Livestream tags ordered as the site lists them.

up to 500 items

tags.idstring

Tag node id.

tags.namestringnullable

Tag slug used in /tag/{name} URLs.

tags.labelstringnullable

Display label.

tags.deeplinkstringnullable

Site deeplink.

tags.viewerCountintegernullable

Current viewers across the tag.

Tag image.

tags.image.idstringnullable

Always included.

tags.image.urlstringnullable

Always included.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes
9
HTTPfailure.codeMeaning
400invalid_requestMissing, duplicate, unsupported or invalid parameters, or more than one selector.
401unauthorizedMissing or invalid service key.
404not_foundUnknown user, livestream, listing or tag.
429upstream_rate_limitedWhatnot rate limited the request; no automatic retry.
502upstream_challengedCloudflare challenge or HTTP 403/503 from Whatnot.
502unsupported_page unsafe_redirect response_too_large payload_too_complex request_limit upstream_errorBounded retrieval failed or the GraphQL response no longer matches the expected schema.
503busyAll worker slots occupied.
504timeoutDeadline exceeded.
200partialCoverage warnings such as sections_skipped or record_limit.