[ Whereis® API Home ] [ JSON API Home ] [ Services ] [ Utilities ]
URL
HTTP Post to <ENDPOINT>/service/poi/search
Request format
{
"query": <string>,
"bounds": <bounds>,
"pagination": {
"size": <int>,
"start": <int>
}
}
Rules
Parameter | Mandatory? | Description |
query | Y | String fragment to match against. |
bounds | N | Bounds to filter the response |
| pagination | expanded | |
| size | N | Maximum number of results to return. Min = 1, Max = 200 Default = 20 |
| start | N | First result to return. If "size" is 20 and your request returns a "total" of 30, submit a second request with "start" = 21 to retrieve the remaining results. |
Sample request
{
"query":"transport",
"bounds":{"left":"144.96","bottom":"-37.817","right":"144.962","top":"-37.815"}
}
Sample response
{
"results": [
{
"id": "poi-7397",
"name": "ANZ ATM - 388 Collins St Branch (Smart ATM)",
"type": "Atms",
"centrePoint": {
"lon": 144.9617284,
"lat": -37.8167765001
},
"streetPoint": {
"lon": 144.9617411,
"lat": -37.8168207998
},
"address": {
"number": "388",
"street": {
"name": "COLLINS STREET",
"display": "COLLINS STREET"
},
"property": "388 COLLINS STREET",
"suburb": "MELBOURNE",
"suburbVanities": [
"MELB"
],
"postcode": "3000",
"regions": [
"GREATER MELBOURNE",
"MELBOURNE - INNER CITY SUBURBS",
"MELBOURNE CBD",
"MELBOURNE COUNCIL"
],
"state": "VIC",
"display": "388 COLLINS STREET, MELBOURNE, VIC 3000"
},
"geometry": {
"centre": {
"lon": 144.9617284,
"lat": -37.8167765001
},
"street": {
"lon": 144.9617411,
"lat": -37.8168207998
}
},
"approximated": false,
"granularity": "PROPERTY"
},
...
]
}
NOTES
For a full list of POI categories go to Appendix 10 - POI categories