{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/search/location/:input","auth":"optional","method":"get","params":[{"name":"input","type":"string","default":"","desc":"User input when searching for a location, usually a US city.","required":true,"in":"path","ref":"","_id":"560eb71bcac9dc0d007af877"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"locations\": [\n    {\n      \"id\": 2303,\n      \"city\": \"Orlando\",\n      \"state\": \"Florida\",\n      \"county\": \"Orange\",\n      \"area_code\": \"321\",\n      \"population\": 185951,\n      \"latitude\": \"28.538\",\n      \"longitude\": \"-81.379\"\n    },\n    {\n      \"id\": 4028,\n      \"city\": \"Orland Park\",\n      \"state\": \"Illinois\",\n      \"county\": \"Cook\",\n      \"area_code\": \"708\",\n      \"population\": 51077,\n      \"latitude\": \"41.63\",\n      \"longitude\": \"-87.853\"\n    },\n    {\n      \"id\": 4027,\n      \"city\": \"Orland Hills\",\n      \"state\": \"Illinois\",\n      \"county\": \"Cook\",\n      \"area_code\": \"708\",\n      \"population\": 6779,\n      \"latitude\": \"41.585\",\n      \"longitude\": \"-87.843\"\n    },\n    {\n      \"id\": 7872,\n      \"city\": \"Orleans\",\n      \"state\": \"Massachusetts\",\n      \"county\": \"Barnstable\",\n      \"area_code\": \"508\",\n      \"population\": 6341,\n      \"latitude\": \"41.789\",\n      \"longitude\": \"-69.99\"\n    },\n    {\n      \"id\": 1374,\n      \"city\": \"Orland\",\n      \"state\": \"California\",\n      \"county\": \"Glenn\",\n      \"area_code\": \"530\",\n      \"population\": 6281,\n      \"latitude\": \"39.747\",\n      \"longitude\": \"-122.195\"\n    },\n    {\n      \"id\": 4778,\n      \"city\": \"Orleans\",\n      \"state\": \"Indiana\",\n      \"county\": \"Orange\",\n      \"area_code\": \"812\",\n      \"population\": 2273,\n      \"latitude\": \"38.661\",\n      \"longitude\": \"-86.451\"\n    },\n    {\n      \"id\": 7359,\n      \"city\": \"Orland\",\n      \"state\": \"Maine\",\n      \"county\": \"Hancock\",\n      \"area_code\": \"207\",\n      \"population\": 2134,\n      \"latitude\": \"44.57\",\n      \"longitude\": \"-68.736\"\n    },\n    {\n      \"id\": 18488,\n      \"city\": \"Orleans\",\n      \"state\": \"Vermont\",\n      \"county\": \"Orleans\",\n      \"area_code\": \"802\",\n      \"population\": 826,\n      \"latitude\": \"44.816\",\n      \"longitude\": \"-72.233\"\n    },\n    {\n      \"id\": 17030,\n      \"city\": \"Orlinda\",\n      \"state\": \"Tennessee\",\n      \"county\": \"Robertson\",\n      \"area_code\": \"615\",\n      \"population\": 594,\n      \"latitude\": \"36.6\",\n      \"longitude\": \"-86.716\"\n    },\n    {\n      \"id\": 10920,\n      \"city\": \"Orleans\",\n      \"state\": \"Nebraska\",\n      \"county\": \"Harlan\",\n      \"area_code\": \"308\",\n      \"population\": 425,\n      \"latitude\": \"40.129\",\n      \"longitude\": \"-99.455\"\n    },\n    {\n      \"id\": 4777,\n      \"city\": \"Orland\",\n      \"state\": \"Indiana\",\n      \"county\": \"Steuben\",\n      \"area_code\": \"260\",\n      \"population\": 341,\n      \"latitude\": \"41.73\",\n      \"longitude\": \"-85.171\"\n    },\n    {\n      \"id\": 14890,\n      \"city\": \"Orlando\",\n      \"state\": \"Oklahoma\",\n      \"county\": \"Logan\",\n      \"area_code\": \"580\",\n      \"population\": 201,\n      \"latitude\": \"36.148\",\n      \"longitude\": \"-97.377\"\n    }\n  ]\n}","name":"Results starting with \"orl\""}]},"settings":""},"next":{"description":"","pages":[]},"title":"Location Search","type":"endpoint","slug":"location-search","excerpt":"Create an auto-complete search engine for location searching.","body":"** JSON Response **\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Value\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`locations`\",\n    \"0-1\": \"Array of [Location](doc:location)s\",\n    \"0-2\": \"An array of [Location](doc:location) objects matching the user's input, ordered by descending `population`.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\nThis API allows your iExit client to build a location search engine. Results returned by this input-matching API are currently just US cities, as iExit is only supported in the US right now.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/Pklsf5YOSZqc0r4ca89A_LocationSearchOrlandoWifi.png\",\n        \"LocationSearchOrlandoWifi.png\",\n        \"720\",\n        \"1280\",\n        \"#2fb35e\",\n        \"\"\n      ],\n      \"caption\": \"The `Location Search` API in use inside the iExit Android app.\"\n    }\n  ]\n}\n[/block]\n** Common Next API(s) **\n- [Nearby POIs](doc:nearby-pois) (by using `locations[]`.`latitude` and `locations[]`.`longitude`)","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"560dab7561f78a2300660adf","githubsync":"","project":"560d5ac71ec45619006069d6","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Search Components","slug":"search-components","order":4,"from_sync":false,"reference":false,"_id":"560dabb698a6ae3700673f9f","project":"560d5ac71ec45619006069d6","version":"560d5ac71ec45619006069d9","__v":0,"createdAt":"2015-10-01T21:55:02.327Z"},"user":"560d5a4faf97231900938125","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["560d5ac81ec45619006069da","560dabb698a6ae3700673f9f","560dabe1961d492300d94b4b","560dac2cd10a730d0081ac92","560dacb26660a03700976de4","560ebbffcac9dc0d007af87a"],"_id":"560d5ac71ec45619006069d9","releaseDate":"2015-10-01T16:09:43.711Z","__v":6,"createdAt":"2015-10-01T16:09:43.711Z","project":"560d5ac71ec45619006069d6"},"__v":1,"createdAt":"2015-10-01T21:53:57.048Z","editedParams":true,"editedParams2":true,"parentDoc":null}

getLocation Search

Create an auto-complete search engine for location searching.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

input:
required
string
User input when searching for a location, usually a US city.

Result Format


Documentation

** JSON Response ** [block:parameters] { "data": { "h-0": "Key", "h-1": "Value", "h-2": "Description", "0-0": "`locations`", "0-1": "Array of [Location](doc:location)s", "0-2": "An array of [Location](doc:location) objects matching the user's input, ordered by descending `population`." }, "cols": 3, "rows": 1 } [/block] This API allows your iExit client to build a location search engine. Results returned by this input-matching API are currently just US cities, as iExit is only supported in the US right now. [block:image] { "images": [ { "image": [ "https://files.readme.io/Pklsf5YOSZqc0r4ca89A_LocationSearchOrlandoWifi.png", "LocationSearchOrlandoWifi.png", "720", "1280", "#2fb35e", "" ], "caption": "The `Location Search` API in use inside the iExit Android app." } ] } [/block] ** Common Next API(s) ** - [Nearby POIs](doc:nearby-pois) (by using `locations[]`.`latitude` and `locations[]`.`longitude`)

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}