{"id":15710832,"url":"https://github.com/evscott/barcodelookup","last_synced_at":"2025-05-12T21:12:03.825Z","repository":{"id":40748071,"uuid":"184925092","full_name":"evscott/barcodelookup","owner":"evscott","description":"A Node.js package that can retrieve data for EPC/EAN/ISBN formatted barcodes.","archived":false,"fork":false,"pushed_at":"2022-12-03T08:14:47.000Z","size":149,"stargazers_count":3,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-12T21:11:52.147Z","etag":null,"topics":["barcode","barcodelookup","ean","isbn","javascript","nodejs","npm","upc"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/barcodelookup","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/evscott.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-04T17:28:17.000Z","updated_at":"2025-01-19T23:37:51.000Z","dependencies_parsed_at":"2023-01-23T04:30:57.730Z","dependency_job_id":null,"html_url":"https://github.com/evscott/barcodelookup","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evscott%2Fbarcodelookup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evscott%2Fbarcodelookup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evscott%2Fbarcodelookup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evscott%2Fbarcodelookup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/evscott","download_url":"https://codeload.github.com/evscott/barcodelookup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253823461,"owners_count":21969848,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["barcode","barcodelookup","ean","isbn","javascript","nodejs","npm","upc"],"created_at":"2024-10-03T21:10:22.780Z","updated_at":"2025-05-12T21:12:03.804Z","avatar_url":"https://github.com/evscott.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![David](https://david-dm.org/evscott/barcodelookup.svg)\n# barcodelookup\n\nAn installable Node.js package that easily handles [barcodelookup](https://www.barcodelookup.com/) requests.\n\n### Prerequisites\n\n1. Ensure that you have a valid API key provided by [barcodelookup](https://www.barcodelookup.com/api#sign-up).\n\n2. Ensure that Node.js and npm is installed on your machine.\n\n```\nnode --version // v11.14.0\nnpm --version // 6.9.0\n```\n\n### Installing\n\nInside of your projects root directory, install the barcodelookup package using npm.\n\n```\nnpm install barcodelookup\n```\n\n## How to use\n\nInside any file of your project, import the barcodelookup package from node_modules.\n\n```\nconst bc = require('barcodelookup');\n```\n\nTo make a request, call either [lookup](#lookup) or [rateLimits](#ratelimits) and provide the necessary arguments in a key-value object format to fulfill the request.\n\n```\nbc.lookup({\n        key: 'your api key',\n        barcode: 'some barcode to lookup'\n    });\n\nbc.rateLimits({\n        key: 'your api key'\n    });\n```\n\n## Functions available\n### lookup\n`lookup` uses destructured parameters to accept arguments marked by the keys which barcodelookup accepts: \ni.e. barcode, mpn, asin, key, etc.\n\n```\nlookup({ barcode: barcode, mpn: mpn, asin: asin, productName: productName, category: category, \n            search: search, page: page, geo: geo, formatted: formatted, key: key })\n```\n\n`lookup` returns an object as a promise. The object will contain a status code \nand either a data packet of products or an error message.\n\n```\n{ statusCode: 200, data: { products: [ [Object] ] } }\n...\n{ statusCode: 403, data: 'Forbidden' }\n...\n{ statusCode: 404, data: 'Not Found' }\n...\n{ statusCode: 429, data: 'Too Many Requests' }\n```\n\nExample product object:\n```\n{ products:\n   [ { barcode_number: '063652852403',\n       barcode_type: 'UPC',\n       barcode_formats: 'UPC 063652852403, EAN 0063652852403',\n       mpn: '063652852403',\n       model: '',\n       asin: '',\n       product_name: 'Crayola 24 Ultra Clean Washable Markers by Crayola',\n       title: 'Crayola 24 Ultra Clean Washable Markers by Crayola',\n       category:\n        'Sporting Goods \u003e Outdoor Recreation \u003e Golf \u003e Golf Ball Markers',\n       manufacturer: 'Crayola',\n       brand: 'Crayola',\n       label: '',\n       author: '',\n       publisher: '',\n       artist: '',\n       actor: '',\n       director: '',\n       studio: '',\n       genre: '',\n       audience_rating: '',\n       ingredients: '',\n       nutrition_facts: '',\n       color: '',\n       format: '',\n       package_quantity: '',\n       size: '',\n       length: '',\n       width: '',\n       height: '',\n       weight: '',\n       release_date: '',\n       description:\n        'Crayola Washable markers are now Ultra Washable! Washable from skin, clothing and now from walls! Washability you can trust from the world\u0026apos;s most washable marker!Markers that deliver superb colour coverage and lay down. The markers come in various degrees of washability and a wide variety of marker tips.Fine tip for outlining, writing and drawingInk washes easily from skin and fabricsMachine washable.',\n       features: [],\n       images: [Array],\n       stores: [Array],\n       reviews: [] } ] }\n```\n\nSee the official [barcodelookup api documentation](https://www.barcodelookup.com/api) for more information on returned fields.\n\n### rateLimits\n`rateLimits` queries the barcodelookup account registry to return account details pertaining to an api-key.\n\n```\nrateLimits({ key: key })\n```\n\n`rateLimits` returns an object as a promise. The object will contain a status code \nand either a data packet of account information or an error message.\n\n```\n{ statusCode: 200,\n  data:\n   { allowed_calls_per_month: '50',\n     remaining_calls_per_month: '48',\n     allowed_calls_per_minute: '50',\n     remaining_calls_per_minute: '49' } }\n...\n{ statusCode: 403, data: 'Forbidden' }\n...\n```\n\nSee the official [barcodelookup api documentation](https://www.barcodelookup.com/api) for more information on returned fields.\n\n## Built With\n\n* [barcodelookup](https://www.barcodelookup.com/) - The barcode database.\n* [node-fetch](https://www.npmjs.com/package/node-fetch) - The HTTP request framework.\n\n## Authors\n\n* **[Eliot Scott](https://github.com/evscott)** - *Initial work*\n* **[Robin C Samuel](https://github.com/robincsamuel)** - *Second contributor*\n\nSee also the list of [contributors](https://github.com/evscott/barcodelookup/graphs/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevscott%2Fbarcodelookup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fevscott%2Fbarcodelookup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevscott%2Fbarcodelookup/lists"}