# XenonFlare Developer API — LLM index

# https://xenonflare.com/llms.txt



> XenonFlare is an SEO monitoring SaaS. The Developer API lets organizations automate site crawls, poll job status, read audit reports, and integrate Google Search Console snapshots.



## Primary docs

- Developer API reference: https://xenonflare.com/docs/developer-api

- OpenAPI 3.1 spec: https://xenonflare.com/openapi/developer-v1.yaml

- GSC field reference: https://xenonflare.com/docs/developer-api/gsc-reference



## Guides

- Idempotency (write retries): https://xenonflare.com/docs/guides/idempotency

- Nightly crawl automation: https://xenonflare.com/docs/guides/nightly-crawl

- CI pipeline integration: https://xenonflare.com/docs/guides/ci-pipeline

- Agency portfolio monitoring: https://xenonflare.com/docs/guides/agency-portfolio

- GSC + crawl correlation: https://xenonflare.com/docs/guides/gsc-crawl-correlation



## API basics

- Base URL: https://api.xenonflare.com/api/v1

- Auth: Bearer API key (`xf_live_...`) created in the web app under **Developer API** in the sidebar

- Plan: Starter or Growth required

- Health (no auth): GET /health — returns status, version, timestamp, statusPage URL

- Status page: https://status.xenonflare.com



## Key endpoints

- GET /organization — workspace summary (org:read)

- GET /properties — list properties; ?include=gsc,lastScan (properties:read)

- POST /properties/{id}/scans — queue crawl (jobs:write)

- POST /scans/batch — queue up to 25 scans (jobs:write)

- GET /jobs/{id} — job status + stable result payload (jobs:read)

- POST /jobs/{id}/cancel — cancel in-flight job (jobs:write)

- GET /properties/{id}/issues — SEO issue lifecycle (properties:read)

- GET /rate-limits — live read/write/org counters (usage:read)

- GET /reports — shared audit report links (reports:read)

- GET/POST/PATCH/DELETE /webhooks/{id} — job event callbacks (webhooks:read|write)

- POST /webhooks/{id}/test — send signed test payload (webhooks:write)

- GET /webhooks/{id}/deliveries — delivery attempt log (webhooks:read)

- GET /properties/{id}/gsc/overview|queries|pages — cached GSC snapshot (gsc:read)

- POST /properties/{id}/gsc/sync — refresh snapshot (gsc:write)



## Rate limits & errors

- Read: 1000/hour per key; Write: 60/hour per key; Org writes: 500/day

- 429 responses include Retry-After header (seconds until reset)

- Error envelope: { error: { code, message }, meta: { requestId } }



## Webhooks

- Events: job.completed, job.failed, job.cancelled

- HMAC SHA-256 signature in X-XenonFlare-Signature header

- Test deliveries include `test: true` in the JSON body

- Up to 3 delivery attempts with exponential backoff; history retained 30 days



## SDK / codegen

- OpenAPI spec suitable for openapi-generator, Speakeasy, Stainless, etc.

- See Developer API docs “SDK & code generation” section