Quickstart
Get up and running with the Journey Foods API in under 5 minutes.
1
Get an API key
Loading... in your dashboard. Keep this key secure.
Set your API key as an environment variable:
export JOURNEYFOODS_API_KEY="YOUR_API_KEY"2
Make your first request
Search for ingredients using the x-api-key header:
cURL
curl "https://developer-portal-backend-694046361762.northamerica-northeast1.run.app/ingredients/search?q=mango" \
-H "x-api-key: $JOURNEYFOODS_API_KEY" \
-H "Accept: application/json"Response
Response200 OK
{
"data": [
{
"id": "ing_mango_001",
"name": "Mango, raw",
"category": "fruits",
"nutrients": {
"calories": 60,
"protein": 0.8,
"carbohydrates": 15,
"fiber": 1.6,
"sugar": 13.7,
"fat": 0.4,
"vitamin_c": 36.4,
"vitamin_a": 54
},
"allergens": []
}
],
"meta": {
"total": 12,
"page": 1,
"per_page": 20
}
}| Field | Type | Description |
|---|---|---|
| id | string | Unique identifier for the ingredient |
| name | string | Human-readable name |
| category | string | Food category classification |
| nutrients | object | Nutritional information per serving. Fields gated by plan. |
| allergens | array | List of allergen identifiers. Gated by plan. |
Response Codes
| Status | Description |
|---|---|
| 200 OK | Request succeeded |
| 401 Auth Error | Invalid or missing API key |
| 429 Limited | Rate limit exceeded |
Next steps
Congratulations!
You've made your first API call. Explore the API reference for all available endpoints.