Docs / Core

Catalog

client.catalog reads the public scraper catalog — no auth required, served outside /v1:

MethodREST endpointReturns
list({ q?, cat?, cursor?, limit? })GET /api/scrapers/listCursor-paginated { items, nextCursor, total }.
get(slug)GET /api/scrapers/{slug}Full scraper detail.
categories()GET /api/public/categoriesAll catalog categories.
schema(slug, endpoint)GET /api/public/scrapers/{slug}/endpoints/{endpoint}/schemaEndpoint field schema { fields }.
stats(slug)GET /api/public/scrapers/{slug}/stats{ requests, successRate }.

list({ q?, cat?, cursor?, limit? })

REST endpoint: GET /api/scrapers/list

Returns: Cursor-paginated { items, nextCursor, total }.

get(slug)

REST endpoint: GET /api/scrapers/{slug}

Returns: Full scraper detail.

categories()

REST endpoint: GET /api/public/categories

Returns: All catalog categories.

schema(slug, endpoint)

REST endpoint: GET /api/public/scrapers/{slug}/endpoints/{endpoint}/schema

Returns: Endpoint field schema { fields }.

stats(slug)

REST endpoint: GET /api/public/scrapers/{slug}/stats

Returns: { requests, successRate }.

catalog.ts
const { items } = await client.catalog.list({ cat: "social", limit: 20 });const detail = await client.catalog.get("social:instagram");const schema = await client.catalog.schema("social:instagram", "profile");
const { items } = await client.catalog.list({ cat: "social", limit: 20 });const detail = await client.catalog.get("social:instagram");const schema = await client.catalog.schema("social:instagram", "profile");
Edit this page on GitHubWas this page helpful? ·