# QuantumProxies.io API reference

> QuantumProxies.io API reference: 48 endpoints with parameters, request and response examples in cURL, Python, Node.js and PHP, error codes, rate limits per…

Base URL: https://api.quantumproxies.io/v1. Auth: Authorization: Bearer <key>. Generated from openapi.json v2026-10-07 on 2026-10-07; prices and limits as of 2026-10-07.

## Formats

- [HTML reference](https://quantumproxies.io/docs/): full reference, search, examples in four languages
- [index.md](https://quantumproxies.io/docs/index.md): the whole reference as Markdown
- [openapi.json](https://quantumproxies.io/docs/openapi.json): OpenAPI 3.1.0 with x-codeSamples
- [openapi.yaml](https://quantumproxies.io/docs/openapi.yaml): same spec as YAML
- [curl](https://quantumproxies.io/docs/curl/), [python](https://quantumproxies.io/docs/python/), [node](https://quantumproxies.io/docs/node/), [php](https://quantumproxies.io/docs/php/): the reference with examples in one language

## Guides

- [Authentication](https://quantumproxies.io/docs/#section/Authentication): Every request carries an API key in the Authorization header: Authorization: Bearer qp_live_YOUR_API_KEY.
- [Errors and status codes](https://quantumproxies.io/docs/#section/Errors-and-status-codes): Status codes used by this API and what each one means (collected from every endpoint below).
- [Rate limits and tiers](https://quantumproxies.io/docs/#section/Rate-limits-and-tiers): Limits per tier (live values as of 2026-10-07): - Per API key.
- [Pricing per endpoint](https://quantumproxies.io/docs/#section/Pricing-per-endpoint): Every pay-as-you-go account includes $2 of free usage per month.
- [MCP server](https://quantumproxies.io/docs/#section/MCP-server): The same API is available as an MCP server for Claude, Cursor, ChatGPT and any MCP client.

## Data API

Markdown: https://quantumproxies.io/docs/data-api.md

- [POST /scraper/extract](https://quantumproxies.io/docs/#tag/Scrape/operation/scrapeUrl): Scrape one URL. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#scrape-one-url
- [POST /scraper/serp](https://quantumproxies.io/docs/#tag/Search/operation/searchSerp): Structured search results. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#structured-search-results
- [POST /scraper/serp/bulk](https://quantumproxies.io/docs/#tag/Search/operation/startSerpBulk): Start a multi-page search job. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#start-a-multi-page-search-job
- [GET /scraper/serp/bulk/{jobId}](https://quantumproxies.io/docs/#tag/Search/operation/getSerpBulk): Poll a multi-page search job. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#poll-a-multi-page-search-job
- [DELETE /scraper/serp/bulk/{jobId}](https://quantumproxies.io/docs/#tag/Search/operation/cancelSerpBulk): Cancel a multi-page search job. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#cancel-a-multi-page-search-job
- [POST /scraper/map](https://quantumproxies.io/docs/#tag/Map%20%26%20Crawl/operation/mapSite): Discover a site's URLs. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#discover-a-sites-urls
- [POST /scraper/crawl](https://quantumproxies.io/docs/#tag/Map%20%26%20Crawl/operation/startCrawl): Start a site crawl. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#start-a-site-crawl
- [GET /scraper/crawl/{jobId}](https://quantumproxies.io/docs/#tag/Map%20%26%20Crawl/operation/getCrawl): Poll a crawl job. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#poll-a-crawl-job
- [DELETE /scraper/crawl/{jobId}](https://quantumproxies.io/docs/#tag/Map%20%26%20Crawl/operation/cancelCrawl): Cancel a crawl job. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#cancel-a-crawl-job
- [POST /scraper/batch](https://quantumproxies.io/docs/#tag/Batch/operation/startBatch): Scrape many URLs asynchronously. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#scrape-many-urls-asynchronously
- [GET /scraper/batch/{jobId}](https://quantumproxies.io/docs/#tag/Batch/operation/getBatch): Poll a batch job. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#poll-a-batch-job
- [DELETE /scraper/batch/{jobId}](https://quantumproxies.io/docs/#tag/Batch/operation/cancelBatch): Cancel a batch job. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#cancel-a-batch-job
- [POST /scraper/unlock](https://quantumproxies.io/docs/#tag/Web%20Unlocker/operation/unlockRequest): Replay a request through the Web Unlocker. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#replay-a-request-through-the-web-unlocker
- [GET /scraper/unlock/ca](https://quantumproxies.io/docs/#tag/Web%20Unlocker/operation/downloadUnlockerCa): Download the unlocker CA certificate. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/data-api.md#download-the-unlocker-ca-certificate

## AI

Markdown: https://quantumproxies.io/docs/ai.md

- [POST /scraper/ai](https://quantumproxies.io/docs/#tag/AI%20extraction/operation/aiAgent): Natural-language scraping agent. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/ai.md#natural-language-scraping-agent
- [POST /scraper/places-ai](https://quantumproxies.io/docs/#tag/AI%20extraction/operation/aiPlacesFinder): AI Places Finder. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/ai.md#ai-places-finder
- [POST /scraper/shopping-ai](https://quantumproxies.io/docs/#tag/AI%20extraction/operation/aiShoppingFinder): AI Shopping Finder. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/ai.md#ai-shopping-finder
- [POST /scraper/ai-visibility](https://quantumproxies.io/docs/#tag/AI%20visibility/operation/aiVisibilityAudit): AI visibility audit. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/ai.md#ai-visibility-audit
- [POST /scraper/seo-audit](https://quantumproxies.io/docs/#tag/SEO%20audit/operation/seoAudit): No-JS vs rendered SEO audit. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/ai.md#no-js-vs-rendered-seo-audit

## Collectors & datasets

Markdown: https://quantumproxies.io/docs/collectors-datasets.md

- [GET /scraper/collectors](https://quantumproxies.io/docs/#tag/Collectors/operation/listCollectors): Collector catalog. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#collector-catalog
- [GET /scraper/collectors/{slug}](https://quantumproxies.io/docs/#tag/Collectors/operation/getCollector): One collector. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#one-collector
- [POST /scraper/collectors/{slug}/run](https://quantumproxies.io/docs/#tag/Collectors/operation/runCollector): Run a collector. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#run-a-collector
- [GET /scraper/collectors/runs](https://quantumproxies.io/docs/#tag/Collectors/operation/listCollectorRuns): Your collector runs. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#your-collector-runs
- [GET /scraper/collectors/runs/{runId}](https://quantumproxies.io/docs/#tag/Collectors/operation/getCollectorRun): One run with its rows. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#one-run-with-its-rows
- [GET /scraper/datasets](https://quantumproxies.io/docs/#tag/Datasets/operation/listDatasets): Your recent dataset runs. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#your-recent-dataset-runs
- [POST /scraper/datasets](https://quantumproxies.io/docs/#tag/Datasets/operation/createDataset): Build a dataset from a prompt. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#build-a-dataset-from-a-prompt
- [GET /scraper/datasets/{jobId}](https://quantumproxies.io/docs/#tag/Datasets/operation/getDataset): Poll a dataset job. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#poll-a-dataset-job
- [DELETE /scraper/datasets/{jobId}](https://quantumproxies.io/docs/#tag/Datasets/operation/cancelDataset): Cancel a dataset job. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#cancel-a-dataset-job
- [GET /scraper/datasets/{jobId}/download](https://quantumproxies.io/docs/#tag/Datasets/operation/downloadDataset): Download a dataset file. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#download-a-dataset-file
- [PATCH /scraper/datasets/{jobId}/record](https://quantumproxies.io/docs/#tag/Datasets/operation/renameDataset): Rename a dataset run. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#rename-a-dataset-run
- [DELETE /scraper/datasets/{jobId}/record](https://quantumproxies.io/docs/#tag/Datasets/operation/deleteDatasetRecord): Delete a dataset run's stored record. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#delete-a-dataset-runs-stored-record
- [POST /scraper/parser/generate](https://quantumproxies.io/docs/#tag/Parser%20presets/operation/generateParser): Generate CSS selectors with an LLM, once. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#generate-css-selectors-with-an-llm-once
- [GET /scraper/parser/presets](https://quantumproxies.io/docs/#tag/Parser%20presets/operation/listParserPresets): List your presets. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#list-your-presets
- [POST /scraper/parser/presets](https://quantumproxies.io/docs/#tag/Parser%20presets/operation/createParserPreset): Save a parser as a preset. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#save-a-parser-as-a-preset
- [GET /scraper/parser/presets/{id}](https://quantumproxies.io/docs/#tag/Parser%20presets/operation/getParserPreset): Read a preset. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#read-a-preset
- [PUT /scraper/parser/presets/{id}](https://quantumproxies.io/docs/#tag/Parser%20presets/operation/updateParserPreset): Update a preset. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#update-a-preset
- [DELETE /scraper/parser/presets/{id}](https://quantumproxies.io/docs/#tag/Parser%20presets/operation/deleteParserPreset): Delete a preset. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#delete-a-preset
- [POST /scraper/parser/presets/{id}/heal](https://quantumproxies.io/docs/#tag/Parser%20presets/operation/healParserPreset): Regenerate a preset's parser now. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#regenerate-a-presets-parser-now
- [GET /scraper/parser/presets/{id}/stats](https://quantumproxies.io/docs/#tag/Parser%20presets/operation/getParserPresetStats): How well a preset still works. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/collectors-datasets.md#how-well-a-preset-still-works

## Proxies

Markdown: https://quantumproxies.io/docs/proxies.md

- [GET /public/proxies](https://quantumproxies.io/docs/#tag/Proxies/operation/listProxies): List your proxy plans. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/proxies.md#list-your-proxy-plans
- [POST /public/proxies/generate](https://quantumproxies.io/docs/#tag/Proxies/operation/generateProxies): Generate proxy strings for a plan. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/proxies.md#generate-proxy-strings-for-a-plan
- [GET /public/proxies/ip-info](https://quantumproxies.io/docs/#tag/Proxies/operation/getIpInfo): Geolocate an IP. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/proxies.md#geolocate-an-ip
- [GET /public/proxies/whitelist-ip](https://quantumproxies.io/docs/#tag/Proxies/operation/listWhitelistIps): List whitelisted IPs of an order. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/proxies.md#list-whitelisted-ips-of-an-order
- [POST /public/proxies/whitelist-ip](https://quantumproxies.io/docs/#tag/Proxies/operation/addWhitelistIp): Whitelist an IP. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/proxies.md#whitelist-an-ip
- [DELETE /public/proxies/whitelist-ip](https://quantumproxies.io/docs/#tag/Proxies/operation/removeWhitelistIp): Remove a whitelisted IP. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/proxies.md#remove-a-whitelisted-ip

## Account

Markdown: https://quantumproxies.io/docs/account.md

- [GET /scraper/usage](https://quantumproxies.io/docs/#tag/Account/operation/getUsage): Per-day usage and cost. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/account.md#per-day-usage-and-cost
- [GET /scraper/billing](https://quantumproxies.io/docs/#tag/Account/operation/getBilling): Billing status and your price list. Rate limit: Per API key, by tier (see Rate limits and tiers). Markdown: https://quantumproxies.io/docs/account.md#billing-status-and-your-price-list
- [GET /mcp/trial-config](https://quantumproxies.io/docs/#tag/Account/operation/getMcpTrialConfig): No-key MCP trial settings. Rate limit: No rate limit. Markdown: https://quantumproxies.io/docs/account.md#no-key-mcp-trial-settings

## MCP

- Remote server: https://api.quantumproxies.io/mcp
- Product page: https://quantumproxies.io/mcp-server
- Local: npx -y quantumproxies-mcp