https://openmenu.com/api/v2/search.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 with a max of 10 (default: 0)
s
[required] part or full string of a menu item or restaurant to search for
format: string
r
[not required] limit results to restaurants only (takes preference over the paramter mi)
format: 0 | 1
mi
[not required] limit results to menu items only
format: 0 | 1
postal_code
[required] Limit the results to a location. Must be present if city is not.
format: postal code to limit search results
city
[required] Limit the results to a location. Required if postal code is not passed.
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.0
  • format: json
  • api_key: [your api key]
restaurants
return of restaurants with the following structure
  • id: generated key
  • mobile: 0 | 1 | null
  • restaurant_name: 2 - 255 characters
  • brief_description: 2 - 255 characters
  • address_1: 2 - 120 characters
  • address_2: 0 - 120 characters
  • city_town: 2 - 50 characters
  • state_province: 2 characters (two-digit code)
  • postal_code: 0 - 30 characters
  • country: ISO 3166-1 alpha-2
  • longitude: 0 - 11 characters: (-)nnn.nnnnnn
  • latitude: 0 - 10 characters: (-)nn.nnnnnn
  • cuisine_type_primary: string
  • website_url: 0 - 120 characters starting with http://
  • social:
    • facebook: 0 - 120 characters starting with http://
    • twitter: 0 - 120 characters starting with http://
    • instagram: 0 - 120 characters starting with http://
    • pinterest: 0 - 120 characters starting with http://
    • youtube: 0 - 120 characters starting with http://
    • google+: 0 - 120 characters starting with http://
  • totals:
    • deals: integer
items
return of menu items from a specific restaurant with the following structure
  • id: generated key
  • menu_item_name: 2 - 75 characters
  • menu_item_description: 0 - 450 characters
  • menu_item_price: numeric
  • special: 0 | 1 | null
  • vegan: 0 | 1 | null
  • vegetarian: 0 | 1 | null
  • halal: 0 | 1 | null
  • kosher: 0 | 1 | null
  • gluten_free: 0 | 1 | null
  • menu_item_heat_index: 0-5 | null
  • image_url: 0 - 120 characters starting with http://
  • restaurant_name: 2 - 255 characters
  • address_1: 2 - 120 characters
  • address_2: 0 - 120 characters
  • city_town: 2 - 50 characters
  • state_province: 2 characters (two-digit code)
  • country: ISO 3166-1 alpha-2
  • longitude: 0 - 11 characters: (-)nnn.nnnnnn
  • latitude: 0 - 10 characters: (-)nn.nnnnnn
  • cuisine_type_primary: string
  • sizes:
    • size: structure
  • options:
    • option: structure
  • totals:
    • deals: integer
menus
return of sample menus for a specific restaurant with the following structure
  • id: generated key
  • restaurant_name: 2 - 255 characters
  • items:
    • menu_item_name: 2 - 75 characters
    • menu_item_description: 0 - 450 characters
    • menu_item_price: numeric
    • special: 0 | 1 | null
    • vegan: 0 | 1 | null
    • vegetarian: 0 | 1 | null
    • halal: 0 | 1 | null
    • kosher: 0 | 1 | null
    • gluten_free: 0 | 1 | null
    • menu_item_heat_index: 0-5 | null
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 a search term of 'sample' (no quotes, no other options) for a sample result that doesn't count against your credits.