Get started¶
You need a project and its API key from the AzScraper dashboard. Send the key as a Bearer token.
Set your credentials¶
export API_BASE="https://api.azscraper.com"
export API_KEY="<project-api-key>"
export PROJECT_ID="<project-id>"
For a self-hosted deployment, set API_BASE to its API origin. The request paths below already include the /v1/key prefix.
Submit a search crawl¶
curl -sS -X POST "$API_BASE/v1/key/projects/$PROJECT_ID/jobs" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{"type":"search","targets":["wireless earbuds"],"config":{"marketplace":"US","lang":"en-US"}}'
For a product-details crawl, use "type":"details" and provide ASINs or Amazon product URLs in targets.
Poll and retrieve results¶
The create-job response includes the job's id. Poll the job until its status is completed, failed, or cancelled:
After it completes, retrieve the result rows or download an export:
curl -sS "$API_BASE/v1/key/jobs/$JOB_ID/results" \
-H "Authorization: Bearer $API_KEY"
curl -sS "$API_BASE/v1/key/jobs/$JOB_ID/export?format=csv" \
-H "Authorization: Bearer $API_KEY" \
-o results.csv
See Get data for all supported project-scoped endpoints and parameters.
Keep the key safe¶
- Store the key in a secret manager or server-side environment variable.
- Do not put it in browser code, mobile apps, public repositories, or logs.
- Create a separate key for each integration and revoke exposed keys in the dashboard.