eshop-api-wrapper's Introduction

Eshop API Wrapper

API Wrapper to get information from Nintendo Eshop.

Get Starded

Install the package with NPM and add it to your dependencies:

$ npm install eshop-api-wrapper --save

const eshop = require('eshop-api-wrapper');

eshop.search('Zelda')
  .then(data => console.log(data))
  .catch(err => console.error(err))

The ID is provided by the Nintendo API and your format is something like that GHbaBYuv3zqQeW1CVQlmTSehZ45KTV78.

query: The search term.
options.sort: default: release. Order of results. Can be relevance, release, title and price.
options.direction: default: desc. Can be asc or des.
options.system: default: switch. Nintendo system. Can be ds, 3ds, wii, wii_u, ios, android, ios_android and switch.
options.limit: default: 10. Limit of search results. Max value is 200.
options.availability: Status of the game availability. Can be now, new, soon and prepurchase.
options.offset: default: 0. Change the position of the search. Useful to pagination.
options.category: Can be action_adventure, application, first_person, party, role_playing, music_fitness, education, puzzle_strategy, simulation and sports_racing.
options.price: Can be 4.99, 9.99, 19.99, 39.99 and 40_plus.
options.number: Filter by number of players. Can be 1, 2, 3 and 4.

options.sort: default: release. Order of results. Can be relevance, release, title and price.
options.direction: default: desc. Can be asc or des.
options.system: default: switch. Nintendo system. Can be ds, 3ds, wii, wii_u, ios, android, ios_android and switch.
options.limit: default: 10. Limit of search results. Max value is 200.
options.availability: Status of the game availability. Can be now, new, soon and prepurchase.
options.offset: default: 0. Change the position of the search. Useful to pagination.
options.category: Can be action_adventure, application, first_person, party, role_playing, music_fitness, education, puzzle_strategy, simulation and sports_racing.
options.price: Can be 4.99, 9.99, 19.99, 39.99 and 40_plus.
options.number: Filter by number of players. Can be 1, 2, 3 and 4.

eshop-api-wrapper's People