This is a product API for grocery and item data. It will return information including prices, names, images descriptions, ids, nutrition information, and much more.
I built this API when I tried finding product data for a project, but couldn't find any that worked for my needs. The database is small and only contains 99 products, but new products are added every so often.
Newly introduced was the idea of multiple countries. Now, this project will include data from multiple countries.
* 99 total items
* 92 categories
* 70 different brands
* 2 countries
* 99 images
* $262.29 worth of products
* 122,761 total calories*
*some products may not be accounted for due to unreadable or incomplete nutritional information
* names
* price data in USD
* images for every product
* nutrition information
* descriptions
* desired temperatures
* displays stats on entire database
* perfect for admin dashboard
* ingredients
* country of sale
* seasonal
* unique ids
* brands
* categories
- Node.js
- command line
git clone https://github.com/yZipperer/item-api.git
- Navigate into the cloned folder and type
node app.jsto start the server - Once the server is running use the command line to call the routes listed below
http://localhost:8080/ /*all data*/
http://localhost:8080/docs /*returns the docs for the routes*/
--- Please Note ---
For the country parameter below (see masterList for all country codes), select one of the following (case sensitive):
- "US"
- "JP"
http://localhost:8080/food/:country /*returns all food data based on country provided*/
--- Searching ---
http://localhost:8080/food?brand=putbrandhere /*search based on brand*/
http://localhost:8080/food?cat=putcategoryhere /*search based on category*/
http://localhost:8080/food?country=putcountrycodehere /*search based on country*/
http://localhost:8080/food?cat=putcategoryhere&brand=putbrandhere&country=putcountrycodehere /*search based on category and brand and country*/
--- Admin ---
http://localhost:8080/stats /*shows stats on the items in the data set*/
example search: http://localhost:8080/stats?country=US /*see masterList in data folder for country codes*/
- You will begin by typing one of the above routes into either a search bar, or you can make a request through a command line
- there are 2 route parameters to know
cat This parameter is used to search based on category
brand This parameter is used to search based on brand
country This parameter is used to search based on country (see country code list)
- Use different parameter values to search for what you need
Sample URL:
http://localhost:8080/food?cat=putCATEGORYhere&brand=putBRANDhere&country=putCOUNTRYCODEhere
Sample URL Search for Franz Bread:
http://localhost:8080/food?cat=bakery&brand=Franz
Categories for United States Data
Note: these are case sensitive
Available Categories:
* produce
* bakery
* sliced-bread
* white-bread
* multigrain-bread
* buttermilk-bread
* butter-bread
* hawaiian-bread
* wheat-bread
* rolls-bread
* hoagie
* muffins
* english-muffins
* dry-goods
* flour
* sugar
* oats
* dry-coffee
* mixes
* brownie-mix
* brownies
* canned
* canned-produce
* dairy
* milk
* whole-milk
* 1-percent-milk
* Eggs
* cheese
* sliced-cheese
* cream-cheese
* yogurt
* water
* bottled-water
* case-water
* jug-water
* candy
* boxed-candy
* bar-candy
* bagged-candy
* seafood
* tuna
* crackers
* cheddar-crackers
* peanut-butter-crackers
* cookies
* chocolate-cookies
* (flavors)
* strawberry
* chocolate
* vanilla
* cheddar
* chili-cheese
* honey
* cinnamon
* fruit
* pasta
* ravioli
* meatballs
* coffee
* cereal
* breakfast
* seasoning
* extract
* seasoning mix
* vegan
* vegetarian
* meat-alternative
* snacks
* nuts
* popcorn
* chips
* corn-chip
* potato-chip
* granola
* bar
* sauce
* jar
* cup
* preserves
* quick-meal
* quick-lunch
* quick-dinner
* quick-breakfast
* pizza
Categories for Japan Data
Note: these are case sensitive
Available Categories:
* candy
* wafer
* gummy
* (flavors)
* orange
* chocolate
* corn
* matcha
* peach
* green-apple
* pizza
* snacks
* popcorn
* chips
* breadsticks
Brands for United States Data
Note: these are case sensitive
Available Brands:
* unknown (This is for things like produce and products that don't have a clear brand name)
* Franz
* Del Monte
* Bush's
* Hunt's
* Dole
* Rosarita
* Manwich
* Chef Boyardee
* Gold Medal
* C&H
* Quaker
* Eggland's Best
* Sargento
* Meadow Gold
* TruMoo
* Grandma Sycamore's
* Sara Lee
* Great Grains
* Aquafina
* Nestle
* Crystal Geyser
* Ball Park
* Bolthouse Farms
* Hershey's
* Yoplait
* Kraft
* Campbell's
* StarKist
* Whoppers
* Twizzlers
* Philadelphia
* Honey Maid
* Lay's
* Nabisco
* Ritz
* Chips Ahoy!
* Nilla
* Cheez-It
* Kellogg's
* Club
* Froot Loops
* Pepperidge Farm
* Goldfish
* Folgers
* Pillsbury
* Funfetti
* Oreo
* Thomas'
* Cheetos
* Doritos
* General Mills
* Cheerios
* Honey Nut Cheerios
* Cinnamon Toast Crunch
* Lucky Charms
* SunChips
* McCormick
* MorningStar Farms
* Nature Valley
* Mott's
* Smucker's
* Lunchables
* Totino's
* Planters
* Knorr
Brands for Japan Data
Note: these are case sensitive
Available Brands:
* Nestle
* KitKat
* Yaokin
* Glico
* Pocky
* Calbee
For a more comprehensive list see the masterList in the data folder of each country.
Sample Data Layout:
{
"name": "Planters Mixed Nuts with Peanuts, Almonds, Cashews, Hazelnuts, and Pecans",
"id": "fnm230",
"country": "United States",
"seasonal": "all",
"category": ["nuts", "snacks"],
"brand": "Planters",
"weight": "10.3 ounces",
"hot": false,
"cold": false,
"frozen": false,
"description": "Planters Mixed Nuts offer a crunchy combination of peanuts, almonds, cashews, hazelnuts and pecans, making them a perfect on-the-go snack to curb your cravings for a crunchy treat. These mixed nuts contain sea salt for a savory flavor that satisfies. Planters mixed nuts are roasted and packed in the USA. Sprinkle these Kosher mixed nuts over a salad, or serve them with soups.",
"price": {
"USD": {
"default": "4.62",
"formatted": "$4.62/each"
}
},
"image": "http://localhost:8080/fnm230.jpeg",
"nutrition": {
"serving size": "1 ounce (28 grams/32 pieces)",
"servings per container": "10",
"calories": "170",
"fat": "15 grams",
"cholesterol": "0 milligrams",
"sodium": "90 milligrams",
"potassium": "200 milligrams",
"carbohydrates": "6 grams",
"sugars": "0 grams",
"dietary fiber": "3 grams",
"protein": "6 grams"
},
"ingredients": "PEANUTS, ALMONDS, CASHEWS, HAZELNUTS (FILBERTS), PECANS, PEANUT OIL, SEA SALT."
}
- make a request to the desired category
- In the returned json there will be an image link
- Put the link into the address bar of any browser
- As long as the server is running, you should get the image associated with the product
Contributions are welcome, especially for product data. Just open up an issue with what you would like to add.
To contribute, locate the data.json file in the data folder. Then, copy and paste one of the latest product entries (at bottom of data.json file). Modify this to include information on the new product. Then, add a corresponding image in the images folder (make sure the file name and product id match)
*You should also make sure the product has not already been added. Simply ctrl+F as search through the data.json file, or check the masterList to make sure the product has not been added.
If you have any problems in usage or contributing, simply open up an issue with your questions.