Get a category feed

Try in Playground

Read category metadata, live and upcoming shows, listings and suggested refinement tags together, with cursor pagination.

GET/v1/whatnot/categoryx-api-key

Headers

Get your API key

x-api-keystringrequiredheader

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

Query parameters

namestringquery

Tag slug from /tag/{name}. Exactly one of name or url.

Examplepokemon_cards

urlstringquery

Public https://www.whatnot.com/tag/{name} URL.

min 1 chars · max 2048 chars

cursorstringquery

pagination.cursor from the previous response to continue.

Response fields

175

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.

Tag record.

tag.idstring

Tag node id.

tag.namestringnullable

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

tag.labelstringnullable

Display label.

tag.deeplinkstringnullable

Site deeplink.

tag.viewerCountintegernullable

Current viewers across the tag.

Tag image.

tag.image.idstringnullable

Always included.

tag.image.urlstringnullable

Always included.

Refinement tags suggested for this feed.

up to 100 items

suggestedTags.idstring

Tag node id.

suggestedTags.namestringnullable

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

suggestedTags.labelstringnullable

Display label.

suggestedTags.deeplinkstringnullable

Site deeplink.

suggestedTags.viewerCountintegernullable

Current viewers across the tag.

Tag image.

suggestedTags.image.idstringnullable

Always included.

suggestedTags.image.urlstringnullable

Always included.

Typed records: listing, livestream, product, user, category or tag.

up to 100 items

items.typestring

Record type discriminator.

Listing record (type=listing).

items.listing.idstring

Relay listing id.

items.listing.urlstring

Public https://www.whatnot.com/listing/{id} URL.

absolute HTTPS URL

items.listing.titlestringnullable

Title.

items.listing.subtitlestringnullable

Condition/subtitle line.

items.listing.descriptionstringnullable

Description.

Buy-now price in major units with ISO currency.

items.listing.price.amountnumbernullable

Always included.

items.listing.price.currencystringnullable

Always included.

items.listing.transactionTypestringnullable

BUY_IT_NOW, ASYNC_AUCTION or other source types.

items.listing.statusstringnullable

Public status such as ACTIVE or SOLD.

items.listing.quantityintegernullable

Quantity available.

items.listing.isLivebooleannullable

Whether it is featured in a live show now.

Current bid for auctions.

items.listing.currentBid.amountnumbernullable

Always included.

items.listing.currentBid.currencystringnullable

Always included.

items.listing.currentBidCountintegernullable

Bids so far.

Auction state: current price, bid count, end time.

Always included.

items.listing.auction.currentPrice.amountnumbernullable

Always included.

items.listing.auction.currentPrice.currencystringnullable

Always included.

items.listing.auction.bidCountintegernullable

Always included.

items.listing.auction.endTimestringnullable

Always included.

items.listing.totalBookmarksintegernullable

Bookmarks.

items.listing.labelsstring[]nullable

Source labels.

Image ids, URLs and labels.

up to 50 items

items.listing.images.idstringnullable

Always included.

items.listing.images.urlstringnullable

Always included.

items.listing.images.labelstringnullable

Always included.

Linked catalog product and price range when present.

items.listing.product.idstring

Always included.

items.listing.product.namestringnullable

Always included.

items.listing.product.priceRange.minobjectnullable

Always included.

items.listing.product.priceRange.maxobjectnullable

Always included.

items.listing.createdAtstringnullable

Created, ISO 8601 UTC.

items.listing.updatedAtstringnullable

Updated, ISO 8601 UTC.

Seller summary.

items.listing.user.idstring

Always included.

items.listing.user.userIdstringnullable

Always included.

items.listing.user.usernamestring

Always included.

items.listing.user.displayNamestringnullable

Always included.

items.listing.user.profileImage.idstringnullable

Always included.

items.listing.user.profileImage.urlstringnullable

Always included.

items.listing.user.isLivebooleannullable

Always included.

items.listing.user.isVerifiedSellerbooleannullable

Always included.

items.listing.user.followerCountintegernullable

Always included.

items.listing.user.soldCountintegernullable

Always included.

items.listing.user.ratingnumbernullable

Always included.

items.listing.user.numReviewsintegernullable

Always included.

Livestream record (type=livestream).

items.livestream.idstring

Livestream UUID.

items.livestream.urlstring

Public https://www.whatnot.com/live/{id} URL.

absolute HTTPS URL

items.livestream.titlestringnullable

Show title.

items.livestream.statusstringnullable

CREATED (scheduled), PLAYING (live) or ENDED.

items.livestream.activeViewersintegernullable

Current viewers.

items.livestream.startTimestringnullable

Scheduled or actual start, ISO 8601 UTC.

items.livestream.endTimestringnullable

End time when ended.

Poster image renditions.

items.livestream.thumbnail.idstringnullable

Always included.

items.livestream.thumbnail.smallImagestringnullable

Always included.

items.livestream.thumbnail.biggerImagestringnullable

Always included.

items.livestream.thumbnail.fullSizeImagestringnullable

Always included.

items.livestream.trailerUrlstringnullable

Trailer video URL when set.

Category tags (id, label, deeplink).

up to 50 items

items.livestream.categories.idstring

Always included.

items.livestream.categories.labelstringnullable

Always included.

items.livestream.categories.deeplinkstringnullable

Always included.

Show-style tags.

up to 50 items

items.livestream.tags.idstring

Always included.

items.livestream.tags.labelstringnullable

Always included.

items.livestream.labelsstring[]nullable

Source labels.

items.livestream.isFreeShippingEnabledbooleannullable

Free-shipping flag.

items.livestream.isHiddenBySellerbooleannullable

Hidden by the seller.

items.livestream.totalWatchlistUsersintegernullable

Users who bookmarked the show.

Seller summary.

items.livestream.user.idstring

Always included.

items.livestream.user.userIdstringnullable

Always included.

items.livestream.user.usernamestring

Always included.

items.livestream.user.displayNamestringnullable

Always included.

items.livestream.user.profileImage.idstringnullable

Always included.

items.livestream.user.profileImage.urlstringnullable

Always included.

items.livestream.user.isLivebooleannullable

Always included.

items.livestream.user.isVerifiedSellerbooleannullable

Always included.

items.livestream.user.followerCountintegernullable

Always included.

items.livestream.user.soldCountintegernullable

Always included.

items.livestream.user.ratingnumbernullable

Always included.

items.livestream.user.numReviewsintegernullable

Always included.

Catalog product (type=product).

items.product.idstring

Product node id.

items.product.namestringnullable

Catalog product name.

Image.

items.product.image.idstringnullable

Always included.

items.product.image.urlstringnullable

Always included.

Lowest listing price.

items.product.listingPrice.amountnumbernullable

Always included.

items.product.listingPrice.currencystringnullable

Always included.

Last sale price.

items.product.lastSalePrice.amountnumbernullable

Always included.

items.product.lastSalePrice.currencystringnullable

Always included.

items.product.numListingsintegernullable

Active listings.

User summary (type=user).

items.user.idstring

Relay node id.

items.user.userIdstringnullable

Numeric user id decoded from the node id.

items.user.usernamestring

Username.

items.user.displayNamestringnullable

Display name.

Profile image id and URL.

items.user.profileImage.idstringnullable

Always included.

items.user.profileImage.urlstringnullable

Always included.

items.user.isLivebooleannullable

Whether the seller is live now.

items.user.isVerifiedSellerbooleannullable

Verified-seller badge.

items.user.followerCountintegernullable

Followers.

items.user.soldCountintegernullable

Items sold.

items.user.ratingnumbernullable

Average seller rating out of 5.

items.user.numReviewsintegernullable

Number of seller reviews.

Category (type=category).

items.category.idstring

Category node id.

items.category.typestringnullable

Category slug.

items.category.labelstringnullable

Display label.

items.category.parentIdstringnullable

Parent category id.

Category image.

items.category.image.idstringnullable

Always included.

items.category.image.urlstringnullable

Always included.

Child categories (id, type, label).

up to 200 items

items.category.subcategories.idstring

Always included.

items.category.subcategories.typestringnullable

Always included.

items.category.subcategories.labelstringnullable

Always included.

Livestream tag (type=tag).

items.tag.idstring

Tag node id.

items.tag.namestringnullable

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

items.tag.labelstringnullable

Display label.

items.tag.deeplinkstringnullable

Site deeplink.

items.tag.viewerCountintegernullable

Current viewers across the tag.

Tag image.

items.tag.image.idstringnullable

Always included.

items.tag.image.urlstringnullable

Always included.

Relay-style continuation state.

pagination.cursorstringnullable

Opaque cursor for the next page, or null on the last page.

pagination.hasMoreboolean

Whether another page exists.

pagination.totalCountintegernullable

Total records the source reports, when known.

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

HTTP	failure.code	Meaning
400	`invalid_request`	Missing, duplicate, unsupported or invalid parameters, or more than one selector.
401	`unauthorized`	Missing or invalid service key.
404	`not_found`	Unknown user, livestream, listing or tag.
429	`upstream_rate_limited`	Whatnot rate limited the request; no automatic retry.
502	`upstream_challenged`	Cloudflare challenge or HTTP 403/503 from Whatnot.
502	`unsupported_page` `unsafe_redirect` `response_too_large` `payload_too_complex` `request_limit` `upstream_error`	Bounded retrieval failed or the GraphQL response no longer matches the expected schema.
503	`busy`	All worker slots occupied.
504	`timeout`	Deadline exceeded.
200	`partial`	Coverage warnings such as sections_skipped or record_limit.

Code example

curl "https://api.scrapeatlas.com/v1/whatnot/category?name=pokemon_cards" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/whatnot/category?name=pokemon_cards",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

const data = await response.json();
console.log(data.status, data);

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/whatnot/category?name=pokemon_cards",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Whatnot request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/whatnot/category",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "name": "pokemon_cards"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/whatnot/category?name=pokemon_cards", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/whatnot/category?name=pokemon_cards"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "tag": {
    "id": "TGl2ZXN0cmVhbVRhZ05vZGU6OTA3",
    "name": "pokemon_cards",
    "label": "Pokémon Cards",
    "deeplink": "tag/pokemon_cards",
    "viewerCount": 9952,
    "image": {
      "id": "SW1hZ2U6MQ==",
      "url": "https://images.whatnot.com/tag.jpg"
    }
  },
  "suggestedTags": [],
  "items": [
    {
      "type": "livestream",
      "livestream": {
        "id": "00000000-0000-4000-8000-000000000123",
        "url": "https://www.whatnot.com/live/00000000-0000-4000-8000-000000000123",
        "title": "Synthetic show",
        "status": "PLAYING",
        "activeViewers": 125,
        "startTime": "2026-09-11T00:00:00.000Z",
        "endTime": null,
        "thumbnail": {
          "id": "SW1hZ2U6MQ==",
          "smallImage": "https://images.whatnot.com/small.webp",
          "biggerImage": "https://images.whatnot.com/big.webp",
          "fullSizeImage": "https://images.whatnot.com/full.webp"
        },
        "trailerUrl": null,
        "categories": [
          {
            "id": "TGl2ZXN0cmVhbVRhZ05vZGU6OTA3",
            "label": "Pokémon Cards",
            "deeplink": "tag/pokemon_cards"
          }
        ],
        "tags": [
          {
            "id": "TGl2ZXN0cmVhbVRhZ05vZGU6MjI5MA==",
            "label": "$1 Starts"
          }
        ],
        "labels": null,
        "isFreeShippingEnabled": null,
        "isHiddenBySeller": false,
        "totalWatchlistUsers": 1,
        "user": {
          "id": "UHVibGljVXNlck5vZGU6MTIzNDU=",
          "userId": "12345",
          "username": "example_seller",
          "displayName": "Example Seller",
          "profileImage": {
            "id": "1",
            "url": "https://images.whatnot.com/example.jpeg"
          },
          "isLive": false,
          "isVerifiedSeller": true,
          "followerCount": 9074,
          "soldCount": 6178,
          "rating": 5,
          "numReviews": 2588
        }
      }
    }
  ],
  "pagination": {
    "cursor": "YXJyYXljb25uZWN0aW9uOjIz",
    "hasMore": true,
    "totalCount": 120
  },
  "sourceUrl": "https://www.whatnot.com/tag/pokemon_cards",
  "fetchedAt": "2026-09-11T00:00:00.000Z",
  "coverage": {
    "source": "public_api",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 24000,
    "durationMs": 380
  }
}

Missing, duplicate, unsupported or invalid parameters, or more than one selector.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}