{"note":"OpenAPI conversion -- returning structured metadata","name":"chompthis-com","description":"Chomp Food Database API Documentation","version":"1.0.0-oas3","base_url":"https://chompthis.com/api/v2","endpoints":4,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Chomp Food Database API Documentation\n@base https://chompthis.com/api/v2\n@version 1.0.0-oas3\n@auth ApiKey api_key in query\n@endpoints 4\n@toc food(4)\n\n@endpoint GET /food/branded/barcode.php\n@desc Get a branded food item using a barcode\n@required {code: str # #### UPC/EAN barcode  **Example** > ```&code=0842234000988```}\n@returns(200) {items: [map]} # **Valid** - Will return an object containing any matching foods.\n@errors {400: **Validation error** - Invalid parameters or request., 401: **Unauthorized** - Invalid API key, unauthorized access, or usage limits exceeded. ***[More information »](https://desk.zoho.com/portal/chompthis/kb/articles/what-is-a-rate-limit)***, 404: **Not found** - No food items were found., 500: **Server error** - Internal server error, request failed, or base error. *Please **[contact us](https://chompthis.com/api/ticket-new.php)** if you see this.*}\n\n@endpoint GET /food/branded/name.php\n@desc Get a branded food item by name\n@required {name: str # #### Search for branded food items using a general food name keyword. This does not have to exactly match the \"official\" name for the food.  **Example** > ```&name=Starburst```}\n@optional {limit: int(1/2/3/4/5/6/7/8/9/10) # #### Set maximum number of records you want the API to return. The default value is \"**10**.\"  **Example** > ```&limit=10```, page: int # #### This is how you paginate the search result. By default, you will see the first 10 records. You must increment the page number to access the next 10 records, and so on. The default value is \"**1**.\"  **Example** > ```&page=1```}\n@returns(200) {items: [map]} # **Valid** - Will return an object containing any matching foods.\n@errors {400: **Validation error** - Invalid parameters or request., 401: **Unauthorized** - Invalid API key, unauthorized access, or usage limits exceeded. ***[More information »](https://desk.zoho.com/portal/chompthis/kb/articles/what-is-a-rate-limit)***, 404: **Not found** - No food items were found., 500: **Server error** - Internal server error, request failed, or base error. *Please **[contact us](https://chompthis.com/api/ticket-new.php)** if you see this.*}\n\n@endpoint GET /food/branded/search.php\n@desc Get data for branded food items using various search parameters\n@optional {allergen: str # #### Filter the search to only include branded foods that contain a specific allergen.  **Example** > ```&allergen=Peanuts```  **Important Note**: This parameter cannot be used alone. It must be paired with at least 1 additional parameter., brand: str # #### Filter the search to only include branded foods that are owned by a specific brand.  **Example** > ```&brand=Starbucks```, category: str # #### Filter the search to only include branded foods from a specific category.  **Example** > ```&category=Plant Based Foods```, country: str # #### Filter the search to only include branded foods that are sold in a specific country.  **Example** > ```&country=United States```  **Important Note**: This parameter cannot be used alone. It must be paired with at least 1 additional parameter., diet: str(Vegan/Vegetarian/Gluten Free) # #### Filter the search to only include branded foods that are considered compatible with a specific diet.  **Important Note**: This parameter cannot be used alone. It must be paired with at least 1 additional parameter., ingredient: str # #### Filter the search to only include branded foods that contain a specific ingredient.  **Example** > ```&ingredient=Salt```, keyword: str # #### Filter the search to only include branded foods that are associated with a specific keyword.  **Example** > ```&keyword=Organic```  **Important Note**: This parameter cannot be used alone. It must be paired with at least 1 additional parameter., mineral: str # #### Filter the search to only include branded foods that contain a specific mineral.  **Example** > ```&mineral=Potassium```, nutrient: str # #### Filter the search to only include branded foods that contain a specific nutrient.  **Example** > ```&nutrient=Caffeine```  **Important Note**: This parameter cannot be used alone. It must be paired with at least 1 additional parameter., palm_oil: str # #### Filter the search to only include branded foods that contain a specific ingredient made using palm oil.  **Example** > ```&palm_oil=E160a Beta Carotene```, trace: str # ### Filter the search to only include branded foods that contain a specific trace ingredient.  **Example** > ```&trace=Tree Nuts```  **Important Note**: This parameter cannot be used alone. It must be paired with at least 1 additional parameter., vitamin: str # #### Filter the search to only include branded foods that contain a specific vitamin.  **Example** > ```&vitamin=Biotin```, limit: int(1/2/3/4/5/6/7/8/9/10) # #### Set maximum number of records you want the API to return. The default value is \"**10**.\"  **Example** > ```&limit=10```, page: int # #### This is how you paginate the search result. By default, you will see the first 10 records. You must increment the page number to access the next 10 records, and so on. The default value is \"**1**.\"  **Example** > ```&page=1```}\n@returns(200) {items: [map]} # **Valid** - Will return an object containing any matching foods.\n@errors {400: **Validation error** - Invalid parameters or request., 401: **Unauthorized** - Invalid API key, unauthorized access, or usage limits exceeded. ***[More information »](https://desk.zoho.com/portal/chompthis/kb/articles/what-is-a-rate-limit)***, 404: **Not found** - No food items were found., 500: **Server error** - Internal server error, request failed, or base error. *Please **[contact us](https://chompthis.com/api/ticket-new.php)** if you see this.*}\n\n@endpoint GET /food/ingredient/search.php\n@desc Get raw/generic food ingredient item(s)\n@required {find: str # Search our database for a single ingredient or a specific set of ingredients.  **Example #1: Single Ingredient** > ```&find=raw broccoli```  **Example #2: Set of Ingredients** > ```&find=raw broccoli,buttermilk waffle,mashed potatoes```  **Important Notes**    * Comma-separated lists cannot contain more than **10 ingredients**. You must perform additional API calls if you are looking up more than 10 ingredients.}\n@optional {limit: int(1/2/3) # #### Set maximum number of records you want the API to return, per search term. The default value is \"**1**.\"  **Example** > ```&limit=3```}\n@returns(200) {items: [map]} # **Valid** - Will return an object containing any matching ingredient foods.\n@errors {400: **Validation error** - Invalid parameters or request., 401: **Unauthorized** - Invalid API key, unauthorized access, or usage limits exceeded. ***[More information »](https://desk.zoho.com/portal/chompthis/kb/articles/what-is-a-rate-limit)***, 404: **Not found** - No food items were found., 500: **Server error** - Internal server error, request failed, or base error. *Please **[contact us](https://chompthis.com/api/ticket-new.php)** if you see this.*}\n\n@end\n"}