SDK ReferencePython SDK

Scrape Bulk

API functions for the Scrape Bulk resource.

Scrape Bulk

Functions for interacting with the scrape_bulk API resource. Each operation ships in four forms — sync / sync_detailed and their async counterparts.

Create Scrape Bulk

Bulk scrape URLs

Enqueues multiple URLs for scraping. Results delivered via webhook. Webhook deliveries include X-ByteKit-Event: scrape.completed or X-ByteKit-Event: scrape.failed so receivers can dispatch on the header without parsing the body shape.

Parameters

  • body (CreateScrapeBulkBody)

Call styles

sync_detailed(client=client, body=body) -> Response[Union[CreateScrapeBulkResponse202, Error]]
sync(client=client, body=body) -> Optional[Union[CreateScrapeBulkResponse202, Error]]
await asyncio_detailed(client=client, body=body) -> Response[Union[CreateScrapeBulkResponse202, Error]]
await asyncio(client=client, body=body) -> Optional[Union[CreateScrapeBulkResponse202, Error]]

Get Scrape Bulk

Get scrape bulk job status

Parameters

  • id (str)

Call styles

sync_detailed(id=id, client=client) -> Response[Union[Error, GetScrapeBulkResponse200]]
sync(id=id, client=client) -> Optional[Union[Error, GetScrapeBulkResponse200]]
await asyncio_detailed(id=id, client=client) -> Response[Union[Error, GetScrapeBulkResponse200]]
await asyncio(id=id, client=client) -> Optional[Union[Error, GetScrapeBulkResponse200]]