Skip to content

Get started

Use this page together with Authentication and Get data.

Prerequisites

  • HTTPS client (curl, fetch, httpx, etc.).
  • An account created via POST /auth/register (or credentials from your deployment).
  • A valid accessToken from register or login responses for all routes that require auth (see Authentication).

Secrets

Treat accessToken like a password. Do not commit tokens to source control or expose them in public client-side code without a backend-for-frontend.

Base URLs

Environment Example base URL
Local API (default in code) http://localhost:3001
Hosted / production https://api.azscraper.com (replace with your deployment)

All paths below are relative to that base (no /v1 prefix in the current Nest app). Swagger UI: {baseUrl}/api/docs.

Environment variables

Operator/self-host environment variables and ports are documented in Environment & deployment.

Minimal flow

  1. Register or login → receive accessToken (Authentication).
  2. Create a project → POST /projects with { "name": "..." } → note data.id.
  3. Create a crawl job → POST /projects/{projectId}/jobs with type, targets, optional config.
  4. Poll the job → GET /jobs/{jobId} until status is completed or failed (Get data).
  5. Fetch results → GET /jobs/{jobId}/results or export → GET /jobs/{jobId}/export?format=json or format=csv.

Rate limits and quotas

Usage is enforced per organization plan (monthly job count, targets, exports). Exceeding limits returns 403 with the standard error envelope (Authentication). The API may also return validation errors as 400.

Referral click endpoint

POST /referral/click is rate-limited separately; see Referral API.

Next steps

  • Authentication — tokens, logout, handoff, errors.
  • Get data — CRUD, jobs, results, export, quick reference.