https://openmenu.com/api/v2/menu.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
format: generated key

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
  • mi_name: 2 - 75 characters
  • mi_description: 0 - 450 characters
  • avg_price: numeric
  • first_occurrence_postion: integer
  • frequency: integer
  • has_fish: float (confidence score)
  • has_shellfish: float (confidence score)
  • has_poultry: float (confidence score)
  • has_pork: float (confidence score)
  • has_beef: float (confidence score)
  • has_lamb: float (confidence score)
  • typeof_dessert: float (confidence score)
  • typeof_appetizer: float (confidence score)
  • typeof_side: float (confidence score)
  • typeof_sandwich: float (confidence score)
  • typeof_salad: float (confidence score)
  • typeof_beverage: float (confidence score)
  • typeof_burger: float (confidence score)
  • typeof_pasta: float (confidence score)
  • typeof_pizza: float (confidence score)
  • heat_index: float (confidence score)
  • is_peppery_spicy: float (confidence score)
  • is_salty: float (confidence score)
  • is_cooling: float (confidence score)
  • is_garlicy: float (confidence score)
  • is_woody_earthy: float (confidence score)
  • is_tomatoey: float (confidence score)
  • is_floral: float (confidence score)
  • is_fruity: float (confidence score)
  • is_citrusy: float (confidence score)
  • is_sour: float (confidence score)
  • is_sweet: float (confidence score)
  • is_roasted_toasted: float (confidence score)
  • is_chocolatey: float (confidence score)
  • is_nutty: float (confidence score)
  • is_buttery: float (confidence score)
  • is_cheesy: float (confidence score)
  • is_bitter: float (confidence score)
  • is_dry: float (confidence score)
  • is_oaky: float (confidence score)
  • has_corn: float (confidence score)
  • has_oats: float (confidence score)
  • has_rice: float (confidence score)
  • has_wheat: float (confidence score)
  • has_cheese: float (confidence score)
  • has_eggs: float (confidence score)
  • has_milk: float (confidence score)
  • has_peanuts: float (confidence score)
  • has_nuts: float (confidence score)
  • has_coffee: float (confidence score)
  • has_oil: float (confidence score)
  • has_vinegar: float (confidence score)
  • served_plate: float (confidence score)
  • served_bowl: float (confidence score)
  • served_cup: float (confidence score)
  • served_skewer: float (confidence score)
  • feel_crunchy: float (confidence score)
  • feel_soft: float (confidence score)
  • feel_hard: float (confidence score)
  • temperature_hot: float (confidence score)
  • temperature_cold: float (confidence score)
  • temperature_room: float (confidence score)
  • cooked_baked: float (confidence score)
  • cooked_broiled: float (confidence score)
  • cooked_grilled: float (confidence score)
  • cooked_boiled: float (confidence score)
  • cooked_pan_fried: float (confidence score)
  • cooked_deep_fried: float (confidence score)
  • cooked_flambe: float (confidence score)
  • cooked_roasted: float (confidence score)
  • cooked_sauteed: float (confidence score)
  • cooked_blanched: float (confidence score)
  • cooked_braised: float (confidence score)
  • cooked_poached: float (confidence score)
  • typeof_alcohol: float (confidence score)
  • typeof_coffee: float (confidence score)
  • typeof_beer: float (confidence score)
  • typeof_wine: float (confidence score)
  • typeof_softdrink: float (confidence score)
  • typeof_juice: float (confidence score)
  • typeof_mead: float (confidence score)
  • typeof_hardcider: float (confidence score)
  • typeof_cocktail: float (confidence score)
  • add_fruit: float (confidence score)
  • add_organge_juice: float (confidence score)
  • add_cranberry_juice: float (confidence score)
  • add_cherries: float (confidence score)
  • add_bitters: float (confidence score)
  • add_ice: float (confidence score)
  • add_lemon: float (confidence score)
  • add_soda_water: float (confidence score)
  • add_coke: float (confidence score)
  • add_sprite: float (confidence score)
  • add_lemon_juice: float (confidence score)
  • add_mint: float (confidence score)
  • add_lime_juice: float (confidence score)
  • add_syrup: float (confidence score)
  • add_blue_curacao: float (confidence score)
  • add_strawberry: float (confidence score)
  • has_grand_marnier: float (confidence score)
  • has_vodka: float (confidence score)
  • has_gin: float (confidence score)
  • has_tequila: float (confidence score)
  • has_bourbon: float (confidence score)
  • has_whiskey: float (confidence score)
  • has_rye: float (confidence score)
  • has_sake: float (confidence score)
  • has_brandy: float (confidence score)
  • has_rum: float (confidence score)
  • has_absinthe: float (confidence score)
  • has_vermouth: float (confidence score)
  • has_cointreau: float (confidence score)
  • has_triple_sec: float (confidence score)
  • has_cognac: float (confidence score)
  • has_kahlua: 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.