Developer API
Site audit API — queue crawls and read results programmatically
Catch broken SEO before releases. Queue multi-page crawls for any verified property, poll until complete, and fetch shareable report links — without opening the dashboard.
Requires Starter or Growth. Authenticate with Bearer API keys from Developer API in the web app sidebar.
Customer workflow
“We monitor 40 client sites through one internal dashboard. Nightly batch scans, webhook alerts when a crawl fails, and CSV activity exports for client reporting — without logging into each property.”
Digital agency using XenonFlare Developer API on Growth
- 40 properties
- POST /scans/batch
- Webhook delivery history
- Activity CSV export
Typical integration flow
- Create a Starter or Growth workspace and an API key with jobs:write
- Resolve property IDs via GET /properties
- Queue a scan with POST /properties/:id/scans
- Poll GET /jobs/:id until status is completed or failed
- Optional: list shared reports with GET /reports (reports:read scope)
What you get
- POST /properties/:id/scans — queue full-site seo-scan jobs
- GET /jobs and GET /jobs/:id — poll status, progress, and results
- GET /reports — list active shared audit report links
- Scoped keys — jobs:read/write, reports:read, properties:read
- Idempotency-Key header for safe retries on writes
- Rate limits: 1,000 reads/hr and 60 writes/hr per key (500 org writes/day)
FAQ
- Can agencies resell API access to clients?
- Agencies typically run one Growth workspace with client properties inside it, using scoped keys for internal dashboards and nightly batch scans. Each end client does not need their own API key — you deliver reports via shared links, webhooks, or your own portal built on top of the API.
- Which plan includes the Site Audit API?
- Developer API access requires Starter or Growth. The Free plan includes the web app and xenonflare.com free tools, but not API keys.
- How is this different from the free audit tool?
- Free tools give a one-page snapshot without an account. The API queues full-site crawls tied to your workspace, with job history, plan crawl limits, and shareable reports.
- What are the API rate limits?
- Defaults are 1,000 read requests per hour per key, 60 write requests per hour per key, and 500 write requests per organization per day. Up to 5 active keys per workspace. See the Developer API docs for details.
- Can I use this in CI?
- Yes. See the CI pipeline guide for a GitHub Actions example that queues a scan and fails the build on errors.
Developer API on Starter and Growth
Create API keys in the web app after upgrading. Free tier includes the dashboard and free marketing tools — not REST keys.
Upgrade for API access