Get a livestream

Try in Playground

Read one show by UUID or /live/ URL: status, viewers, times, poster, categories, tags and seller.

GET/v1/whatnot/livestreamx-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

idstringquery

Livestream UUID. Exactly one of id or url.

Example00000000-0000-4000-8000-000000000123

urlstringquery

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

min 1 chars · max 2048 chars

Response fields

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.

Livestream record.

livestream.idstring

Livestream UUID.

livestream.urlstring

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

absolute HTTPS URL

livestream.titlestringnullable

Show title.

livestream.statusstringnullable

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

livestream.activeViewersintegernullable

Current viewers.

livestream.startTimestringnullable

Scheduled or actual start, ISO 8601 UTC.

livestream.endTimestringnullable

End time when ended.

Poster image renditions.

livestream.thumbnail.idstringnullable

Always included.

livestream.thumbnail.smallImagestringnullable

Always included.

livestream.thumbnail.biggerImagestringnullable

Always included.

livestream.thumbnail.fullSizeImagestringnullable

Always included.

livestream.trailerUrlstringnullable

Trailer video URL when set.

Category tags (id, label, deeplink).

up to 50 items

livestream.categories.idstring

Always included.

livestream.categories.labelstringnullable

Always included.

livestream.categories.deeplinkstringnullable

Always included.

Show-style tags.

up to 50 items

livestream.tags.idstring

Always included.

livestream.tags.labelstringnullable

Always included.

livestream.labelsstring[]nullable

Source labels.

livestream.isFreeShippingEnabledbooleannullable

Free-shipping flag.

livestream.isHiddenBySellerbooleannullable

Hidden by the seller.

livestream.totalWatchlistUsersintegernullable

Users who bookmarked the show.

Seller summary.

livestream.user.idstring

Always included.

livestream.user.userIdstringnullable

Always included.

livestream.user.usernamestring

Always included.

livestream.user.displayNamestringnullable

Always included.

livestream.user.profileImage.idstringnullable

Always included.

livestream.user.profileImage.urlstringnullable

Always included.

livestream.user.isLivebooleannullable

Always included.

livestream.user.isVerifiedSellerbooleannullable

Always included.

livestream.user.followerCountintegernullable

Always included.

livestream.user.soldCountintegernullable

Always included.

livestream.user.ratingnumbernullable

Always included.

livestream.user.numReviewsintegernullable

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

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/livestream?id=00000000-0000-4000-8000-000000000123" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/whatnot/livestream?id=00000000-0000-4000-8000-000000000123",
  {
    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/livestream?id=00000000-0000-4000-8000-000000000123",
  {
    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/livestream",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "id": "00000000-0000-4000-8000-000000000123"
    },
    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/livestream?id=00000000-0000-4000-8000-000000000123", 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/livestream?id=00000000-0000-4000-8000-000000000123"))
            .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",
  "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
    }
  },
  "sourceUrl": "https://www.whatnot.com/live/00000000-0000-4000-8000-000000000123",
  "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."
  }
}