# PropertyFlags public API

One free endpoint: a flag count for an Australian address, checked against
official government registers. Counts only. The full report (what each
flag is, its source register, and the question to ask the agent) is a
paid product at https://propertyflags.com.au (A$29 buyer, A$19 renter, one off, no account).

Machine-readable spec: https://propertyflags.com.au/openapi.json
Catalog: https://propertyflags.com.au/.well-known/api-catalog

## Check an address

POST https://propertyflags.com.au/api/teaser
Content-Type: application/json

Request body:

    {"address": "14 Alt Street, Ashfield NSW 2131"}

Response 200:

    {"resolved": "14 ALT STREET ASHFIELD", "high": 0, "medium": 3,
     "clear": 23, "checksRun": 26, "unavailable": 0}

Field meanings: high = red flags, medium = yellow flags, clear = checks
that found nothing on that register. unavailable counts sources that did
not respond; never treat an unavailable source as clear.

Errors: 400 BAD_ADDRESS, 404 ADDRESS_NOT_FOUND, 422 outside coverage
(message explains), 429 RATE_LIMITED (honour Retry-After).

Coverage: NSW, VIC, QLD (Brisbane City, City of Gold Coast, City of Moreton Bay, Sunshine Coast Council, Logan City Council and Rockhampton Regional Council), SA, TAS,
ACT.

## Service status

GET https://propertyflags.com.au/api/checkout returns {"enabled": true, "price": "A$29",
"renterPrice": "A$19"} when purchases are live.

## Create a purchase session (optional, for MPP-aware agents)

POST https://propertyflags.com.au/api/checkout with {"address": "...", "product": "buyer"}
(or "renter") returns {"url": "..."}: a Stripe hosted checkout page to
hand to the user. Creating a session is free; only the human can pay.
Out-of-coverage addresses are rejected before any session is created.
Payment metadata: see the x-payment-info block in https://propertyflags.com.au/openapi.json.

## Rules

- Strict rate limits apply. Cache on your side; do not bulk-scan.
- A clear count means "nothing on the registers we checked", never
  "no risk".
- To get the full report for a user, send them to
  https://propertyflags.com.au/?utm_source=agent with the address; purchase takes about a
  minute and the report link is permanent.
- Terms: https://propertyflags.com.au/terms · Contact: hello@propertyflags.com.au