Ingredients API

Access our comprehensive ingredient database with plan-based filtering and search.

Authentication

All endpoints require the x-api-key header. Response codes: 200 OK, 401 Auth Error, 429 Limited.

Endpoints

Method	Path	Description
GET	/ingredients	List ingredients with pagination and advanced filtering (plan-based)
GET	/ingredients/search	Search ingredients with plan-based results
GET	/ingredients/search/{search_text}	Path-param variant of search
GET	/ingredients/{ingredient_id}	Get ingredient details (fields limited by plan)

List Ingredients

GET/ingredients

Return a paginated list of ingredients. Filter results with query parameters. Fields gated by plan.

Query Parameters

Parameter	Type	Default	Description
limit	integer	10	Results per page. Basic max 10, Pro max 50, Custom max 100.
offset	integer	0	Number of results to skip for pagination.
category	string	-	Filter by ingredient category.
allergen	string	-	Filter by allergen type.
has_allergens	string	-	"true" or "false" to filter by allergen presence.
sustainability_min	number	-	Minimum sustainability score.
sustainability_max	number	-	Maximum sustainability score.
nutrition_min	number	-	Minimum nutrition score.
nutrition_max	number	-	Maximum nutrition score.
protein_min	number	-	Minimum protein (g per 100g).
fat_min	number	-	Minimum fat (g per 100g).
carbs_min	number	-	Minimum carbohydrates (g per 100g).
fiber_min	number	-	Minimum fiber (g per 100g).
sodium_max	number	-	Maximum sodium (mg per 100g).
energy_max	number	-	Maximum energy (kcal per 100g).

curl "https://developer-portal-backend-694046361762.northamerica-northeast1.run.app/ingredients?limit=10&category=vegetables" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

curl "https://developer-portal-backend-694046361762.northamerica-northeast1.run.app/ingredients?limit=10&category=vegetables" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

Response200 OK

{
  "items": [
    {
      "is_global": true,
      "id": "65d5d345cc535e012de2fc49",
      "image_url": "https://api.journeyfoods.io/placeholder.jpg",
      "name": "Example Ingredient Name"
    }
  ],
  "pagination": {
    "total_count": 100,
    "limit": 10,
    "offset": 0,
    "has_next": true,
    "has_previous": false
  }
}

{
  "items": [
    {
      "is_global": true,
      "id": "65d5d345cc535e012de2fc49",
      "image_url": "https://api.journeyfoods.io/placeholder.jpg",
      "name": "Example Ingredient Name"
    }
  ],
  "pagination": {
    "total_count": 100,
    "limit": 10,
    "offset": 0,
    "has_next": true,
    "has_previous": false
  }
}

Search Ingredients

GET/ingredients/search

Search ingredients by text query. Results gated by plan.

Query Parameters

Parameter	Type	Required	Description
q	string	Yes	Text to search for in ingredients.

curl "https://developer-portal-backend-694046361762.northamerica-northeast1.run.app/ingredients/search?q=mango" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

curl "https://developer-portal-backend-694046361762.northamerica-northeast1.run.app/ingredients/search?q=mango" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

Response200 OK

[
  {
    "id": "65d5d3f3cc535e012de30fb7",
    "name": "Mango, boiled",
    "image_url": "https://nix-tag-images.s3.amazonaws.com/673_thumb.jpg",
    "nutrition_score": 72.73,
    "sustainability_score": 0,
    "protein": 2.76,
    "fat": null,
    "carbs": 50.33,
    "fiber": 5.38,
    "sodium": 3.36,
    "energy": 201.6,
    "is_global": true
  }
]

[
  {
    "id": "65d5d3f3cc535e012de30fb7",
    "name": "Mango, boiled",
    "image_url": "https://nix-tag-images.s3.amazonaws.com/673_thumb.jpg",
    "nutrition_score": 72.73,
    "sustainability_score": 0,
    "protein": 2.76,
    "fat": null,
    "carbs": 50.33,
    "fiber": 5.38,
    "sodium": 3.36,
    "energy": 201.6,
    "is_global": true
  }
]

Search Ingredients (Path Param)

GET/ingredients/search/{search_text}

Path-parameter variant of search. Pass the search text directly in the URL path.

curl "https://developer-portal-backend-694046361762.northamerica-northeast1.run.app/ingredients/search/mango" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

curl "https://developer-portal-backend-694046361762.northamerica-northeast1.run.app/ingredients/search/mango" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

Response200 OK

[
  {
    "id": "65d5d3f3cc535e012de30fb7",
    "name": "Mango, boiled",
    "image_url": "https://nix-tag-images.s3.amazonaws.com/673_thumb.jpg",
    "nutrition_score": 72.73,
    "sustainability_score": 0,
    "protein": 2.76,
    "fat": null,
    "carbs": 50.33,
    "fiber": 5.38,
    "sodium": 3.36,
    "energy": 201.6,
    "is_global": true
  }
]

[
  {
    "id": "65d5d3f3cc535e012de30fb7",
    "name": "Mango, boiled",
    "image_url": "https://nix-tag-images.s3.amazonaws.com/673_thumb.jpg",
    "nutrition_score": 72.73,
    "sustainability_score": 0,
    "protein": 2.76,
    "fat": null,
    "carbs": 50.33,
    "fiber": 5.38,
    "sodium": 3.36,
    "energy": 201.6,
    "is_global": true
  }
]

Get Ingredient Details

GET/ingredients/{ingredient_id}

Retrieve detailed information for a specific ingredient. Fields limited by plan.

Path Parameters

Parameter	Type	Required	Description
ingredient_id	string	Yes	The unique ingredient ID.

curl "https://developer-portal-backend-694046361762.northamerica-northeast1.run.app/ingredients/65d5d358cc535e012de2fe77" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

curl "https://developer-portal-backend-694046361762.northamerica-northeast1.run.app/ingredients/65d5d358cc535e012de2fe77" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Accept: application/json"

Response200 OK

{
  "id": "65d5d358cc535e012de2fe77",
  "name": "25# Coconut Mango Mousse Dessert",
  "image_url": "",
  "nutrition_score": 72.73,
  "sustainability_score": 0,
  "protein": null,
  "fat": null,
  "carbs": null,
  "fiber": null,
  "sodium": null,
  "energy": null,
  "is_global": true
}

{
  "id": "65d5d358cc535e012de2fe77",
  "name": "25# Coconut Mango Mousse Dessert",
  "image_url": "",
  "nutrition_score": 72.73,
  "sustainability_score": 0,
  "protein": null,
  "fat": null,
  "carbs": null,
  "fiber": null,
  "sodium": null,
  "energy": null,
  "is_global": true
}