menu
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 or analysis_search call
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_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.