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

Parameters
key
[required] key for access to the API (get/view your key)
format: api key
id
[required] id which was provided by the results of a search call
format: generated key
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]
id
Generated key for the restaurant
restaurant_info
  • restaurant_name: 2 - 255 characters
  • brief_description: 2 - 255 characters
  • full_description: 0 - 2000 characters
  • location_id: 0 - 25 characters
  • mobile: 0 | 1 | null
  • 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
  • phone: numeric with punctuations (allowed: #*()-/_) 7-40 characters
  • fax: numeric with punctuations (allowed: #*()-/_) 7-40 characters
  • longitude: 0 - 11 characters: (-)nnn.nnnnnn
  • latitude: 0 - 10 characters: (-)nn.nnnnnn
  • business_type: franchisee | corporate | independent
  • utc_offset: 0 - 6 characters: (-)nn.nn
  • website_url: 0 - 120 characters starting with http://
environment_info
  • cuisine_type_primary: string
  • cuisine_type_secondary: string
  • smoking_allowed: 0 | 1 | null
  • takeout_available: 0 | 1 | null
  • seating_qty: integer
  • max_group_size: integer
  • pets_allowed: 0 | 1 | null
  • wheelchair_accessible: 0 | 1 | null
  • age_level_preference: (+/-)nnn
  • dress_code: none | casual | business-casual | business
  • delivery_available: 0 | 1 | null
  • delivery_radius: numeric (in km)
  • delivery_fee: umeric only, period separator for decimals
  • catering_available: 0 | 1 | null
  • reservations: 0 | 1 | Suggested | Required | null (0 = no | 1 = yes)
  • alcohol_type: Full Bar | Beer and Wine | Wine Only | Beer Only | None
  • music_type: Live | Pre-Recorded | DJ | Jukebox | None
operating_days
  • day_of_week: 1 digit (ISO 8601: mon:1, tue:2, wed:3, thu:4, fri:5, sat:6, sun:7)
  • open_time: hh:mm (ISO 8601 - 24 hour time)
  • close_time: hh:mm (ISO 8601 - 24 hour time)
  • open_time_ampm: hh:mm AM/PM
  • close_time_ampm: hh:mm AM/PM
  • day: string
  • day_short: 3 character
operating_days_printable
  • day_name: string
  • display: string
logo_urls
  • logo_url: URL starting with http:// in GIF|JPG|PNG format
seating_locations
  • seating_location: none | indoor | outdoor | rooftop | poolside | deck | cellar | pier | veranda | porch | beach | terrace | patio | sidewalk
accepted_currencies
  • accepted_currency: 3 characters (ISO 4217)
parking
  • street_free: 0 | 1 | null
  • street_metered: 0 | 1 | null
  • private_lot: 0 | 1 | null
  • garage: 0 | 1 | null
  • valet: 0 | 1 | null
settings
  • 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://
menus
  • menu_name: 2 - 50 characters
  • menu_description: 0 - 255 characters
  • menu_note: 0 - 255 characters
  • currency_symbol: 3 characters (ISO 4217)
  • language: 2 characters (ISO 639-1 alpha-2)
  • menu_duration_name: breakfast | brunch | lunch | breakfast-lunch | dinner | lunch-dinner | late-night | all
  • menu_duration_time_start: hh:mm (ISO 8601 - 24 hour time)
  • menu_duration_time_end: hh:mm (ISO 8601 - 24 hour time)
  • menu_groups
    • group_name: 2 - 50 characters
    • group_note: 0 - 255 characters
    • group_description: 0 - 255 characters
    • menu_group_options
      • option: structure
    • menu_items
      • menu_item_name: 2 - 75 characters
      • menu_item_description: 0 - 450 characters
      • menu_item_price: numeric
      • menu_item_calories: numeric
      • menu_item_heat_index: 0-5 | null
      • menu_item_allergy_information: 0 - 450 character
      • menu_item_allergy_information_allergens: Egg | Fish | Dairy | Peanut | Shellfish | Soy |Tree Nut | Wheat | Gluten
      • 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_options
        • option: structure
      • menu_item_sizes
        • size: structure
      • menu_item_images
        • images: structure
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.