https://openmenu.com/api/v2/menu_items.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
taxonomies
[not required] Filter by a taxonomy and a float (0-1) to match/excced. Valid taxonomies: has_fish, has_shellfish, has_beef, has_poultry, has_pork, has_lamb, is_appetizer, is_salad, is_side, is_burger
format: JSON array (ex. {"has_shellfish":1,"is_appetizer":1})

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]
menu_items
return of menu item(s) with the following structure
  • openmenu_id: guid
  • mi_name: 2 - 75 characters
  • mi_description: 0 - 450 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
  • avg_price: numeric
  • first_occurrence_postion: integer
  • frequency: integer
  • has_fish: float (confidence score)
  • has_shellfish: float (confidence score)
  • has_beef: float (confidence score)
  • has_poultry: float (confidence score)
  • has_pork: float (confidence score)
  • has_lamb: float (confidence score)
  • is_appetizer: float (confidence score)
  • is_salad: float (confidence score)
  • is_side: float (confidence score)
  • is_burger: float (confidence score)

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.