← Tools Reference

Scrapfly

Scrapfly integration (Developer Tools, Data). Imported from open-connector.

API key2 toolshttps://api.scrapfly.io
GET
scrapfly_scrape
Scrape one public URL through Scrapfly and return the documented JSON response envelope.

/scrape

21 parameters
ParamTypeRequiredDescription
urlstringrequiredThe public URL Scrapfly should scrape.
methodstringoptionalThe HTTP method Scrapfly should use against the target URL.
bodystringoptionalThe raw request body Scrapfly should send to the target URL.
content_typestringoptionalThe Content-Type header for the target request body.
formatstringoptionalThe content format Scrapfly should return.
countrystringoptionalThe proxy country selection accepted by Scrapfly, such as us, us,ca,mx, or -gb.
proxy_poolstringoptionalThe Scrapfly proxy pool to use for the scrape.
render_jsbooleanoptionalWhether Scrapfly should render JavaScript before returning.
aspbooleanoptionalWhether Scrapfly should enable Anti Scraping Protection.
retrybooleanoptionalWhether Scrapfly should retry the scrape request.
timeoutintegeroptionalThe scrape timeout in milliseconds.
wait_for_selectorstringoptionalThe CSS selector Scrapfly should wait for before returning content.
cachebooleanoptionalWhether Scrapfly should use cached scrape results when available.
cache_ttlintegeroptionalThe cache time-to-live in seconds.
cache_clearbooleanoptionalWhether Scrapfly should clear any matching cached result.
sessionstringoptionalThe Scrapfly session name used to keep browsing state.
session_sticky_proxybooleanoptionalWhether Scrapfly should keep the session proxy sticky.
headersobjectoptionalTarget request headers Scrapfly should send to the scraped website.
tagsarrayoptionalTags for grouping the scrape in Scrapfly monitoring.
correlation_idstringoptionalA caller-provided correlation identifier for monitoring.
debugbooleanoptionalWhether Scrapfly should expose debug data for the scrape.
GET
scrapfly_get_monitoring_metrics
Retrieve Scrapfly monitoring metrics for the connected API key.

/scrape/monitoring/metrics

5 parameters
ParamTypeRequiredDescription
aggregationstringoptionalThe metrics aggregation list accepted by Scrapfly, such as account, project, or…
periodstringoptionalThe monitoring period to retrieve.
startstringoptionalThe UTC start date accepted by Scrapfly when period is omitted.
endstringoptionalThe UTC end date accepted by Scrapfly when period is omitted.
group_subdomainbooleanoptionalWhether target aggregation should group subdomains.