| Concern | Rule |
|---|---|
| Bodies | JSON, UTF-8, Content-Type: application/json, at most 64 KB. Free text is plain text. |
| Your ids | Any text or number up to 128 characters, unique within the agency. Numbers are stored and echoed back as text. They go in the body, never the URL, so slashes are fine. |
| Absent fields | A missing field, null, a blank string and an empty [] / {} on an optional field all mean the same. A blank required field is refused (empty). Unknown fields are ignored. |
| Emails | An email we can’t read is ignored, not refused, so a typo never costs you the record. Use real-looking test addresses (example.com): reserved ones like .test are ignored. |
| Timestamps | ISO 8601 with an offset: 2026-12-10T14:30:00+00:00. One without an offset is refused (missing_offset). We always send UTC. |
| Phone numbers | Irish (+353) or UK (+44). National numbers (086 123 4567, 07700 900123) are read for the agency’s side of the border. Without a mobile number nothing can be sent, but the record is kept. |
| Money | Whole minor units plus currency: €395,000 is {"amount": 39500000, "currency": "EUR"}. Send an integer: an amount with a decimal point (395000.00) is refused, because it usually means whole euros or pounds were sent. A rent adds "period": "month" or "week". |
| Retries | Sending the same record again never duplicates it or messages anyone twice, so retry freely. |
| Rate limit | 100 requests a minute per key. Over that: 429 with Retry-After in seconds. |
| Versioning | The version is in the path. Within v1 we only add fields, event types and values. |
Errors
{
"error": "validation_failed",
"message": "2 fields are invalid.",
"request_id": "a1b2c3d4e5f6",
"fields": [
{ "path": "transaction_type", "code": "not_allowed", "message": "Input should be 'sale' or 'letting'" },
{ "path": "scheduled_at", "code": "missing_offset", "message": "Input should have timezone info" }
]
}
request_id to us and we can find the call.
| Status | error | Retry? |
|---|---|---|
| 401 | unauthorized | No |
| 400 | bad_request | No |
| 404 | not_found | No |
| 410 | cursor_expired | No: start GET /events again without after |
| 405 | method_not_allowed | No |
| 413 | too_large | No: bodies are at most 64 KB |
| 415 | unsupported_media_type | No |
| 422 | validation_failed | No: fix and resend |
| 429 | rate_limited | Yes, after Retry-After |
| 501 | not_available_yet | Not until the call is live |
| 5xx, timeout | internal_error | Yes, with backoff, for up to 24 hours |