https://openmenu.com/api/v2/search_analysis.php?key=[API_KEY] + parameters

Parameters
key
[required] key for access to the API (get/view your key)
format: api key
offset
[not required] offset of results to get (paging)
format: integer (default: 0)
s
[required] part or full string (searches menu item name and description)
format: string
postal_code
[not required] Limit the results to a location.
format: postal code to limit search results
city
[not required] Limit the results to a location.
format: string
state
[not required] Force the results to be limited to a single state.
format: 2 characters (two-digit code)
country
[required] Limit the results to a single country.
format: ISO 3166-1 alpha-2
Return Values
api
Returns details about the API and call
  • status: see below Return Status Codes
  • api_version: 2.2
  • format: json
  • api_key: [your api key]
type
what was the search phrase matched against: words | phrases | menu_items
results
return of result(s) with the following structure
  • openmenu_id: guid
  • matched: 2 - 125 characters
  • restaurant_name: 2 - 255 characters
  • longitude: 0 - 11 characters: (-)nnn.nnnnnn
  • latitude: 0 - 10 characters: (-)nn.nnnnnn
  • city_town: 2 - 50 characters
  • state_province: 2 characters (two-digit code)
  • postal_code: 0 - 30 characters
  • country: ISO 3166-1 alpha-2
  • first_occurrence_postion: integer
  • total_frequency: integer
  • weight: float
Return Status Codes
200
successful call
204
call resulted in an empty resultset
400
incorrect or missing API key
404
incorrect or missing required parameter
429
call limit exceeded on API key (check your limit)
Sample Response
Notes
  • use an ID of 'sample' (no quotes, no other options) for a sample result that doesn't count against your credits.