API reference/address
Re-check a monitored address list now
POST/api/v1/address/monitors/{monitorId}/run
- authentication
- Secret API key as a bearer token
- billing
- The run bills every address like a single lookup; addresses that do not stand as written, and 7-day repeats, are free.
Queues a run right away instead of waiting for the schedule; when it finishes, the next scheduled run is set one cadence from then. Answers 202 with the monitor as it stands before the run; poll it for the new last_run_at, last_summary and results. A monitor that belongs to another account answers 404.
Parameters
| name | in | type | description |
|---|---|---|---|
| monitorIdrequired | path | integer | The monitor's id from the list endpoint. |
Example request
curl -X POST https://spaw.co/api/v1/address/monitors/9/run \ -H "Authorization: Bearer sk_live_…"
Responses
202The run was queued.
{
"success": true,
"data": {
"monitor": {
"id": 9,
"name": "Supplier offices",
"cadence": "monthly",
"address_count": 2,
"country": "GB",
"deliverability": false,
"next_run_at": "2026-10-05T08:00:00+00:00",
"last_run_at": "2026-09-05T08:00:04+00:00",
"last_summary": {
"total": 2,
"ok": 1,
"invalid": 0,
"not_in_register": 1,
"terminated_postcode": 0,
"mail_drop": 0,
"high_risk": 0,
"unverifiable": 0,
"changed": 1,
"newly_flagged": 1,
"credits_used": 2,
"stopped_reason": null
},
"created_at": "2026-08-05T08:00:00+00:00"
}
}
}401The key is missing, malformed, or revoked.
{
"success": false,
"error": {
"code": "UNAUTHENTICATED",
"message": "Provide a valid API key as a bearer token.",
"request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
}
}404No such record on this account.
{
"message": "Not Found"
}429Over 5 requests per second for the key. Retry after the limit resets.
{
"success": false,
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests. Retry after the limit resets.",
"request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
}
}Error codes
Failures answer { success: false, error: { code, message, request_id } }. Each code has its own page.