Additional Request Parameters

Learn the details of additional essential request parameters for some of the endpoints of the Spoonacular API.

We'll cover the following

The pagination request parameters are as follows:

Pagination Parameters

Parameter

Type

Category

Description

offset

Number

Optional

The number of results to skip in the API response.

Possible values: 0–900

number

Number

Optional

The number of results to include in the API response.

Possible values: 0–100

The nutrients request parameters are as follows:

Nutrients Parameters for Recipe Searches

Parameter

Type

Category

Description

minCarbs

Number

Optional

The minimum number of carbohydrates that the recipes we’re fetching should have in grams.

maxCarbs

Number

Optional

The maximum number of carbohydrates that the recipes we’re fetching should have in grams.

minCalories

Number

Optional

The minimum number of calories that the recipes we’re fetching should have.

maxCalories

Number

Optional

The maximum number of calories that the recipes we’re fetching should have.

minProtein

Number

Optional

The minimum amount of protein that the recipes we’re fetching should have in grams.

maxProtein

Number

Optional

The maximum amount of protein that the recipes we’re fetching should have in grams.

minCholesterol

Number

Optional

The minimum amount of cholesterol that the recipes we’re fetching should have in milligrams.

maxCholesterol

Number

Optional

The maximum amount of cholesterol that the recipes we’re fetching should have in milligrams.

minFat

Number

Optional

The minimum amount of fat that the recipes we’re fetching should have in grams.

maxFat

Number

Optional

The maximum amount of fat that the recipes we’re fetching should have in grams.

minAlcohol

Number

Optional

The minimum amount of alcohol that the recipes we’re fetching should have in grams.

maxAlcohol

Number

Optional

The minimum amount of alcohol that the recipes we’re fetching should have in grams.

minCaffeine

Number

Optional

The minimum amount of caffeine that the recipes we’re fetching should have in milligrams.

maxCaffeine

Number

Optional

The maximum amount of caffeine that the recipes we’re fetching should have in milligrams.

minSaturatedFat

Number

Optional

The minimum amount of saturated fat that the recipes we’re fetching should have in grams.

maxSaturatedFat

Number

Optional

The minimum amount of saturated fat that the recipes we’re fetching should have in grams.

For nutrients, you can refer to Spoonacular’s official documentation for the recipe search and recipe search nutrients endpoints.

Additional complex parameters for the recipe search endpoint

The additional complex request parameters are as follows:

Additional Complex Parameters for the recipe search Endpoint

Parameter

Type

Category

Description

instructionsRequired

Boolean

Optional

The option, if set to true, includes recipe instructions in the response.

fillIngredients

Boolean

Optional

The option, if set to true, includes additional information about whether ingredients are missing or included in the queried recipe. If this parameter is enabled, the API call will take an additional 0.025 quota points per recipe.

addRecipeInformation

Boolean

Optional

The option, if set to true, includes detailed information about the queried recipe. If this parameter is enabled, the API call will take an additional 0.025 quota points per recipe.

addRecipeNutrition

Boolean

Optional

The option, if set to true, includes nutritional information about the queried recipe. If this parameter is enabled, the API call will take an additional 0.025 quota points per recipe.

author

String

Optional

The username of the recipe’s author on Spoonacular.

tags

String

Optional

The custom tags we can use to match the search results. We also need to provide the author parameter to use this parameter.

recipeBoxId

Number

Optional

The identifier for the recipe box on Spoonacular, to which we want to restrict the search results.

titleMatch

String

Optional

The custom string that we can use to match against the recipe titles of the search results. We also need to provide the author parameter to use this parameter.

maxReadyTime

Number

Optional

The maximum time that the queried recipes should take to cook in minutes.

ignorePantry

Boolean

Optional

The option, if set to true, excludes pantry ingredients like water and salt from the search results.

sort

String

Optional

The sorting option that sorts the ingredients.

sortDirection

String

Optional

The direction in which to sort the results. To sort in ascending order, we use asc, and to sort in descending order, we use desc.