All URIs are relative to https://api.spoonacular.com
| Method | HTTP request | Description |
|---|---|---|
| AutocompleteIngredientSearch | Get /food/ingredients/autocomplete | Autocomplete Ingredient Search |
| ComputeIngredientAmount | Get /food/ingredients/{id}/amount | Compute Ingredient Amount |
| GetIngredientInformation | Get /food/ingredients/{id}/information | Get Ingredient Information |
| GetIngredientSubstitutes | Get /food/ingredients/substitutes | Get Ingredient Substitutes |
| GetIngredientSubstitutesByID | Get /food/ingredients/{id}/substitutes | Get Ingredient Substitutes by ID |
| IngredientSearch | Get /food/ingredients/search | Ingredient Search |
| IngredientsByIDImage | Get /recipes/{id}/ingredientWidget.png | Ingredients by ID Image |
| MapIngredientsToGroceryProducts | Post /food/ingredients/map | Map Ingredients to Grocery Products |
| VisualizeIngredients | Post /recipes/visualizeIngredients | Ingredients Widget |
[]AutocompleteIngredientSearch200ResponseInner AutocompleteIngredientSearch(ctx).Query(query).Number(number).MetaInformation(metaInformation).Intolerances(intolerances).Language(language).Execute()
Autocomplete Ingredient Search
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ddsky/spoonacular-api-clients/go"
)
func main() {
query := "burger" // string | The (natural language) search query.
number := int32(10) // int32 | The maximum number of items to return (between 1 and 100). Defaults to 10. (optional) (default to 10)
metaInformation := false // bool | Whether to return more meta information about the ingredients. (optional)
intolerances := "egg" // string | A comma-separated list of intolerances. All recipes returned must not contain ingredients that are not suitable for people with the intolerances entered. See a full list of supported intolerances. (optional)
language := "en" // string | The language of the input. Either 'en' or 'de'. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IngredientsAPI.AutocompleteIngredientSearch(context.Background()).Query(query).Number(number).MetaInformation(metaInformation).Intolerances(intolerances).Language(language).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IngredientsAPI.AutocompleteIngredientSearch``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AutocompleteIngredientSearch`: []AutocompleteIngredientSearch200ResponseInner
fmt.Fprintf(os.Stdout, "Response from `IngredientsAPI.AutocompleteIngredientSearch`: %v\n", resp)
}Other parameters are passed through a pointer to a apiAutocompleteIngredientSearchRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| query | string | The (natural language) search query. | |
| number | int32 | The maximum number of items to return (between 1 and 100). Defaults to 10. | [default to 10] |
| metaInformation | bool | Whether to return more meta information about the ingredients. | |
| intolerances | string | A comma-separated list of intolerances. All recipes returned must not contain ingredients that are not suitable for people with the intolerances entered. See a full list of supported intolerances. | |
| language | string | The language of the input. Either 'en' or 'de'. |
[]AutocompleteIngredientSearch200ResponseInner
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ComputeIngredientAmount200Response ComputeIngredientAmount(ctx, id).Nutrient(nutrient).Target(target).Unit(unit).Execute()
Compute Ingredient Amount
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ddsky/spoonacular-api-clients/go"
)
func main() {
id := int32(9266) // int32 | The id of the ingredient you want the amount for.
nutrient := "protein" // string | The target nutrient. See a list of supported nutrients.
target := int32(2) // int32 | The target number of the given nutrient.
unit := "oz" // string | The target unit. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IngredientsAPI.ComputeIngredientAmount(context.Background(), id).Nutrient(nutrient).Target(target).Unit(unit).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IngredientsAPI.ComputeIngredientAmount``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ComputeIngredientAmount`: ComputeIngredientAmount200Response
fmt.Fprintf(os.Stdout, "Response from `IngredientsAPI.ComputeIngredientAmount`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | The id of the ingredient you want the amount for. |
Other parameters are passed through a pointer to a apiComputeIngredientAmountRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
nutrient | string | The target nutrient. See a list of supported nutrients. | target | int32 | The target number of the given nutrient. | unit | string | The target unit. |
ComputeIngredientAmount200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IngredientInformation GetIngredientInformation(ctx, id).Amount(amount).Unit(unit).Execute()
Get Ingredient Information
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ddsky/spoonacular-api-clients/go"
)
func main() {
id := int32(9266) // int32 | The ingredient id.
amount := float32(150) // float32 | The amount of this ingredient. (optional)
unit := "grams" // string | The unit for the given amount. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IngredientsAPI.GetIngredientInformation(context.Background(), id).Amount(amount).Unit(unit).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IngredientsAPI.GetIngredientInformation``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetIngredientInformation`: IngredientInformation
fmt.Fprintf(os.Stdout, "Response from `IngredientsAPI.GetIngredientInformation`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | The ingredient id. |
Other parameters are passed through a pointer to a apiGetIngredientInformationRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
amount | float32 | The amount of this ingredient. | unit | string | The unit for the given amount. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetIngredientSubstitutes200Response GetIngredientSubstitutes(ctx).IngredientName(ingredientName).Execute()
Get Ingredient Substitutes
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ddsky/spoonacular-api-clients/go"
)
func main() {
ingredientName := "butter" // string | The name of the ingredient you want to replace.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IngredientsAPI.GetIngredientSubstitutes(context.Background()).IngredientName(ingredientName).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IngredientsAPI.GetIngredientSubstitutes``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetIngredientSubstitutes`: GetIngredientSubstitutes200Response
fmt.Fprintf(os.Stdout, "Response from `IngredientsAPI.GetIngredientSubstitutes`: %v\n", resp)
}Other parameters are passed through a pointer to a apiGetIngredientSubstitutesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| ingredientName | string | The name of the ingredient you want to replace. |
GetIngredientSubstitutes200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetIngredientSubstitutes200Response GetIngredientSubstitutesByID(ctx, id).Execute()
Get Ingredient Substitutes by ID
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ddsky/spoonacular-api-clients/go"
)
func main() {
id := int32(1001) // int32 | The id of the ingredient you want substitutes for.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IngredientsAPI.GetIngredientSubstitutesByID(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IngredientsAPI.GetIngredientSubstitutesByID``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetIngredientSubstitutesByID`: GetIngredientSubstitutes200Response
fmt.Fprintf(os.Stdout, "Response from `IngredientsAPI.GetIngredientSubstitutesByID`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | The id of the ingredient you want substitutes for. |
Other parameters are passed through a pointer to a apiGetIngredientSubstitutesByIDRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
GetIngredientSubstitutes200Response
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IngredientSearch200Response IngredientSearch(ctx).Query(query).AddChildren(addChildren).MinProteinPercent(minProteinPercent).MaxProteinPercent(maxProteinPercent).MinFatPercent(minFatPercent).MaxFatPercent(maxFatPercent).MinCarbsPercent(minCarbsPercent).MaxCarbsPercent(maxCarbsPercent).MetaInformation(metaInformation).Intolerances(intolerances).Sort(sort).SortDirection(sortDirection).Offset(offset).Number(number).Language(language).Execute()
Ingredient Search
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ddsky/spoonacular-api-clients/go"
)
func main() {
query := "burger" // string | The (natural language) search query.
addChildren := true // bool | Whether to add children of found foods. (optional)
minProteinPercent := float32(10) // float32 | The minimum percentage of protein the food must have (between 0 and 100). (optional)
maxProteinPercent := float32(90) // float32 | The maximum percentage of protein the food can have (between 0 and 100). (optional)
minFatPercent := float32(10) // float32 | The minimum percentage of fat the food must have (between 0 and 100). (optional)
maxFatPercent := float32(90) // float32 | The maximum percentage of fat the food can have (between 0 and 100). (optional)
minCarbsPercent := float32(10) // float32 | The minimum percentage of carbs the food must have (between 0 and 100). (optional)
maxCarbsPercent := float32(90) // float32 | The maximum percentage of carbs the food can have (between 0 and 100). (optional)
metaInformation := false // bool | Whether to return more meta information about the ingredients. (optional)
intolerances := "egg" // string | A comma-separated list of intolerances. All recipes returned must not contain ingredients that are not suitable for people with the intolerances entered. See a full list of supported intolerances. (optional)
sort := "calories" // string | The strategy to sort recipes by. See a full list of supported sorting options. (optional)
sortDirection := "asc" // string | The direction in which to sort. Must be either 'asc' (ascending) or 'desc' (descending). (optional)
offset := int32(56) // int32 | The number of results to skip (between 0 and 900). (optional)
number := int32(10) // int32 | The maximum number of items to return (between 1 and 100). Defaults to 10. (optional) (default to 10)
language := "en" // string | The language of the input. Either 'en' or 'de'. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IngredientsAPI.IngredientSearch(context.Background()).Query(query).AddChildren(addChildren).MinProteinPercent(minProteinPercent).MaxProteinPercent(maxProteinPercent).MinFatPercent(minFatPercent).MaxFatPercent(maxFatPercent).MinCarbsPercent(minCarbsPercent).MaxCarbsPercent(maxCarbsPercent).MetaInformation(metaInformation).Intolerances(intolerances).Sort(sort).SortDirection(sortDirection).Offset(offset).Number(number).Language(language).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IngredientsAPI.IngredientSearch``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `IngredientSearch`: IngredientSearch200Response
fmt.Fprintf(os.Stdout, "Response from `IngredientsAPI.IngredientSearch`: %v\n", resp)
}Other parameters are passed through a pointer to a apiIngredientSearchRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| query | string | The (natural language) search query. | |
| addChildren | bool | Whether to add children of found foods. | |
| minProteinPercent | float32 | The minimum percentage of protein the food must have (between 0 and 100). | |
| maxProteinPercent | float32 | The maximum percentage of protein the food can have (between 0 and 100). | |
| minFatPercent | float32 | The minimum percentage of fat the food must have (between 0 and 100). | |
| maxFatPercent | float32 | The maximum percentage of fat the food can have (between 0 and 100). | |
| minCarbsPercent | float32 | The minimum percentage of carbs the food must have (between 0 and 100). | |
| maxCarbsPercent | float32 | The maximum percentage of carbs the food can have (between 0 and 100). | |
| metaInformation | bool | Whether to return more meta information about the ingredients. | |
| intolerances | string | A comma-separated list of intolerances. All recipes returned must not contain ingredients that are not suitable for people with the intolerances entered. See a full list of supported intolerances. | |
| sort | string | The strategy to sort recipes by. See a full list of supported sorting options. | |
| sortDirection | string | The direction in which to sort. Must be either 'asc' (ascending) or 'desc' (descending). | |
| offset | int32 | The number of results to skip (between 0 and 900). | |
| number | int32 | The maximum number of items to return (between 1 and 100). Defaults to 10. | [default to 10] |
| language | string | The language of the input. Either 'en' or 'de'. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
*os.File IngredientsByIDImage(ctx, id).Measure(measure).Execute()
Ingredients by ID Image
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ddsky/spoonacular-api-clients/go"
)
func main() {
id := int32(1082038) // int32 | The recipe id.
measure := "metric" // string | Whether the the measures should be 'us' or 'metric'. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IngredientsAPI.IngredientsByIDImage(context.Background(), id).Measure(measure).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IngredientsAPI.IngredientsByIDImage``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `IngredientsByIDImage`: *os.File
fmt.Fprintf(os.Stdout, "Response from `IngredientsAPI.IngredientsByIDImage`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 | The recipe id. |
Other parameters are passed through a pointer to a apiIngredientsByIDImageRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
measure | string | Whether the the measures should be 'us' or 'metric'. |
- Content-Type: Not defined
- Accept: image/png
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]MapIngredientsToGroceryProducts200ResponseInner MapIngredientsToGroceryProducts(ctx).MapIngredientsToGroceryProductsRequest(mapIngredientsToGroceryProductsRequest).Execute()
Map Ingredients to Grocery Products
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ddsky/spoonacular-api-clients/go"
)
func main() {
mapIngredientsToGroceryProductsRequest := *openapiclient.NewMapIngredientsToGroceryProductsRequest([]string{"Ingredients_example"}, float32(123)) // MapIngredientsToGroceryProductsRequest |
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IngredientsAPI.MapIngredientsToGroceryProducts(context.Background()).MapIngredientsToGroceryProductsRequest(mapIngredientsToGroceryProductsRequest).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IngredientsAPI.MapIngredientsToGroceryProducts``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `MapIngredientsToGroceryProducts`: []MapIngredientsToGroceryProducts200ResponseInner
fmt.Fprintf(os.Stdout, "Response from `IngredientsAPI.MapIngredientsToGroceryProducts`: %v\n", resp)
}Other parameters are passed through a pointer to a apiMapIngredientsToGroceryProductsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| mapIngredientsToGroceryProductsRequest | MapIngredientsToGroceryProductsRequest |
[]MapIngredientsToGroceryProducts200ResponseInner
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string VisualizeIngredients(ctx).IngredientList(ingredientList).Servings(servings).Language(language).Measure(measure).View(view).DefaultCss(defaultCss).ShowBacklink(showBacklink).Execute()
Ingredients Widget
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/ddsky/spoonacular-api-clients/go"
)
func main() {
ingredientList := "ingredientList_example" // string | The ingredient list of the recipe, one ingredient per line (separate lines with \\\\n).
servings := float32(8.14) // float32 | The number of servings.
language := "en" // string | The language of the input. Either 'en' or 'de'. (optional)
measure := "measure_example" // string | The original system of measurement, either 'metric' or 'us'. (optional)
view := "view_example" // string | How to visualize the ingredients, either 'grid' or 'list'. (optional)
defaultCss := true // bool | Whether the default CSS should be added to the response. (optional)
showBacklink := true // bool | Whether to show a backlink to spoonacular. If set false, this call counts against your quota. (optional)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.IngredientsAPI.VisualizeIngredients(context.Background()).IngredientList(ingredientList).Servings(servings).Language(language).Measure(measure).View(view).DefaultCss(defaultCss).ShowBacklink(showBacklink).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `IngredientsAPI.VisualizeIngredients``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `VisualizeIngredients`: string
fmt.Fprintf(os.Stdout, "Response from `IngredientsAPI.VisualizeIngredients`: %v\n", resp)
}Other parameters are passed through a pointer to a apiVisualizeIngredientsRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| ingredientList | string | The ingredient list of the recipe, one ingredient per line (separate lines with \\n). | |
| servings | float32 | The number of servings. | |
| language | string | The language of the input. Either 'en' or 'de'. | |
| measure | string | The original system of measurement, either 'metric' or 'us'. | |
| view | string | How to visualize the ingredients, either 'grid' or 'list'. | |
| defaultCss | bool | Whether the default CSS should be added to the response. | |
| showBacklink | bool | Whether to show a backlink to spoonacular. If set false, this call counts against your quota. |
string
- Content-Type: application/x-www-form-urlencoded
- Accept: text/html
[Back to top] [Back to API list] [Back to Model list] [Back to README]