API reference

Where to find authoritative endpoint documentation and the conventions every endpoint follows.

Every DomainRadar action available in the dashboard is also available via API.

Endpoint paths can change. Treat the Swagger spec served by the DomainRadar service as the source of truth; this page captures conventions only.

Where to find the Swagger UI

The Swagger UI is served at /swagger/ on the DomainRadar service host (typically the host configured as PUBLIC_DOMAINRADAR_SERVICE_BACKEND in the JDS dashboard repo or shown in your account settings).

Authentication

Authorization: Bearer <JWT>

Tokens are minted with a DomainRadar-specific audience via the auth service. See Platform → Tokens.

Resource groups

Single check – POST /check for one domain.
Bulk checks – create, list, detail, cancel; results paginated or streamed via Server-Sent Events.
Name generator – create generation jobs, list results, run the results through bulk check.
Saved domains – add to / list / remove from your starred list.
Brand Monitor – watchers – CRUD + enable/disable.
Brand Monitor – hits – list across all watchers or per watcher, detail one hit.

Streaming bulk-check results

For long-running bulk jobs you can stream results via Server-Sent Events:

curl -N -H "Authorization: Bearer $TOKEN" \
  https://<your-domainradar-host>/check/bulk/{id}/stream

The stream emits progress events (completion percentage) and result events (one per resolved domain). It closes when the job reaches a terminal state.

Pagination

List endpoints use cursor-based pagination. Pass cursor and limit; responses include cursors.next (or null at the end).

Errors

See Limits and errors.