{"openapi":"3.1.0","info":{"title":"ListingData Australian Property API","version":"1.0.0","description":"Observed Australian listing data. SMS-verified account and bearer API key required. Descriptions, agent contacts and hidden search-price bands are excluded. Examples are illustrative."},"servers":[{"url":"https:\/\/www.listingdata.com.au"}],"paths":{"\/api\/v1\/properties":{"get":{"operationId":"search","tags":["Listings"],"summary":"Search observed Australian sale listings by public address, location, type and attributes.","description":"Typesense-backed search over a separate public-field index. Results are listing records, not guaranteed unique physical properties. No descriptions, private contacts, internal numeric prices or hidden search bands are returned or searchable.","x-credit-cost":1,"parameters":[{"name":"q","in":"query","required":false,"description":"Search public address, suburb and agency fields only. Maximum 100 characters.","schema":{"type":"string"},"example":"Brisbane"},{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"status","in":"query","required":false,"description":"Normalised observed status.","schema":{"type":"string","enum":["active","under_offer","under_contract","sold","withdrawn","no_longer_observed"]},"example":"active"},{"name":"bedrooms","in":"query","required":false,"description":"Minimum bedrooms, 0\u201320.","schema":{"type":"integer","minimum":0,"maximum":20},"example":3},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"},{"name":"page","in":"query","required":false,"description":"Page number, 1\u201320. Deep exports are unavailable.","schema":{"type":"integer","minimum":1,"maximum":20},"example":1},{"name":"per_page","in":"query","required":false,"description":"Records per page, 1\u201350.","schema":{"type":"integer","minimum":1,"maximum":50},"example":20}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"id":"123456","address":{"formatted":"12 Example Street, Brisbane QLD 4000","suburb":"BRISBANE","state":"QLD","postcode":"4000"},"property_type":"house","status":"active","marketing_price":"Offers over $900,000","bedrooms":3,"bathrooms":2,"car_spaces":1,"agency":{"id":"12","name":"Example Agency"},"first_observed_at":"2026-11-01T02:30:00Z","last_observed_at":"2026-11-07T01:45:00Z","source_updated_at":"2026-11-06T23:00:00Z","indexed_at":"2026-11-07T02:00:00Z"}],"meta":{"example":true,"credit_cost":1}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/properties\/{id}":{"get":{"operationId":"property","tags":["Listings"],"summary":"Retrieve the public fields for one observed listing.","description":"Retrieve the public fields for one observed listing.","x-credit-cost":1,"parameters":[{"name":"id","in":"path","required":true,"description":"Numeric listing identifier.","schema":{"type":"string"},"example":"123456"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":{"id":"123456","address":{"formatted":"12 Example Street, Brisbane QLD 4000","suburb":"BRISBANE","state":"QLD","postcode":"4000"},"property_type":"house","status":"active","marketing_price":"Offers over $900,000","bedrooms":3,"bathrooms":2,"car_spaces":1,"agency":{"id":"12","name":"Example Agency"},"first_observed_at":"2026-11-01T02:30:00Z","last_observed_at":"2026-11-07T01:45:00Z","source_updated_at":"2026-11-06T23:00:00Z","indexed_at":"2026-11-07T02:00:00Z"},"meta":{"example":true,"credit_cost":1}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/properties\/new":{"get":{"operationId":"new","tags":["Listings"],"summary":"Listings first observed in the last seven days; this is not an asserted original listing date.","description":"Listings first observed in the last seven days; this is not an asserted original listing date.","x-credit-cost":1,"parameters":[{"name":"q","in":"query","required":false,"description":"Search public address, suburb and agency fields only. Maximum 100 characters.","schema":{"type":"string"},"example":"Brisbane"},{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"bedrooms","in":"query","required":false,"description":"Minimum bedrooms, 0\u201320.","schema":{"type":"integer","minimum":0,"maximum":20},"example":3},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"},{"name":"page","in":"query","required":false,"description":"Page number, 1\u201320. Deep exports are unavailable.","schema":{"type":"integer","minimum":1,"maximum":20},"example":1},{"name":"per_page","in":"query","required":false,"description":"Records per page, 1\u201350.","schema":{"type":"integer","minimum":1,"maximum":50},"example":20}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"id":"123456","address":{"formatted":"12 Example Street, Brisbane QLD 4000","suburb":"BRISBANE","state":"QLD","postcode":"4000"},"property_type":"house","status":"active","marketing_price":"Offers over $900,000","bedrooms":3,"bathrooms":2,"car_spaces":1,"agency":{"id":"12","name":"Example Agency"},"first_observed_at":"2026-11-01T02:30:00Z","last_observed_at":"2026-11-07T01:45:00Z","source_updated_at":"2026-11-06T23:00:00Z","indexed_at":"2026-11-07T02:00:00Z"}],"meta":{"example":true,"credit_cost":1}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/properties\/updated":{"get":{"operationId":"updated","tags":["Listings"],"summary":"Listings updated or observed in the last seven days, newest observation first.","description":"Listings updated or observed in the last seven days, newest observation first.","x-credit-cost":1,"parameters":[{"name":"q","in":"query","required":false,"description":"Search public address, suburb and agency fields only. Maximum 100 characters.","schema":{"type":"string"},"example":"Brisbane"},{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"bedrooms","in":"query","required":false,"description":"Minimum bedrooms, 0\u201320.","schema":{"type":"integer","minimum":0,"maximum":20},"example":3},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"},{"name":"page","in":"query","required":false,"description":"Page number, 1\u201320. Deep exports are unavailable.","schema":{"type":"integer","minimum":1,"maximum":20},"example":1},{"name":"per_page","in":"query","required":false,"description":"Records per page, 1\u201350.","schema":{"type":"integer","minimum":1,"maximum":50},"example":20}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"id":"123456","address":{"formatted":"12 Example Street, Brisbane QLD 4000","suburb":"BRISBANE","state":"QLD","postcode":"4000"},"property_type":"house","status":"active","marketing_price":"Offers over $900,000","bedrooms":3,"bathrooms":2,"car_spaces":1,"agency":{"id":"12","name":"Example Agency"},"first_observed_at":"2026-11-01T02:30:00Z","last_observed_at":"2026-11-07T01:45:00Z","source_updated_at":"2026-11-06T23:00:00Z","indexed_at":"2026-11-07T02:00:00Z"}],"meta":{"example":true,"credit_cost":1}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/properties\/withdrawn":{"get":{"operationId":"withdrawn","tags":["Listings"],"summary":"Listings explicitly labelled withdrawn by the source. A missing page alone is not a withdrawal.","description":"Listings explicitly labelled withdrawn by the source. A missing page alone is not a withdrawal.","x-credit-cost":1,"parameters":[{"name":"q","in":"query","required":false,"description":"Search public address, suburb and agency fields only. Maximum 100 characters.","schema":{"type":"string"},"example":"Brisbane"},{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"bedrooms","in":"query","required":false,"description":"Minimum bedrooms, 0\u201320.","schema":{"type":"integer","minimum":0,"maximum":20},"example":3},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"},{"name":"page","in":"query","required":false,"description":"Page number, 1\u201320. Deep exports are unavailable.","schema":{"type":"integer","minimum":1,"maximum":20},"example":1},{"name":"per_page","in":"query","required":false,"description":"Records per page, 1\u201350.","schema":{"type":"integer","minimum":1,"maximum":50},"example":20}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"id":"123456","address":{"formatted":"12 Example Street, Brisbane QLD 4000","suburb":"BRISBANE","state":"QLD","postcode":"4000"},"property_type":"house","status":"active","marketing_price":"Offers over $900,000","bedrooms":3,"bathrooms":2,"car_spaces":1,"agency":{"id":"12","name":"Example Agency"},"first_observed_at":"2026-11-01T02:30:00Z","last_observed_at":"2026-11-07T01:45:00Z","source_updated_at":"2026-11-06T23:00:00Z","indexed_at":"2026-11-07T02:00:00Z"}],"meta":{"example":true,"credit_cost":1}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/properties\/no-longer-observed":{"get":{"operationId":"inactive","tags":["Listings"],"summary":"Records archived or removed from observation. They may be sold, relisted or temporarily unavailable; withdrawal is not inferred.","description":"Records archived or removed from observation. They may be sold, relisted or temporarily unavailable; withdrawal is not inferred.","x-credit-cost":1,"parameters":[{"name":"q","in":"query","required":false,"description":"Search public address, suburb and agency fields only. Maximum 100 characters.","schema":{"type":"string"},"example":"Brisbane"},{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"bedrooms","in":"query","required":false,"description":"Minimum bedrooms, 0\u201320.","schema":{"type":"integer","minimum":0,"maximum":20},"example":3},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"},{"name":"page","in":"query","required":false,"description":"Page number, 1\u201320. Deep exports are unavailable.","schema":{"type":"integer","minimum":1,"maximum":20},"example":1},{"name":"per_page","in":"query","required":false,"description":"Records per page, 1\u201350.","schema":{"type":"integer","minimum":1,"maximum":50},"example":20}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"id":"123456","address":{"formatted":"12 Example Street, Brisbane QLD 4000","suburb":"BRISBANE","state":"QLD","postcode":"4000"},"property_type":"house","status":"active","marketing_price":"Offers over $900,000","bedrooms":3,"bathrooms":2,"car_spaces":1,"agency":{"id":"12","name":"Example Agency"},"first_observed_at":"2026-11-01T02:30:00Z","last_observed_at":"2026-11-07T01:45:00Z","source_updated_at":"2026-11-06T23:00:00Z","indexed_at":"2026-11-07T02:00:00Z"}],"meta":{"example":true,"credit_cost":1}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/properties\/under-offer":{"get":{"operationId":"under-offer","tags":["Listings"],"summary":"Observed listings flagged under offer; status can change before the next index refresh.","description":"Observed listings flagged under offer; status can change before the next index refresh.","x-credit-cost":1,"parameters":[{"name":"q","in":"query","required":false,"description":"Search public address, suburb and agency fields only. Maximum 100 characters.","schema":{"type":"string"},"example":"Brisbane"},{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"bedrooms","in":"query","required":false,"description":"Minimum bedrooms, 0\u201320.","schema":{"type":"integer","minimum":0,"maximum":20},"example":3},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"},{"name":"page","in":"query","required":false,"description":"Page number, 1\u201320. Deep exports are unavailable.","schema":{"type":"integer","minimum":1,"maximum":20},"example":1},{"name":"per_page","in":"query","required":false,"description":"Records per page, 1\u201350.","schema":{"type":"integer","minimum":1,"maximum":50},"example":20}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"id":"123456","address":{"formatted":"12 Example Street, Brisbane QLD 4000","suburb":"BRISBANE","state":"QLD","postcode":"4000"},"property_type":"house","status":"active","marketing_price":"Offers over $900,000","bedrooms":3,"bathrooms":2,"car_spaces":1,"agency":{"id":"12","name":"Example Agency"},"first_observed_at":"2026-11-01T02:30:00Z","last_observed_at":"2026-11-07T01:45:00Z","source_updated_at":"2026-11-06T23:00:00Z","indexed_at":"2026-11-07T02:00:00Z"}],"meta":{"example":true,"credit_cost":1}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/properties\/under-contract":{"get":{"operationId":"under-contract","tags":["Listings"],"summary":"Observed listings flagged under contract.","description":"Observed listings flagged under contract.","x-credit-cost":1,"parameters":[{"name":"q","in":"query","required":false,"description":"Search public address, suburb and agency fields only. Maximum 100 characters.","schema":{"type":"string"},"example":"Brisbane"},{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"bedrooms","in":"query","required":false,"description":"Minimum bedrooms, 0\u201320.","schema":{"type":"integer","minimum":0,"maximum":20},"example":3},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"},{"name":"page","in":"query","required":false,"description":"Page number, 1\u201320. Deep exports are unavailable.","schema":{"type":"integer","minimum":1,"maximum":20},"example":1},{"name":"per_page","in":"query","required":false,"description":"Records per page, 1\u201350.","schema":{"type":"integer","minimum":1,"maximum":50},"example":20}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"id":"123456","address":{"formatted":"12 Example Street, Brisbane QLD 4000","suburb":"BRISBANE","state":"QLD","postcode":"4000"},"property_type":"house","status":"active","marketing_price":"Offers over $900,000","bedrooms":3,"bathrooms":2,"car_spaces":1,"agency":{"id":"12","name":"Example Agency"},"first_observed_at":"2026-11-01T02:30:00Z","last_observed_at":"2026-11-07T01:45:00Z","source_updated_at":"2026-11-06T23:00:00Z","indexed_at":"2026-11-07T02:00:00Z"}],"meta":{"example":true,"credit_cost":1}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/properties\/sold":{"get":{"operationId":"sold","tags":["Listings"],"summary":"Source-reported sold status. Does not provide settled sale prices or settlement evidence.","description":"Source-reported sold status. Does not provide settled sale prices or settlement evidence.","x-credit-cost":1,"parameters":[{"name":"q","in":"query","required":false,"description":"Search public address, suburb and agency fields only. Maximum 100 characters.","schema":{"type":"string"},"example":"Brisbane"},{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"bedrooms","in":"query","required":false,"description":"Minimum bedrooms, 0\u201320.","schema":{"type":"integer","minimum":0,"maximum":20},"example":3},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"},{"name":"page","in":"query","required":false,"description":"Page number, 1\u201320. Deep exports are unavailable.","schema":{"type":"integer","minimum":1,"maximum":20},"example":1},{"name":"per_page","in":"query","required":false,"description":"Records per page, 1\u201350.","schema":{"type":"integer","minimum":1,"maximum":50},"example":20}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"id":"123456","address":{"formatted":"12 Example Street, Brisbane QLD 4000","suburb":"BRISBANE","state":"QLD","postcode":"4000"},"property_type":"house","status":"active","marketing_price":"Offers over $900,000","bedrooms":3,"bathrooms":2,"car_spaces":1,"agency":{"id":"12","name":"Example Agency"},"first_observed_at":"2026-11-01T02:30:00Z","last_observed_at":"2026-11-07T01:45:00Z","source_updated_at":"2026-11-06T23:00:00Z","indexed_at":"2026-11-07T02:00:00Z"}],"meta":{"example":true,"credit_cost":1}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/events\/price-changes":{"get":{"operationId":"price-changes","tags":["Market events"],"summary":"Observed changes to public advertised price text. A wording change is not necessarily a numeric reduction.","description":"Returns only public marketing-price text changes, within the last 90 days. Hidden numeric search ranges and private price history are excluded. Contact details embedded in text are suppressed. Empty or redacted values remain null.","x-credit-cost":3,"parameters":[{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"},{"name":"page","in":"query","required":false,"description":"Page number, 1\u201320. Deep exports are unavailable.","schema":{"type":"integer","minimum":1,"maximum":20},"example":1},{"name":"per_page","in":"query","required":false,"description":"Records per page, 1\u201350.","schema":{"type":"integer","minimum":1,"maximum":50},"example":20}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"id":"event_123","property_id":"123456","old_marketing_price":"Offers over $950,000","new_marketing_price":"Offers over $900,000","observed_at":"2026-11-07T00:30:00Z","state":"QLD","postcode":"4000","property_type":"house","agency_id":"12"}],"meta":{"example":true,"credit_cost":3}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/properties\/{id}\/price-history":{"get":{"operationId":"price-history","tags":["Market events"],"summary":"Public marketing-price changes for a listing within the last 90 days.","description":"Public marketing-price changes for a listing within the last 90 days.","x-credit-cost":3,"parameters":[{"name":"id","in":"path","required":true,"description":"Numeric listing identifier.","schema":{"type":"string"},"example":"123456"},{"name":"page","in":"query","required":false,"description":"Page 1\u201320.","schema":{"type":"integer","minimum":1,"maximum":20},"example":1},{"name":"per_page","in":"query","required":false,"description":"Records per page 1\u201350.","schema":{"type":"integer","minimum":1,"maximum":50},"example":20}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"id":"event_123","property_id":"123456","old_marketing_price":"Offers over $950,000","new_marketing_price":"Offers over $900,000","observed_at":"2026-11-07T00:30:00Z","state":"QLD","postcode":"4000","property_type":"house","agency_id":"12"}],"meta":{"example":true,"credit_cost":3}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/market\/summary":{"get":{"operationId":"market-summary","tags":["Market pulse"],"summary":"Counts of observed listings, grouped by status and property type; not a census of the Australian property market.","description":"Counts of observed listings, grouped by status and property type; not a census of the Australian property market.","x-credit-cost":5,"parameters":[{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":{"observed_listings":1250,"by_status":[{"value":"active","count":900}],"by_property_type":[{"value":"house","count":650}]},"meta":{"example":true,"credit_cost":5}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/market\/states":{"get":{"operationId":"market-states","tags":["Market pulse"],"summary":"Facet counts from the public index for the selected filters. Groups capped at 100; counts reflect observed coverage.","description":"Facet counts from the public index for the selected filters. Groups capped at 100; counts reflect observed coverage.","x-credit-cost":5,"parameters":[{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"value":"QLD","count":250}],"meta":{"example":true,"credit_cost":5}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/market\/property-types":{"get":{"operationId":"market-types","tags":["Market pulse"],"summary":"Facet counts from the public index for the selected filters. Groups capped at 100; counts reflect observed coverage.","description":"Facet counts from the public index for the selected filters. Groups capped at 100; counts reflect observed coverage.","x-credit-cost":5,"parameters":[{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"value":"Example group","count":250}],"meta":{"example":true,"credit_cost":5}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/market\/statuses":{"get":{"operationId":"market-statuses","tags":["Market pulse"],"summary":"Facet counts from the public index for the selected filters. Groups capped at 100; counts reflect observed coverage.","description":"Facet counts from the public index for the selected filters. Groups capped at 100; counts reflect observed coverage.","x-credit-cost":5,"parameters":[{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"value":"Example group","count":250}],"meta":{"example":true,"credit_cost":5}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/market\/agencies":{"get":{"operationId":"market-agencies","tags":["Market pulse"],"summary":"Facet counts from the public index for the selected filters. Groups capped at 100; counts reflect observed coverage.","description":"Facet counts from the public index for the selected filters. Groups capped at 100; counts reflect observed coverage.","x-credit-cost":5,"parameters":[{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"value":"Example group","count":250}],"meta":{"example":true,"credit_cost":5}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/market\/suburbs":{"get":{"operationId":"market-suburbs","tags":["Market pulse"],"summary":"Facet counts from the public index for the selected filters. Groups capped at 100; counts reflect observed coverage.","description":"Facet counts from the public index for the selected filters. Groups capped at 100; counts reflect observed coverage.","x-credit-cost":5,"parameters":[{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"value":"Example group","count":250}],"meta":{"example":true,"credit_cost":5}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/agencies":{"get":{"operationId":"agencies","tags":["Agencies"],"summary":"Agency names and identifiers with observed listing counts. No contact information.","description":"Agency names and identifiers with observed listing counts. No contact information.","x-credit-cost":2,"parameters":[{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"agency_id","in":"query","required":false,"description":"Agency identifier from the agency endpoint.","schema":{"type":"integer","minimum":1,"maximum":2147483647},"example":12},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"id":"12","name":"Example Agency","observed_listings":25}],"meta":{"example":true,"credit_cost":2}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/agencies\/{id}":{"get":{"operationId":"agency","tags":["Agencies"],"summary":"Public agency name and observed listing count, without agent names, contacts or source credentials.","description":"Public agency name and observed listing count, without agent names, contacts or source credentials.","x-credit-cost":2,"parameters":[{"name":"id","in":"path","required":true,"description":"Numeric agency identifier.","schema":{"type":"string"},"example":"12"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":{"id":"12","name":"Example Agency","observed_listings":25},"meta":{"example":true,"credit_cost":2}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/agencies\/{id}\/properties":{"get":{"operationId":"agency-properties","tags":["Agencies"],"summary":"Search observed public listings for a specific agency.","description":"Search observed public listings for a specific agency.","x-credit-cost":1,"parameters":[{"name":"id","in":"path","required":true,"description":"Numeric agency identifier.","schema":{"type":"string"},"example":"12"},{"name":"q","in":"query","required":false,"description":"Search public address, suburb and agency fields only. Maximum 100 characters.","schema":{"type":"string"},"example":"Brisbane"},{"name":"state","in":"query","required":false,"description":"Australian state or territory code.","schema":{"type":"string","enum":["ACT","NSW","NT","QLD","SA","TAS","VIC","WA"]},"example":"QLD"},{"name":"postcode","in":"query","required":false,"description":"Exact four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"property_type","in":"query","required":false,"description":"Normalised public property type.","schema":{"type":"string","enum":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"]},"example":"house"},{"name":"status","in":"query","required":false,"description":"Normalised observed status.","schema":{"type":"string","enum":["active","under_offer","under_contract","sold","withdrawn","no_longer_observed"]},"example":"active"},{"name":"bedrooms","in":"query","required":false,"description":"Minimum bedrooms, 0\u201320.","schema":{"type":"integer","minimum":0,"maximum":20},"example":3},{"name":"updated_since","in":"query","required":false,"description":"UTC ISO 8601 timestamp; at most 90 days ago.","schema":{"type":"string"},"example":"2026-11-01T00:00:00Z"},{"name":"page","in":"query","required":false,"description":"Page number, 1\u201320. Deep exports are unavailable.","schema":{"type":"integer","minimum":1,"maximum":20},"example":1},{"name":"per_page","in":"query","required":false,"description":"Records per page, 1\u201350.","schema":{"type":"integer","minimum":1,"maximum":50},"example":20}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"id":"123456","address":{"formatted":"12 Example Street, Brisbane QLD 4000","suburb":"BRISBANE","state":"QLD","postcode":"4000"},"property_type":"house","status":"active","marketing_price":"Offers over $900,000","bedrooms":3,"bathrooms":2,"car_spaces":1,"agency":{"id":"12","name":"Example Agency"},"first_observed_at":"2026-11-01T02:30:00Z","last_observed_at":"2026-11-07T01:45:00Z","source_updated_at":"2026-11-06T23:00:00Z","indexed_at":"2026-11-07T02:00:00Z"}],"meta":{"example":true,"credit_cost":1}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/locations\/suburbs":{"get":{"operationId":"suburbs","tags":["Locations"],"summary":"Search Australian postcode locality reference data. Not a full address-validation service.","description":"Search Australian postcode locality reference data. Not a full address-validation service.","x-credit-cost":1,"parameters":[{"name":"q","in":"query","required":false,"description":"Suburb or postcode prefix; max100characters.","schema":{"type":"string"},"example":"Bris"},{"name":"state","in":"query","required":false,"description":"Optional state code.","schema":{"type":"string"},"example":"QLD"},{"name":"page","in":"query","required":false,"description":"Page 1\u201320.","schema":{"type":"integer","minimum":1,"maximum":20},"example":1},{"name":"per_page","in":"query","required":false,"description":"Records per page 1\u201350.","schema":{"type":"integer","minimum":1,"maximum":50},"example":20}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"suburb":"BRISBANE","postcode":"4000","state":"QLD"}],"meta":{"example":true,"credit_cost":1}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/locations\/postcodes\/{postcode}":{"get":{"operationId":"postcode","tags":["Locations"],"summary":"Find Australian reference localities for an exact postcode. Postcodes can contain several localities.","description":"Find Australian reference localities for an exact postcode. Postcodes can contain several localities.","x-credit-cost":1,"parameters":[{"name":"postcode","in":"path","required":true,"description":"Four-digit postcode.","schema":{"type":"string"},"example":"4000"},{"name":"page","in":"query","required":false,"description":"Page 1\u201320.","schema":{"type":"integer","minimum":1,"maximum":20},"example":1},{"name":"per_page","in":"query","required":false,"description":"Records per page 1\u201350.","schema":{"type":"integer","minimum":1,"maximum":50},"example":20}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"suburb":"BRISBANE","postcode":"4000","state":"QLD"}],"meta":{"example":true,"credit_cost":1}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/reference\/property-types":{"get":{"operationId":"property-types","tags":["Reference"],"summary":"Supported public property-type values.","description":"Supported public property-type values.","x-credit-cost":0,"parameters":[],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":["house","apartment","unit","townhouse","villa","land","rural","commercial","other"],"meta":{"example":true,"credit_cost":0}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/reference\/statuses":{"get":{"operationId":"statuses","tags":["Reference"],"summary":"Supported statuses and their evidence limits.","description":"Supported statuses and their evidence limits.","x-credit-cost":0,"parameters":[],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":[{"value":"withdrawn","meaning":"Explicit source withdrawal status only."},{"value":"no_longer_observed","meaning":"Archived or removed observation, reason unconfirmed."}],"meta":{"example":true,"credit_cost":0}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/coverage":{"get":{"operationId":"coverage","tags":["Reference"],"summary":"Observed index counts, last completed refresh and coverage caveats. No claim of complete national coverage.","description":"Observed index counts, last completed refresh and coverage caveats. No claim of complete national coverage.","x-credit-cost":0,"parameters":[],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":{"country":"AU","last_index_completed_at":"2026-11-07T02:00:00Z","observed_listings":1250,"agency_count":100,"refresh_target_seconds":300},"meta":{"example":true,"credit_cost":0}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}},"\/api\/v1\/account\/usage":{"get":{"operationId":"usage","tags":["Account"],"summary":"Current credit balance and account-wide request limits. This call costs zero credits but still respects request delays.","description":"Current credit balance and account-wide request limits. This call costs zero credits but still respects request delays.","x-credit-cost":0,"parameters":[],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Success"},"example":{"data":{"credits_remaining":950,"monthly_allowance":1000,"minimum_interval_seconds":2,"daily_request_limit":100},"meta":{"example":true,"credit_cost":0}}}}},"400":{"description":"Invalid request","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"403":{"description":"Account not verified","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"404":{"description":"Listing or agency not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"402":{"description":"Monthly credit allowance exhausted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"422":{"description":"Unsupported parameter","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"429":{"description":"Account delay or daily quota exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"503":{"description":"Public search index unavailable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}},"security":[{"ApiKey":[]}]}}},"components":{"securitySchemes":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"ld_live_\u2026"}},"schemas":{"Success":{"type":"object","required":["data","meta"],"properties":{"data":[],"meta":{"type":"object"}}},"Error":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string"}}}}}}}}