All URIs are relative to https://chompthis.com/api/v2
| Method | HTTP request | Description |
|---|---|---|
| FoodBrandedBarcodePhpGet | Get /food/branded/barcode.php | Get a branded food item using a barcode |
| FoodBrandedNamePhpGet | Get /food/branded/name.php | Get a branded food item by name |
| FoodBrandedSearchPhpGet | Get /food/branded/search.php | Get data for branded food items using various search parameters |
| FoodIngredientSearchPhpGet | Get /food/ingredient/search.php | Get raw/generic food ingredient item(s) |
| RecipeIdPhpGet | Get /recipe/id.php | Get a recipe by ID |
| RecipeIngredientPhpGet | Get /recipe/ingredient.php | Get recipes using a list of ingredients |
| RecipeRandomPhpGet | Get /recipe/random.php | Get random popular recipes |
| RecipeSearchPhpGet | Get /recipe/search.php | Get recipes using a title and optional filters |
BrandedFoodObject FoodBrandedBarcodePhpGet(ctx, code, optional) Get a branded food item using a barcode
Get data for a branded food using the food's UPC/EAN barcode. You must have a Food API key to use this endpoint. Get a Food API key. Example > https://chompthis.com/api/v2/food/branded/barcode.php?api_key=API_KEY&code=CODE Tips * Read our Knowledge Base article for helpful tips and tricks. * Perform a check-digit on the barcode you are using. * Use a barcode from our website ChompThis.com. Search for a food and use the barcode shown in the search results. * It is possible that our database contains the food you're looking for, but does not have the same barcode you are using. This can happen if a manufacturer introduces a variation of the same food, or the barcode you got was from a 2 oz bag of chips when our database has the food packaged in a 4 oz bag. * Contact us if you are having trouble.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| code | string | #### UPC/EAN barcode Example > ```&code=0842234000988``` | |
| optional | *DefaultApiFoodBrandedBarcodePhpGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DefaultApiFoodBrandedBarcodePhpGetOpts struct
| Name | Type | Description | Notes |
|---|
userId | optional.String| #### Only required for Premium subscribers. The unique identifier assigned to each user on your platform. This can be any string of letters or numbers and doesn't have to relate to your own database. Learn more Example > ```&user_id=fehef8w4ha``` |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
BrandedFoodObject FoodBrandedNamePhpGet(ctx, name, optional) Get a branded food item by name
Search for branded food items by name. You must have a Food API key to use this endpoint. Get a Food API key. Example > https://chompthis.com/api/v2/food/branded/name.php?api_key=API_KEY&name=NAME Tips * Get started by using our food lookup tool. > This API endpoint is only available to Standard and Premium API subscribers. Please consider upgrading your subscription if you are subscribed to the Limited plan. Read this if you aren't sure how to upgrade your subscription.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| name | string | #### 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``` | |
| optional | *DefaultApiFoodBrandedNamePhpGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DefaultApiFoodBrandedNamePhpGetOpts struct
| Name | Type | Description | Notes |
|---|
limit | optional.Int32| #### Set maximum number of records you want the API to return. The default value is "10." Example > ```&limit=10``` | page | optional.Int32| #### 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``` | userId | optional.String| #### Only required for Premium subscribers. The unique identifier assigned to each user on your platform. This can be any string of letters or numbers and doesn't have to relate to your own database. Learn more Example > ```&user_id=fehef8w4ha``` |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
BrandedFoodObject FoodBrandedSearchPhpGet(ctx, optional) Get data for branded food items using various search parameters
Search for branded food items using various parameters. You must have a Food API key to use this endpoint. Get a Food API key. Example > https://chompthis.com/api/v2/food/branded/search.php?api_key=API_KEY&brand=BRAND&country=COUNTRY&page=1 Tips * Get started by using the Query Builder. > This API endpoint is only available to Standard and Premium API subscribers. Please consider upgrading your subscription if you are subscribed to the Limited plan. Read this if you aren't sure how to upgrade your subscription.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *DefaultApiFoodBrandedSearchPhpGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DefaultApiFoodBrandedSearchPhpGetOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| allergen | optional.String | #### 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 | optional.String | #### Filter the search to only include branded foods that are owned by a specific brand. Example > ```&brand=Starbucks``` | |
| category | optional.String | #### Filter the search to only include branded foods from a specific category. Example > ```&category=Plant Based Foods``` | |
| country | optional.String | #### 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 | optional.String | #### 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 | optional.String | #### Filter the search to only include branded foods that contain a specific ingredient. Example > ```&ingredient=Salt``` | |
| keyword | optional.String | #### 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 | optional.String | #### Filter the search to only include branded foods that contain a specific mineral. Example > ```&mineral=Potassium``` | |
| nutrient | optional.String | #### 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. | |
| palmOil | optional.String | #### Filter the search to only include branded foods that contain a specific ingredient made using palm oil. Example > ```&palm_oil=E160a Beta Carotene``` | |
| trace | optional.String | ### 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 | optional.String | #### Filter the search to only include branded foods that contain a specific vitamin. Example > ```&vitamin=Biotin``` | |
| limit | optional.Int32 | #### Set maximum number of records you want the API to return. The default value is "10." Example > ```&limit=10``` | |
| page | optional.Int32 | #### 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``` | |
| userId | optional.String | #### Only required for Premium subscribers. The unique identifier assigned to each user on your platform. This can be any string of letters or numbers and doesn't have to relate to your own database. Learn more Example > ```&user_id=fehef8w4ha``` |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IngredientObject FoodIngredientSearchPhpGet(ctx, find, optional) Get raw/generic food ingredient item(s)
Get data for a specific ingredient or a specific set of ingredients. You must have a Food API key to use this endpoint. Get a Food API key. Example #1: Single Ingredient > https://chompthis.com/api/v2/food/ingredient/search.php?api_key=API_KEY&find=raw broccoli Example #2: Set of Ingredients > https://chompthis.com/api/v2/food/ingredient/search.php?api_key=API_KEY&find=raw broccoli,mashed potatoes,chicken drumstick Tips * Expose ingredient endpoints by using our food lookup tool. > This API endpoint is only available to Standard and Premium API subscribers. Please consider upgrading your subscription if you are subscribed to the Limited plan. Read this if you aren't sure how to upgrade your subscription.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| find | string | 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. | |
| optional | *DefaultApiFoodIngredientSearchPhpGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DefaultApiFoodIngredientSearchPhpGetOpts struct
| Name | Type | Description | Notes |
|---|
limit | optional.Int32| #### Set maximum number of records you want the API to return, per search term. The default value is "1." Example > ```&limit=3``` | userId | optional.String| #### Only required for Premium subscribers. The unique identifier assigned to each user on your platform. This can be any string of letters or numbers and doesn't have to relate to your own database. Learn more Example > ```&user_id=fehef8w4ha``` |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RecipeObject RecipeIdPhpGet(ctx, id, optional) Get a recipe by ID
Get a specific recipe using an ID. You must have a Recipe API key to use this endpoint. Get a Recipe API key. Example > https://chompthis.com/api/v2/recipe/id.php?api_key=API_KEY&id=RECIPE_ID
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | #### A recipe ID. Recipe IDs are exposed in the /recipe/search and /recipe/ingredient endpoints. Example > ```&list=tdm_1143_0459d0028fcf8990724785b9e6775037``` | |
| optional | *DefaultApiRecipeIdPhpGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DefaultApiRecipeIdPhpGetOpts struct
| Name | Type | Description | Notes |
|---|
userId | optional.String| #### Only required for Premium subscribers. The unique identifier assigned to each user on your platform. This can be any string of letters or numbers and doesn't have to relate to your own database. Learn more Example > ```&user_id=fehef8w4ha``` |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RecipeObject RecipeIngredientPhpGet(ctx, list, optional) Get recipes using a list of ingredients
Get recipes that include all ingredients from a list. You must have a Recipe API key to use this endpoint. Get a Recipe API key. Example #1 > https://chompthis.com/api/v2/recipe/ingredient.php?api_key=API_KEY&list=INGREDIENT Example #2 > https://chompthis.com/api/v2/recipe/ingredient.php?api_key=API_KEY&list=INGREDIENT,INGREDIENT,INGREDIENT
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| list | string | #### A single ingredient, or a comma-separated list of up to 3 ingredients. Recipes with each of these ingredients will be returned. You can pass in up to 3 ingredients at a time. Example > ```&list=cheese,tomato,milk``` | |
| optional | *DefaultApiRecipeIngredientPhpGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DefaultApiRecipeIngredientPhpGetOpts struct
| Name | Type | Description | Notes |
|---|
limit | optional.Int32| #### Set maximum number of records you want the API to return. The default value is "3." Example > ```&limit=3``` | page | optional.Int32| #### This is how you paginate the search result. By default, you will see the first 3 records. You must increment the page number to access the next 3 records, and so on. The default value is "1." Example > ```&page=1``` | userId | optional.String| #### Only required for Premium subscribers. The unique identifier assigned to each user on your platform. This can be any string of letters or numbers and doesn't have to relate to your own database. Learn more Example > ```&user_id=fehef8w4ha``` |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RecipeObject RecipeRandomPhpGet(ctx, optional) Get random popular recipes
Get random recipes that have instructions and nutrients You must have a Recipe API key to use this endpoint. Get a Recipe API key. Example > https://chompthis.com/api/v2/recipe/random.php?api_key=API_KEY
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *DefaultApiRecipeRandomPhpGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DefaultApiRecipeRandomPhpGetOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | optional.Int32 | #### Set maximum number of records you want the API to return. The default value is "5." Example > ```&limit=5``` | |
| userId | optional.String | #### Only required for Premium subscribers. The unique identifier assigned to each user on your platform. This can be any string of letters or numbers and doesn't have to relate to your own database. Learn more Example > ```&user_id=fehef8w4ha``` |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RecipeObject RecipeSearchPhpGet(ctx, title, optional) Get recipes using a title and optional filters
Get recipes using a title and optional filters. You must have a Recipe API key to use this endpoint. Get a Recipe API key. Example > https://chompthis.com/api/v2/recipe/search.php?api_key=API_KEY&title=TITLE
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| title | string | #### A recipe title Example > ```&title=Banana Bread``` | |
| optional | *DefaultApiRecipeSearchPhpGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a DefaultApiRecipeSearchPhpGetOpts struct
| Name | Type | Description | Notes |
|---|
excludedCuisine | optional.String| #### A specific cuisine you want excluded from results Example > ```&excluded_cuisine=Italian``` | includedCuisine | optional.String| #### A specific cuisine you want included in results Example > ```&included_cuisine=Chinese``` | excludedIngredient | optional.String| #### Recipes with this ingredient will be excluded from results Example > ```&excluded_ingredient=egg``` | includedIngredient | optional.String| #### Only recipes with this ingredient will be returned Example > ```&included_ingredient=apple``` | nutrientsRequired | optional.Int32| #### Optionally require all recipes to include nutrition info. Recipes with, or without, nutrition info are returned by default. Example > ```&nutrients_required=1``` | limit | optional.Int32| #### Set maximum number of records you want the API to return. The default value is "5." Example > ```&limit=3``` | page | optional.Int32| #### This is how you paginate the search result. By default, you will see the first 5 records. You must increment the page number to access the next 5 records, and so on. The default value is "1." Example > ```&page=1``` | userId | optional.String| #### Only required for Premium subscribers. The unique identifier assigned to each user on your platform. This can be any string of letters or numbers and doesn't have to relate to your own database. Learn more Example > ```&user_id=fehef8w4ha``` |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]