New to Corsair? See API access, authentication, and error handling.
Account
get
account.get
Get the subscription account and token usage
Risk: read
data full type
data full type
Analytics
proxyBandwidth
analytics.proxyBandwidth
Get proxy bandwidth usage for the account
Risk: read
Output:
object[]
Output full type
Output full type
statuses
analytics.statuses
Get per-domain request status analytics
Risk: read
Output
data full type
data full type
Results
get
results.get
Get a scrape result by id
Risk: read
Output
data full type
data full type
list
results.list
List scrape results with pagination and filters
Risk: read
filters full type
filters full type
data full type
data full type
meta full type
meta full type
Scrape
fetch
scrape.fetch
Fetch a page and return its rendered HTML
Risk: read
Output:
string
json
scrape.json
Scrape a page and extract structured JSON with an agent
Risk: read
Output
residential_proxy_usage full type
residential_proxy_usage full type
listing
scrape.listing
Scrape paginated listing pages and extract their items
Risk: read
Output
residential_proxy_usage full type
residential_proxy_usage full type
markdown
scrape.markdown
Scrape a page and return its content as Markdown
Risk: read
Output
residential_proxy_usage full type
residential_proxy_usage full type
screenshot
scrape.screenshot
Scrape a page and capture a screenshot
Risk: read
Output
residential_proxy_usage full type
residential_proxy_usage full type
sitemap
scrape.sitemap
Discover a site sitemap and map its URLs
Risk: read
Output
residential_proxy_usage full type
residential_proxy_usage full type
Scrapers
aiInit
scrapers.aiInit
Start an AI scraper chat and return starter scrape code
Risk: write
Output
data full type
data full type
aiRerun
scrapers.aiRerun
Re-run an AI scraper against a URL
Risk: write
Output
data full type
data full type
aiRerunBulk
scrapers.aiRerunBulk
Re-run an AI scraper against multiple URLs
Risk: write
Output
data full type
data full type
cancelBulkByResult
scrapers.cancelBulkByResult
Cancel a queued bulk run by its result id
Risk: write
Output
data full type
data full type
cancelBulkByScraper
scrapers.cancelBulkByScraper
Cancel every queued bulk URL for a scraper
Risk: write
Output
data full type
data full type
manualHeal
scrapers.manualHeal
Heal a broken manual scraper workflow
Risk: write
Output
data full type
data full type
manualRerun
scrapers.manualRerun
Re-run a manual scraper against a URL
Risk: write
paginator full type
paginator full type
data full type
data full type
manualRerunBulk
scrapers.manualRerunBulk
Re-run a manual scraper against multiple URLs
Risk: write
Output
data full type
data full type