{ "uuid": "6c4be052-a8ed-4730-a66c-752e3607930a", "lastMigration": 29, "name": "Chomp Food Database API Documentation", "endpointPrefix": "api/v2", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "f7d492e1-10e8-4bf2-b89d-3ee661f3b45a", "documentation": "Get a branded food item using a barcode", "method": "get", "endpoint": "food/branded/barcode.php", "responses": [ { "uuid": "caeb8621-9108-411e-8c4c-8a2f65d221bc", "body": "{\n \"items\": [\n {\n \"allergens\": [\n \"\"\n ],\n \"barcode\": \"\",\n \"brand\": \"\",\n \"brand_list\": [\n \"\"\n ],\n \"categories\": [\n \"\"\n ],\n \"countries\": [\n \"\"\n ],\n \"country_details\": {\n \"english_speaking\": {{faker 'number.int' max=99999}},\n \"non_english_speaking\": {{faker 'number.int' max=99999}}\n },\n \"description\": \"\",\n \"diet_flags\": [\n {\n \"compatibility_description\": \"\",\n \"compatibility_level\": {{faker 'number.int' max=99999}},\n \"diet_label\": \"\",\n \"ingredient\": \"\",\n \"ingredient_description\": \"\",\n \"is_allergen\": {{faker 'datatype.boolean'}},\n \"is_compatible\": \"\"\n }\n ],\n \"diet_labels\": {\n \"gluten_free\": {\n \"compatibility_level\": {{faker 'number.int' max=99999}},\n \"confidence\": {{faker 'number.int' max=99999}},\n \"confidence_description\": \"\",\n \"is_compatible\": {{faker 'datatype.boolean'}},\n \"name\": \"\"\n },\n \"vegan\": {\n \"compatibility_level\": {{faker 'number.int' max=99999}},\n \"confidence\": {{faker 'number.int' max=99999}},\n \"confidence_description\": \"\",\n \"is_compatible\": {{faker 'datatype.boolean'}},\n \"name\": \"\"\n },\n \"vegetarian\": {\n \"compatibility_level\": {{faker 'number.int' max=99999}},\n \"confidence\": {{faker 'number.int' max=99999}},\n \"confidence_description\": \"\",\n \"is_compatible\": {{faker 'datatype.boolean'}},\n \"name\": \"\"\n }\n },\n \"has_english_ingredients\": {{faker 'datatype.boolean'}},\n \"ingredient_list\": [\n \"\"\n ],\n \"ingredients\": \"\",\n \"keywords\": [\n \"\"\n ],\n \"minerals\": [\n \"\"\n ],\n \"name\": \"\",\n \"nutrients\": [\n {\n \"data_points\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"measurement_unit\": \"\",\n \"name\": \"\",\n \"per_100g\": {{faker 'number.int' max=99999}},\n \"rank\": {{faker 'number.int' max=99999}}\n }\n ],\n \"package\": {\n \"quantity\": {{faker 'number.int' max=99999}},\n \"size\": \"\"\n },\n \"packaging_photos\": {\n \"front\": {\n \"display\": \"\",\n \"small\": \"\",\n \"thumb\": \"\"\n },\n \"ingredients\": {\n \"display\": \"\",\n \"small\": \"\",\n \"thumb\": \"\"\n },\n \"nutrition\": {\n \"display\": \"\",\n \"small\": \"\",\n \"thumb\": \"\"\n }\n },\n \"palm_oil_ingredients\": [\n \"\"\n ],\n \"serving\": {\n \"measurement_unit\": \"\",\n \"size\": \"\",\n \"size_fulltext\": \"\"\n },\n \"traces\": [\n \"\"\n ],\n \"vitamins\": [\n \"\"\n ]\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "**Valid** - Will return an object containing any matching foods. \n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c4e6d250-e72a-4b6a-a163-fdddf2f583a7", "body": "", "latency": 0, "statusCode": 400, "label": "**Validation error** - Invalid parameters or request.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ab5a6b24-b9d7-4e6b-88ea-6b547c979d59", "body": "", "latency": 0, "statusCode": 401, "label": "**Unauthorized** - Invalid API key, unauthorized access, or usage limits exceeded. ***[More information »](https://desk.zoho.com/portal/chompthis/kb/articles/what-is-a-rate-limit)***\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d9c66683-7d8f-4232-ac55-1b2bd3d73aaa", "body": "", "latency": 0, "statusCode": 404, "label": "**Not found** - No food items were found.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "77e82091-ad22-4fa6-8cbd-165cc2e971bf", "body": "", "latency": 0, "statusCode": 500, "label": "**Server error** - Internal server error, request failed, or base error. *Please **[contact us](https://chompthis.com/api/ticket-new.php)** if you see this.*\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "18b42350-0599-4072-ae06-43467500e02d", "documentation": "Get a branded food item by name", "method": "get", "endpoint": "food/branded/name.php", "responses": [ { "uuid": "0325ffd8-f666-4d43-8f0f-ed856c7b7416", "body": "{\n \"items\": [\n {\n \"allergens\": [\n \"\"\n ],\n \"barcode\": \"\",\n \"brand\": \"\",\n \"brand_list\": [\n \"\"\n ],\n \"categories\": [\n \"\"\n ],\n \"countries\": [\n \"\"\n ],\n \"country_details\": {\n \"english_speaking\": {{faker 'number.int' max=99999}},\n \"non_english_speaking\": {{faker 'number.int' max=99999}}\n },\n \"description\": \"\",\n \"diet_flags\": [\n {\n \"compatibility_description\": \"\",\n \"compatibility_level\": {{faker 'number.int' max=99999}},\n \"diet_label\": \"\",\n \"ingredient\": \"\",\n \"ingredient_description\": \"\",\n \"is_allergen\": {{faker 'datatype.boolean'}},\n \"is_compatible\": \"\"\n }\n ],\n \"diet_labels\": {\n \"gluten_free\": {\n \"compatibility_level\": {{faker 'number.int' max=99999}},\n \"confidence\": {{faker 'number.int' max=99999}},\n \"confidence_description\": \"\",\n \"is_compatible\": {{faker 'datatype.boolean'}},\n \"name\": \"\"\n },\n \"vegan\": {\n \"compatibility_level\": {{faker 'number.int' max=99999}},\n \"confidence\": {{faker 'number.int' max=99999}},\n \"confidence_description\": \"\",\n \"is_compatible\": {{faker 'datatype.boolean'}},\n \"name\": \"\"\n },\n \"vegetarian\": {\n \"compatibility_level\": {{faker 'number.int' max=99999}},\n \"confidence\": {{faker 'number.int' max=99999}},\n \"confidence_description\": \"\",\n \"is_compatible\": {{faker 'datatype.boolean'}},\n \"name\": \"\"\n }\n },\n \"has_english_ingredients\": {{faker 'datatype.boolean'}},\n \"ingredient_list\": [\n \"\"\n ],\n \"ingredients\": \"\",\n \"keywords\": [\n \"\"\n ],\n \"minerals\": [\n \"\"\n ],\n \"name\": \"\",\n \"nutrients\": [\n {\n \"data_points\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"measurement_unit\": \"\",\n \"name\": \"\",\n \"per_100g\": {{faker 'number.int' max=99999}},\n \"rank\": {{faker 'number.int' max=99999}}\n }\n ],\n \"package\": {\n \"quantity\": {{faker 'number.int' max=99999}},\n \"size\": \"\"\n },\n \"packaging_photos\": {\n \"front\": {\n \"display\": \"\",\n \"small\": \"\",\n \"thumb\": \"\"\n },\n \"ingredients\": {\n \"display\": \"\",\n \"small\": \"\",\n \"thumb\": \"\"\n },\n \"nutrition\": {\n \"display\": \"\",\n \"small\": \"\",\n \"thumb\": \"\"\n }\n },\n \"palm_oil_ingredients\": [\n \"\"\n ],\n \"serving\": {\n \"measurement_unit\": \"\",\n \"size\": \"\",\n \"size_fulltext\": \"\"\n },\n \"traces\": [\n \"\"\n ],\n \"vitamins\": [\n \"\"\n ]\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "**Valid** - Will return an object containing any matching foods. \n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b59c3fc3-bd1b-412f-bc78-1318bde12d58", "body": "", "latency": 0, "statusCode": 400, "label": "**Validation error** - Invalid parameters or request.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "83beea63-18b0-48c9-a2af-71acd0634ee5", "body": "", "latency": 0, "statusCode": 401, "label": "**Unauthorized** - Invalid API key, unauthorized access, or usage limits exceeded. ***[More information »](https://desk.zoho.com/portal/chompthis/kb/articles/what-is-a-rate-limit)***\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5a8870b8-96a0-4bb3-9fba-5b5d73f01d9c", "body": "", "latency": 0, "statusCode": 404, "label": "**Not found** - No food items were found.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "940cd837-dc67-43ba-8fe7-8bcf017773a6", "body": "", "latency": 0, "statusCode": 500, "label": "**Server error** - Internal server error, request failed, or base error. *Please **[contact us](https://chompthis.com/api/ticket-new.php)** if you see this.*\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c2476a94-63e4-49d0-86aa-bcaab15df8b8", "documentation": "Get data for branded food items using various search parameters", "method": "get", "endpoint": "food/branded/search.php", "responses": [ { "uuid": "8a766025-4cc0-4659-ad94-6127afa0f06c", "body": "{\n \"items\": [\n {\n \"allergens\": [\n \"\"\n ],\n \"barcode\": \"\",\n \"brand\": \"\",\n \"brand_list\": [\n \"\"\n ],\n \"categories\": [\n \"\"\n ],\n \"countries\": [\n \"\"\n ],\n \"country_details\": {\n \"english_speaking\": {{faker 'number.int' max=99999}},\n \"non_english_speaking\": {{faker 'number.int' max=99999}}\n },\n \"description\": \"\",\n \"diet_flags\": [\n {\n \"compatibility_description\": \"\",\n \"compatibility_level\": {{faker 'number.int' max=99999}},\n \"diet_label\": \"\",\n \"ingredient\": \"\",\n \"ingredient_description\": \"\",\n \"is_allergen\": {{faker 'datatype.boolean'}},\n \"is_compatible\": \"\"\n }\n ],\n \"diet_labels\": {\n \"gluten_free\": {\n \"compatibility_level\": {{faker 'number.int' max=99999}},\n \"confidence\": {{faker 'number.int' max=99999}},\n \"confidence_description\": \"\",\n \"is_compatible\": {{faker 'datatype.boolean'}},\n \"name\": \"\"\n },\n \"vegan\": {\n \"compatibility_level\": {{faker 'number.int' max=99999}},\n \"confidence\": {{faker 'number.int' max=99999}},\n \"confidence_description\": \"\",\n \"is_compatible\": {{faker 'datatype.boolean'}},\n \"name\": \"\"\n },\n \"vegetarian\": {\n \"compatibility_level\": {{faker 'number.int' max=99999}},\n \"confidence\": {{faker 'number.int' max=99999}},\n \"confidence_description\": \"\",\n \"is_compatible\": {{faker 'datatype.boolean'}},\n \"name\": \"\"\n }\n },\n \"has_english_ingredients\": {{faker 'datatype.boolean'}},\n \"ingredient_list\": [\n \"\"\n ],\n \"ingredients\": \"\",\n \"keywords\": [\n \"\"\n ],\n \"minerals\": [\n \"\"\n ],\n \"name\": \"\",\n \"nutrients\": [\n {\n \"data_points\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"measurement_unit\": \"\",\n \"name\": \"\",\n \"per_100g\": {{faker 'number.int' max=99999}},\n \"rank\": {{faker 'number.int' max=99999}}\n }\n ],\n \"package\": {\n \"quantity\": {{faker 'number.int' max=99999}},\n \"size\": \"\"\n },\n \"packaging_photos\": {\n \"front\": {\n \"display\": \"\",\n \"small\": \"\",\n \"thumb\": \"\"\n },\n \"ingredients\": {\n \"display\": \"\",\n \"small\": \"\",\n \"thumb\": \"\"\n },\n \"nutrition\": {\n \"display\": \"\",\n \"small\": \"\",\n \"thumb\": \"\"\n }\n },\n \"palm_oil_ingredients\": [\n \"\"\n ],\n \"serving\": {\n \"measurement_unit\": \"\",\n \"size\": \"\",\n \"size_fulltext\": \"\"\n },\n \"traces\": [\n \"\"\n ],\n \"vitamins\": [\n \"\"\n ]\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "**Valid** - Will return an object containing any matching foods. \n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "13b2f1c2-3fa4-4280-904f-6b4d066faa28", "body": "", "latency": 0, "statusCode": 400, "label": "**Validation error** - Invalid parameters or request.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "94ec9c8f-e475-4d03-81ed-1002043dac7a", "body": "", "latency": 0, "statusCode": 401, "label": "**Unauthorized** - Invalid API key, unauthorized access, or usage limits exceeded. ***[More information »](https://desk.zoho.com/portal/chompthis/kb/articles/what-is-a-rate-limit)***\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ce8c9c63-7d8f-40e6-9e3f-181af82539e1", "body": "", "latency": 0, "statusCode": 404, "label": "**Not found** - No food items were found.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "39397d30-40a3-423b-b2bb-8c8542db3085", "body": "", "latency": 0, "statusCode": 500, "label": "**Server error** - Internal server error, request failed, or base error. *Please **[contact us](https://chompthis.com/api/ticket-new.php)** if you see this.*\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "80885227-ef60-47b9-a7d5-de1f76e9c0af", "documentation": "Get raw/generic food ingredient item(s)", "method": "get", "endpoint": "food/ingredient/search.php", "responses": [ { "uuid": "bcbb7291-ce42-443f-b46f-ca4cd0ae6ed9", "body": "{\n \"items\": [\n {\n \"calorie_conversion_factor\": {\n \"carbohydrate_value\": {{faker 'number.int' max=99999}},\n \"fat_value\": {{faker 'number.int' max=99999}},\n \"protein_value\": {{faker 'number.int' max=99999}}\n },\n \"categories\": [\n \"\"\n ],\n \"common_name\": \"\",\n \"components\": [\n {\n \"data_points\": {{faker 'number.int' max=99999}},\n \"gram_weight\": {{faker 'number.int' max=99999}},\n \"is_refuse\": {{faker 'datatype.boolean'}},\n \"name\": \"\",\n \"pct_weight\": {{faker 'number.int' max=99999}}\n }\n ],\n \"footnote\": \"\",\n \"name\": \"\",\n \"nutrients\": [\n {\n \"data_points\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"footnote\": \"\",\n \"max\": {{faker 'number.int' max=99999}},\n \"measurement_unit\": \"\",\n \"median\": {{faker 'number.int' max=99999}},\n \"min\": {{faker 'number.int' max=99999}},\n \"name\": \"\",\n \"per_100g\": {{faker 'number.int' max=99999}},\n \"rank\": {{faker 'number.int' max=99999}}\n }\n ],\n \"portions\": [\n {\n \"data_points\": {{faker 'number.int' max=99999}},\n \"description\": \"\",\n \"footnote\": \"\",\n \"gram_weight\": {{faker 'number.int' max=99999}},\n \"measurement_unit\": \"\",\n \"modifier\": \"\"\n }\n ],\n \"protein_conversion_factor\": {{faker 'number.int' max=99999}},\n \"score\": \"\",\n \"search_term\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "**Valid** - Will return an object containing any matching ingredient foods. \n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e2cc89c8-a22e-4fcb-b24b-de408d1dea5f", "body": "", "latency": 0, "statusCode": 400, "label": "**Validation error** - Invalid parameters or request.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0ac47c1c-d365-4095-85ce-0a7431daeb77", "body": "", "latency": 0, "statusCode": 401, "label": "**Unauthorized** - Invalid API key, unauthorized access, or usage limits exceeded. ***[More information »](https://desk.zoho.com/portal/chompthis/kb/articles/what-is-a-rate-limit)***\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4d828b9e-c666-4634-b8b6-912c73c97251", "body": "", "latency": 0, "statusCode": 404, "label": "**Not found** - No food items were found.\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b3860c26-cae0-4c0c-a273-bb04228a1fa6", "body": "", "latency": 0, "statusCode": 500, "label": "**Server error** - Internal server error, request failed, or base error. *Please **[contact us](https://chompthis.com/api/ticket-new.php)** if you see this.*\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "f7d492e1-10e8-4bf2-b89d-3ee661f3b45a" }, { "type": "route", "uuid": "18b42350-0599-4072-ae06-43467500e02d" }, { "type": "route", "uuid": "c2476a94-63e4-49d0-86aa-bcaab15df8b8" }, { "type": "route", "uuid": "80885227-ef60-47b9-a7d5-de1f76e9c0af" } ] }