{"openapi":"3.0.0","info":{"title":"MapView API for Business","version":"1.0.0","description":"Decision-grade answers for any Australian address: the MapView Score, Must Knows, planning permits and more, the same answers the MapView app shows. Calls are billed in credits per your plan; every response says what it cost.","contact":{"name":"MapView","url":"https://mapview.ai/developers"}},"servers":[{"url":"https://api.mapview.ai","description":"Production"}],"components":{"securitySchemes":{"organisationKey":{"type":"http","scheme":"bearer","bearerFormat":"mv_live_ key"}}},"tags":[{"name":"public","description":"MapView API for Business"}],"paths":{"/v1/usage":{"get":{"summary":"This month's credits, plan and calls by product","tags":["public"],"responses":{"200":{"description":"Default Response"}},"security":[{"organisationKey":[]}]}},"/v1/addresses/suggest":{"get":{"summary":"Address suggestions with G-NAF place ids","tags":["public"],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":200},"in":"query","name":"q","required":true}],"responses":{"200":{"description":"Default Response"}},"security":[{"organisationKey":[]}]}},"/v1/permits/coverage":{"get":{"summary":"Whether the council at a point feeds planning permits, and how recently","tags":["public"],"parameters":[{"schema":{"type":"number","minimum":-44,"maximum":-9},"in":"query","name":"lat","required":true},{"schema":{"type":"number","minimum":112,"maximum":154},"in":"query","name":"lng","required":true},{"schema":{"type":"string","maxLength":3},"in":"query","name":"state","required":false}],"responses":{"200":{"description":"Default Response"}},"security":[{"organisationKey":[]}]}},"/v1/permits/{reference}":{"get":{"summary":"One planning permit by its council reference, found within 1 km of the point given","tags":["public"],"parameters":[{"schema":{"type":"number","minimum":-44,"maximum":-9},"in":"query","name":"lat","required":true},{"schema":{"type":"number","minimum":112,"maximum":154},"in":"query","name":"lng","required":true},{"schema":{"type":"string","minLength":1,"maxLength":80},"in":"path","name":"reference","required":true}],"responses":{"200":{"description":"Default Response"}},"security":[{"organisationKey":[]}]}},"/v1/permits":{"get":{"summary":"Planning permits lodged near a point, nearest first","tags":["public"],"parameters":[{"schema":{"type":"number","minimum":-44,"maximum":-9},"in":"query","name":"lat","required":true},{"schema":{"type":"number","minimum":112,"maximum":154},"in":"query","name":"lng","required":true},{"schema":{"type":"integer","minimum":50,"maximum":1000,"default":500},"in":"query","name":"radius","required":false},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"in":"query","name":"since","required":false},{"schema":{"type":"string","enum":["approved","in_progress","refused","under_review"]},"in":"query","name":"decision","required":false},{"schema":{"type":"integer","minimum":1,"maximum":50,"default":20},"in":"query","name":"limit","required":false}],"responses":{"200":{"description":"Default Response"}},"security":[{"organisationKey":[]}]}},"/v1/scores":{"get":{"summary":"The MapView Score and every grid score for a property","tags":["public"],"parameters":[{"schema":{"type":"number","minimum":-44,"maximum":-9},"in":"query","name":"lat","required":true},{"schema":{"type":"number","minimum":112,"maximum":154},"in":"query","name":"lng","required":true},{"schema":{"type":"string","maxLength":3},"in":"query","name":"state","required":false},{"schema":{"type":"string","maxLength":80},"in":"query","name":"suburb","required":false},{"schema":{"type":"string","maxLength":8},"in":"query","name":"postcode","required":false},{"schema":{"type":"string","maxLength":200},"in":"query","name":"address","required":false},{"schema":{"type":"string","maxLength":40},"in":"query","name":"placeId","required":false}],"responses":{"200":{"description":"Default Response"}},"security":[{"organisationKey":[]}]}},"/v1/scores/{category}":{"get":{"summary":"One score for a property","tags":["public"],"parameters":[{"schema":{"type":"number","minimum":-44,"maximum":-9},"in":"query","name":"lat","required":true},{"schema":{"type":"number","minimum":112,"maximum":154},"in":"query","name":"lng","required":true},{"schema":{"type":"string","maxLength":3},"in":"query","name":"state","required":false},{"schema":{"type":"string","maxLength":80},"in":"query","name":"suburb","required":false},{"schema":{"type":"string","maxLength":8},"in":"query","name":"postcode","required":false},{"schema":{"type":"string","maxLength":200},"in":"query","name":"address","required":false},{"schema":{"type":"string","maxLength":40},"in":"query","name":"placeId","required":false},{"schema":{"type":"string","enum":["liveability","walkability","crime","noise","extension"]},"in":"path","name":"category","required":true}],"responses":{"200":{"description":"Default Response"}},"security":[{"organisationKey":[]}]}},"/v1/must-knows":{"get":{"summary":"The hazard verdict for a property, its hazards and its encumbrances","tags":["public"],"parameters":[{"schema":{"type":"number","minimum":-44,"maximum":-9},"in":"query","name":"lat","required":true},{"schema":{"type":"number","minimum":112,"maximum":154},"in":"query","name":"lng","required":true},{"schema":{"type":"string","maxLength":3},"in":"query","name":"state","required":false},{"schema":{"type":"string","maxLength":80},"in":"query","name":"suburb","required":false},{"schema":{"type":"string","maxLength":8},"in":"query","name":"postcode","required":false},{"schema":{"type":"string","maxLength":200},"in":"query","name":"address","required":false},{"schema":{"type":"string","maxLength":40},"in":"query","name":"placeId","required":false}],"responses":{"200":{"description":"Default Response"}},"security":[{"organisationKey":[]}]}}},"correlation_id":"987aa212-a9b0-4999-b9b3-6ea592b8e11c"}