Skip to main content
GET
Places

Query Parameters

q
string

What the user typed: a city, suburb, " CBD" or postcode. Spelling-tolerant (Mt/Mount, St/Saint). A trailing state ("Richmond VIC") only ranks. Digits search postcodes by prefix. Empty lists the capital cities.

Maximum string length: 100
limit
integer
default:20

Most places to return.

Required range: 1 <= x <= 50

Response

Default Response

places
object[]
required