{"id":13769375,"url":"https://pajaydev.github.io/ebay-node-api/","last_synced_at":"2025-05-11T02:32:14.988Z","repository":{"id":30680757,"uuid":"124694748","full_name":"pajaydev/ebay-node-api","owner":"pajaydev","description":"eBay API Client for node","archived":false,"fork":false,"pushed_at":"2023-01-06T02:38:53.000Z","size":2125,"stargazers_count":132,"open_issues_count":39,"forks_count":76,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-10-29T19:58:20.898Z","etag":null,"topics":["buying-api","dailydeals","deals-api","ebay","ebay-api","ebay-developers","ebay-node-api","ebay-sdk","ebay-sell-api","ebay-trading-api","ebaysdk-node","finding-api","getaccesstoken","getitem","node-api","search-items","searchbyimage","shipping-fee","shopping"],"latest_commit_sha":null,"homepage":"https://pajaydev.github.io/ebay-node-api","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/pajaydev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-10T20:11:10.000Z","updated_at":"2024-10-10T20:29:32.000Z","dependencies_parsed_at":"2023-01-14T17:30:46.448Z","dependency_job_id":null,"html_url":"https://github.com/pajaydev/ebay-node-api","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pajaydev%2Febay-node-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pajaydev%2Febay-node-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pajaydev%2Febay-node-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pajaydev%2Febay-node-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pajaydev","download_url":"https://codeload.github.com/pajaydev/ebay-node-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224703869,"owners_count":17355710,"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":["buying-api","dailydeals","deals-api","ebay","ebay-api","ebay-developers","ebay-node-api","ebay-sdk","ebay-sell-api","ebay-trading-api","ebaysdk-node","finding-api","getaccesstoken","getitem","node-api","search-items","searchbyimage","shipping-fee","shopping"],"created_at":"2024-08-03T17:00:23.233Z","updated_at":"2024-11-17T05:30:47.344Z","avatar_url":"https://github.com/pajaydev.png","language":"JavaScript","readme":"# Ebay API Node.js\n\nEbay API Client for node js.\n\nThe intent is to simplify the request process by handling the tedious logic. It's a thin wrapper around eBay Api.\n\n[![npm version](https://badge.fury.io/js/ebay-node-api.svg)](https://badge.fury.io/js/ebay-node-api)\n[![Downloads](https://img.shields.io/npm/dt/ebay-node-api.svg)](https://img.shields.io/npm/dt/ebay-node-api.svg)\n[![Build Status](https://travis-ci.org/pajaydev/ebay-node-api.svg?branch=master)](https://travis-ci.org/ajay2507/ebay-node-api)\n\n**Documentation:** [https://pajaydev.github.io/ebay-node-api](https://pajaydev.github.io/ebay-node-api)\n\n## 📒 Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Documentation](#documentation)\n- [Using Express js](#using-express-js)\n- [API Details](#api-details)\n- [Examples](#examples)\n- [Test](#test)\n- [Issues](#issues)\n\n## Installation\n\n```shell\nnpm install ebay-node-api\n```\n\n## Usage\n\n```javascript\nlet eBay = require(\"ebay-node-api\");\n\nlet ebay = new eBay({\n  clientID: \"-- Client APP ID ----\",\n  env: \"SANDBOX\", // optional default = 'PRODUCTION'\n  headers: {\n    // optional\n    \"X-EBAY-C-MARKETPLACE-ID\": \"EBAY_GB\" // For Great Britain https://www.ebay.co.uk\n  }\n});\n```\n\nFor Country Code and Marketplace id [check here](https://developer.ebay.com/DevZone/finding/CallRef/Enums/GlobalIdList.html)\n\n## Documentation\n\nCheck out the [Starter Guide](https://pajaydev.github.io/ebay-node-api) documentation with examples to get started.\n\n## Using Express js\n\nYou can consume these ebay node api's using [Express](https://expressjs.com/). You can checkout the sample app in [Codesandbox playground](https://codesandbox.io/s/ebaynodeapiusingexpress-xezws?file=/README.md).\n\n## API details\n\n### Without Auth flow\n\n| HTTP Method | Methods              | Description                                                                                                                                                                     | Usage                                                                                 | Offical doc                                                                           |\n| ----------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |\n| GET         | findItemsByKeywords  | Searches for items on eBay by a keyword query.                                                                                                                                  | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L21)  | [doc](https://developer.ebay.com/devzone/finding/callref/finditemsbykeywords.html)    |\n| GET         | findCompletedItems   | Searches for items whose listings are completed and are no longer available for sale by category (using categoryId), by keywords (using keywords), or a combination of the two. | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L40)  | [doc](https://developer.ebay.com/devzone/finding/callref/findCompletedItems.html)     |\n| GET         | findItemsByProduct   | Searches for items on eBay using specific eBay product values.                                                                                                                  | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L55)  | [doc](https://developer.ebay.com/devzone/finding/callref/finditemsbykeywords.html)    |\n| GET         | findItemsAdvanced    | Searches items on eBay by category or keyword or both.                                                                                                                          | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L65)  | [doc](https://developer.ebay.com/devzone/finding/callref/findItemsAdvanced.html)      |\n| GET         | getSingleItem        | Retrieves publicly visible details about one listing on eBay.                                                                                                                   | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L40)  | [doc](https://developer.ebay.com/Devzone/shopping/docs/CallRef/GetSingleItem.html)    |\n| GET         | getMultipleItems     | Retrieves publicly available data for one or more listings.                                                                                                                     | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/shopping.js#L49) | [doc](https://developer.ebay.com/Devzone/shopping/docs/CallRef/GetMultipleItems.html) |\n| GET         | getShippingCosts     | Retrieve estimated shipping cost to ship an active item to a specified destination country and postal code.                                                                     | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L40)  | [doc](https://developer.ebay.com/devzone/shopping/docs/callref/GetShippingCosts.html) |\n| GET         | getItemStatus        | Get item status for given item ids.                                                                                                                                             | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/shopping.js#L28) | [doc](https://developer.ebay.com/Devzone/shopping/docs/CallRef/GetItemStatus.html)    |\n| GET         | getUserDetails       | Get User Profile.                                                                                                                                                               | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/shopping.js#L19) | [doc](https://developer.ebay.com/Devzone/shopping/docs/CallRef/GetUserProfile.html)   |\n| GET         | getDeals(Deprecated) | Get details about the deals across eBay.                                                                                                                                        | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/deals.js)        | [doc](https://developer.ebay.com/devzone/finding/callref/finditemsbykeywords.html)    |\n\n### With Auth flow\n\n| HTTP Method | Methods                   | Description                                                                                                                                                                                            | Usage                                                                                         | Offical doc                                                                                                        |\n| ----------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |\n| GET         | searchItems               | Searches for eBay items by various query parameters and retrieves summaries of the items. You can search by keyword, category, eBay product ID (ePID), or GTIN, charity ID, or a combination of these. | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/searchApi.js#L17)        | [doc](https://developer.ebay.com/api-docs/buy/browse/resources/item_summary/methods/search)                        |\n| GET         | getItem                   | Retrieve the complete details of a specific item.                                                                                                                                                      | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/browseApi.js#L16)        | [doc](https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItem)                               |\n| GET         | getItemsByItemGroup       | Retrieve all the individual items in a group.                                                                                                                                                          | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/browseApi.js#L55)        | [doc](https://developer.ebay.com/api-docs/buy/browse/resources/item/methods/getItemsByItemGroup#uri.item_group_id) |\n| GET         | getItemByLegacyId         | Returns the RESTful item ID, which can then be used in any of other Buy API methods.                                                                                                                   | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L21)          | [doc](https://developer.ebay.com/devzone/finding/callref/finditemsbykeywords.html)                                 |\n| GET         | searchByImage             | Returns the RESTful item ID, which can then be used in any of other Buy API methods.                                                                                                                   | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/searchApi.js#L93)        | [doc](https://developer.ebay.com/api-docs/buy/browse/resources/search_by_image/methods/searchByImage)              |\n| GET         | getMostWatchedItems       | Retrieves data for items with the highest watch counts for the entire site or for a specific category.                                                                                                 | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/merchandisingApi.js#L15) | [doc](https://developer.ebay.com/DevZone/merchandising/docs/CallRef/getSimilarItems.html)                          |\n| GET         | getSimilarItems           | Retrieves recommended similar items for a specified item.                                                                                                                                              | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/searchApi.js#L93)        | [doc](https://developer.ebay.com/api-docs/buy/browse/resources/search_by_image/methods/searchByImage)              |\n| GET         | getItemAspectsForCategory | Retrieve an array of aspects that are appropriate for describing items in a specified category.                                                                                                        | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L40)          | [doc](https://developer.ebay.com/api-docs/commerce/taxonomy/resources/methods)                                     |\n| GET         | getDefaultCategoryTreeId  | Retrieve the default category tree reference for a specific eBay marketplace.                                                                                                                          | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L40)          | [doc](https://developer.ebay.com/api-docs/commerce/taxonomy/resources/methods)                                     |\n| GET         | getCategoryTree           | Retrieve the complete category tree for category id.                                                                                                                                                   | [Example](https://github.com/pajaydev/ebay-node-api/blob/master/demo/finding.js#L40)          | [doc](https://developer.ebay.com/api-docs/commerce/taxonomy/resources/methods)                                     |\n\n## Examples\n\n```javascript\n// findItemsBykeyword\nebay\n  .findItemsByKeywords({\n    keywords: \"Garmin nuvi 1300 Automotive GPS Receiver\",\n    sortOrder: \"PricePlusShippingLowest\", //https://developer.ebay.com/devzone/finding/callref/extra/fndcmpltditms.rqst.srtordr.html\n    pageNumber: 2,\n    limit: 10\n  })\n  .then(\n    data =\u003e {\n      console.log(data);\n    },\n    error =\u003e {\n      console.log(error);\n    }\n  );\n\n// Get Single item listing on eBay\nebay.getSingleItem(\"153265274986\").then(data =\u003e {\n  console.log(data);\n});\n\n// Search Items by Keyword\nebay.getAccessToken().then(data =\u003e {\n  ebay\n    .searchItems({\n      keyword: \"drone\",\n      limit: \"3\"\n    })\n    .then(data =\u003e {\n      console.log(data);\n      // Data is in format of JSON\n      // To check the format of Data, Go to this url (https://developer.ebay.com/api-     docs/buy/browse/resources/item_summary/methods/search#w4-w1-w4-SearchforItemsbyKeyword-0)\n    });\n});\n\n// perform Advance Search Items by Keyword or category or both\n// Search Buy It Now ipad items with one day shipping. (https://developer.ebay.com/DevZone/finding/CallRef/findItemsAdvanced.html)\nebay\n  .findItemsAdvanced({\n    entriesPerPage: 2,\n    keywords: \"ipad\",\n    ExpeditedShippingType: \"OneDayShipping\",\n    ListingType: \"AuctionWithBIN\"\n  })\n  .then(\n    data =\u003e {\n      console.log(data);\n    },\n    error =\u003e {\n      console.log(error);\n    }\n  );\n```\n\n[More Examples](https://pajaydev.github.io/ebay-node-api)\n\n## Test\n\nAll test files are present inside test folder. You can run using\n\n```javascript\nnpm run test\n```\n\n## Issues:\n\nIf you are facing any issues or missing something, you can create the issues [here](https://github.com/pajaydev/ebay-node-api/issues).\n\n## 👍 Contribution:\n\nShow your ❤️ and support by giving a ⭐. Willing to share your idea or ready to contribute, check [here](https://github.com/pajaydev/ebay-node-api/blob/master/CONTRIBUTING.md)\n\n## 📝 License:\n\nMIT.\n\n## Examples:\n\nI have provided the examples here\nhttps://github.com/pajaydev/ebay-node-api/tree/master/demo.\n","funding_links":[],"categories":["Showcase"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/pajaydev.github.io%2Febay-node-api%2F","html_url":"https://awesome.ecosyste.ms/projects/pajaydev.github.io%2Febay-node-api%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/pajaydev.github.io%2Febay-node-api%2F/lists"}