Struct Client 

pub struct Client { /* private fields */ }

Scrapfly API client. Cheap to Clone (the inner reqwest::Client is Arc’d so all clones share one connection pool).

Implementations

impl Client

pub fn builder() -> ClientBuilder

Start a new ClientBuilder.

pub fn api_key(&self) -> &str

Return the configured API key.

pub fn host(&self) -> &str

Return the configured API host.

pub fn cloud_browser_host(&self) -> &str

Return the configured Cloud Browser host.

pub async fn verify_api_key(&self) -> Result<VerifyApiKeyResult, ScrapflyError>

Verify the API key by hitting /account.

pub async fn account(&self) -> Result<AccountData, ScrapflyError>

Fetch account info.

pub async fn classify( &self, req: &ClassifyRequest, ) -> Result<ClassifyResult, ScrapflyError>

Classify an already-fetched HTTP response for anti-bot blocking.

Runs the same detection pipeline used by every live Scrapfly scrape against a response you already have (from your own proxy, cache, etc). 1 API credit per successful call. See https://scrapfly.io/docs/scrape-api/classify.

pub async fn get_monitoring_metrics( &self, opts: &MonitoringMetricsOptions, ) -> Result<Value, ScrapflyError>

Fetch aggregate monitoring metrics for the Web Scraping API.

pub async fn get_monitoring_target_metrics( &self, opts: &MonitoringTargetMetricsOptions, ) -> Result<Value, ScrapflyError>

Fetch per-target monitoring metrics for the Web Scraping API.

pub async fn get_screenshot_monitoring_metrics( &self, opts: &MonitoringMetricsOptions, ) -> Result<Value, ScrapflyError>

Fetch aggregate monitoring metrics for the Screenshot API.

pub async fn get_screenshot_monitoring_target_metrics( &self, opts: &MonitoringTargetMetricsOptions, ) -> Result<Value, ScrapflyError>

Fetch per-target monitoring metrics for the Screenshot API.

pub async fn get_extraction_monitoring_metrics( &self, opts: &MonitoringMetricsOptions, ) -> Result<Value, ScrapflyError>

Fetch aggregate monitoring metrics for the Extraction API.

pub async fn get_extraction_monitoring_target_metrics( &self, opts: &MonitoringTargetMetricsOptions, ) -> Result<Value, ScrapflyError>

Fetch per-target monitoring metrics for the Extraction API.

pub async fn get_crawler_monitoring_metrics( &self, opts: &MonitoringMetricsOptions, ) -> Result<Value, ScrapflyError>

Fetch aggregate monitoring metrics for the Crawler API.

pub async fn get_crawler_monitoring_target_metrics( &self, opts: &MonitoringTargetMetricsOptions, ) -> Result<Value, ScrapflyError>

Fetch per-target monitoring metrics for the Crawler API.

pub async fn get_browser_monitoring_metrics( &self, opts: &CloudBrowserMonitoringOptions, ) -> Result<Value, ScrapflyError>

Fetch aggregate monitoring metrics for the Cloud Browser API.

pub async fn get_browser_monitoring_timeseries( &self, opts: &CloudBrowserMonitoringOptions, ) -> Result<Value, ScrapflyError>

Fetch monitoring time-series for the Cloud Browser API.

pub async fn scrape( &self, config: &ScrapeConfig, ) -> Result<ScrapeResult, ScrapflyError>

Scrape a URL.

pub fn concurrent_scrape<'a, I>( &'a self, configs: I, concurrency_limit: usize, ) -> impl Stream<Item = Result<ScrapeResult, ScrapflyError>> + 'a

where I: IntoIterator<Item = ScrapeConfig> + 'a, <I as IntoIterator>::IntoIter: 'a,

Concurrent-scrape stream. Emits results in completion order.

pub async fn scrape_batch( &self, configs: &[ScrapeConfig], ) -> Result<impl Stream<Item = (String, BatchOutcome)>, ScrapflyError>

POST /scrape/batch: scrape up to 100 URLs and stream results back as each scrape completes. Returns an async stream where each item is (correlation_id, Result<ScrapeResult, ScrapflyError>).

Results arrive OUT OF ORDER — whichever scrape finishes first is yielded first. Every ScrapeConfig MUST carry a unique correlation_id; missing / duplicate values are caught client-side before the request is sent.

Batch-level failures (plan gate, insufficient concurrency, validation) surface as the outer Err(ScrapflyError) returned from the await — the stream is only created after the batch request succeeds.

pub async fn scrape_batch_with_options( &self, configs: &[ScrapeConfig], opts: BatchOptions, ) -> Result<impl Stream<Item = (String, BatchOutcome)>, ScrapflyError>

Like scrape_batch but with explicit BatchOptions (msgpack wire format, etc.).

pub async fn scrape_proxified( &self, config: &ScrapeConfig, ) -> Result<Response, ScrapflyError>

Scrape a URL with proxified_response=true, returning the raw upstream reqwest::Response (target’s status, headers, body).

Unlike [scrape()], no JSON parsing occurs — the response body is the target page’s raw content. Scrapfly metadata is available on the X-Scrapfly-* response headers (Api-Cost, Content-Format, Log, etc.).

Automatically forces proxified_response=true regardless of the config’s field value.

pub async fn screenshot( &self, config: &ScreenshotConfig, ) -> Result<ScreenshotResult, ScrapflyError>

Screenshot a URL.

pub async fn extract( &self, config: &ExtractionConfig, ) -> Result<ExtractionResult, ScrapflyError>

Run AI extraction on a document.

pub async fn start_crawl( &self, config: &CrawlerConfig, ) -> Result<CrawlerStartResponse, ScrapflyError>

Schedule a new crawler job.

pub async fn crawl_status( &self, uuid: &str, ) -> Result<CrawlerStatus, ScrapflyError>

Fetch crawler status.

pub async fn crawl_urls( &self, uuid: &str, status_filter: Option<&str>, page: u32, per_page: u32, ) -> Result<CrawlerUrls, ScrapflyError>

List crawled URLs (streaming text endpoint).

pub async fn crawl_contents_json( &self, uuid: &str, format: CrawlerContentFormat, limit: Option<u32>, offset: Option<u32>, ) -> Result<CrawlerContents, ScrapflyError>

Bulk GET /crawl/{uuid}/contents in JSON mode.

pub async fn crawl_contents_plain( &self, uuid: &str, target_url: &str, format: CrawlerContentFormat, ) -> Result<String, ScrapflyError>

Plain single-URL GET /crawl/{uuid}/contents?plain=true.

pub async fn crawl_contents_batch( &self, uuid: &str, urls: &[String], formats: &[CrawlerContentFormat], ) -> Result<BTreeMap<String, BTreeMap<String, String>>, ScrapflyError>

Bulk-batch POST /crawl/{uuid}/contents/batch. Returns url → format → content (multipart/related response).

pub async fn crawl_cancel(&self, uuid: &str) -> Result<(), ScrapflyError>

Cancel a crawler job.

pub async fn crawl_artifact( &self, uuid: &str, artifact_type: CrawlerArtifactType, ) -> Result<CrawlerArtifact, ScrapflyError>

Download a crawler artifact (WARC or HAR).

impl Client

pub fn cloud_browser_url(&self, config: &BrowserConfig) -> String

Build the WebSocket URL for a new Cloud Browser session.

pub async fn cloud_browser_unblock( &self, config: &UnblockConfig, ) -> Result<UnblockResult, ScrapflyError>

Call POST /unblock to bypass anti-bot protection.

pub async fn cloud_browser_extension_list(&self) -> Result<Value, ScrapflyError>

List browser extensions for the account.

pub async fn cloud_browser_extension_get( &self, extension_id: &str, ) -> Result<Value, ScrapflyError>

Get details of a specific browser extension.

pub async fn cloud_browser_extension_upload( &self, file_path: &Path, ) -> Result<Value, ScrapflyError>

Upload a browser extension from a local file (.zip or .crx).

pub async fn cloud_browser_extension_delete( &self, extension_id: &str, ) -> Result<Value, ScrapflyError>

Delete a browser extension by ID.

pub async fn cloud_browser_playback( &self, run_id: &str, ) -> Result<Value, ScrapflyError>

Get debug recording playback metadata for a run.

pub async fn cloud_browser_session_stop( &self, session_id: &str, ) -> Result<(), ScrapflyError>

Terminate a Cloud Browser session.

pub async fn cloud_browser_sessions(&self) -> Result<Value, ScrapflyError>

List all running Cloud Browser sessions.

pub async fn cloud_browser_video( &self, run_id: &str, ) -> Result<Vec<u8>, ScrapflyError>

Download a debug session recording video (raw bytes).

impl Client

pub async fn create_scrape_schedule( &self, scrape_config: HashMap<String, Value>, request: &CreateScheduleRequest, ) -> Result<Schedule, ScrapflyError>

Create a Web Scraping API schedule.

pub async fn create_screenshot_schedule( &self, screenshot_config: HashMap<String, Value>, request: &CreateScheduleRequest, ) -> Result<Schedule, ScrapflyError>

Create a Screenshot API schedule.

pub async fn create_crawler_schedule( &self, crawler_config: HashMap<String, Value>, request: &CreateScheduleRequest, ) -> Result<Schedule, ScrapflyError>

Create a Crawler API schedule.

pub async fn get_schedule(&self, id: &str) -> Result<Schedule, ScrapflyError>

Return a schedule by id (works across all kinds).

pub async fn list_schedules( &self, opts: Option<&ListSchedulesOptions>, ) -> Result<Vec<Schedule>, ScrapflyError>

List every schedule on the account, optionally filtered by kind/status.

pub async fn list_scrape_schedules( &self, status: Option<&str>, ) -> Result<Vec<Schedule>, ScrapflyError>

List scrape schedules, optionally filtered by status.

pub async fn list_screenshot_schedules( &self, status: Option<&str>, ) -> Result<Vec<Schedule>, ScrapflyError>

List screenshot schedules, optionally filtered by status.

pub async fn list_crawler_schedules( &self, status: Option<&str>, ) -> Result<Vec<Schedule>, ScrapflyError>

List crawler schedules, optionally filtered by status.

pub async fn update_schedule( &self, id: &str, request: &UpdateScheduleRequest, ) -> Result<Schedule, ScrapflyError>

Patch an active schedule. Only fields set in request change.

pub async fn cancel_schedule(&self, id: &str) -> Result<(), ScrapflyError>

Cancel a schedule. Cancellation is terminal (returns no body).

pub async fn pause_schedule(&self, id: &str) -> Result<Schedule, ScrapflyError>

Pause an active schedule. Idempotent on already-paused schedules.

pub async fn resume_schedule(&self, id: &str) -> Result<Schedule, ScrapflyError>

Resume a paused schedule. Idempotent on already-active schedules.

pub async fn execute_schedule( &self, id: &str, ) -> Result<Schedule, ScrapflyError>

Fire a schedule immediately, regardless of next_scheduled_date.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.