Nintendo Switch eShop

https://favna.github.io/nintendo-switch-eshop/
Admin
Nintendo Switch eShop is an API wrapper for the Nintendo eShop that provides access to Nintendo...
Tokens:8,394
Snippets:158
Trust Score:8.3
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install with yarn

Source: https://favna.github.io/nintendo-switch-eshop/

Install the nintendo-switch-eshop package using yarn.

```bash
yarn add nintendo-switch-eshop
```

--------------------------------

### Install with npm

Source: https://favna.github.io/nintendo-switch-eshop/

Install the nintendo-switch-eshop package using npm.

```bash
npm install nintendo-switch-eshop
```

--------------------------------

### Install with bun

Source: https://favna.github.io/nintendo-switch-eshop/

Install the nintendo-switch-eshop package using bun.

```bash
bun add nintendo-switch-eshop
```

--------------------------------

### Install with pnpm

Source: https://favna.github.io/nintendo-switch-eshop/

Install the nintendo-switch-eshop package using pnpm.

```bash
pnpm add nintendo-switch-eshop
```

--------------------------------

### getQueriedGamesBrazil(query, options)

Source: https://favna.github.io/nintendo-switch-eshop/api/functions/getqueriedgamesbrazil/

Fetches a subset of games from the Brazilian e-shop as based on a given query. Returns a promise containing the first hitsPerPage games that match the query.

```APIDOC
## getQueriedGamesBrazil(query, options)

### Description
Fetches a subset of games from the Brazilian e-shop as based on a given query.

### Method
Function

### Signature
`getQueriedGamesBrazil(query: string, options?: QueriedGamesAmericaOptions): Promise<QueriedGameUS[]>`

### Parameters
- **query** (`string`) - Required - The query to search for.
- **options** (`QueriedGamesAmericaOptions`) - Optional - Additional options for the call. Defaults to `{ hitsPerPage: 200, page: 0 }`.

### Returns
`Promise<QueriedGameUS[]>` - Promise containing the first `hitsPerPage` games that match your query.

```

--------------------------------

### getGamesBrazil()

Source: https://favna.github.io/nintendo-switch-eshop/api/functions/getgamesbrazil/

Fetches all games on the Brazilian e-shop. Currently only returns all games in the e-shop.

```APIDOC
## getGamesBrazil()

### Description
Fetches all games on the Brazilian e-shop. Currently only returns all games in the e-shop.

### Method
Function call

### Endpoint
`getGamesBrazil()`

### Parameters
None

### Returns
- `Promise<GameUS[]>` - Promise containing all the games

### Example
```typescript
const games = await getGamesBrazil();
```
```

--------------------------------

### new EshopError(message)

Source: https://favna.github.io/nintendo-switch-eshop/api/classes/eshoperror/

Creates a new EshopError instance with the given error message. This is the constructor for the EshopError class.

```APIDOC
## new EshopError(message)

### Description
Creates a new EshopError instance with the specified error message.

### Constructor
`new EshopError(message)`

### Parameters
- **message** (`string`) - Required - The message the error should show.

### Returns
`EshopError` - A new EshopError instance.

### Overrides
`Error.constructor`
```

--------------------------------

### Import functions using ES modules

Source: https://favna.github.io/nintendo-switch-eshop/api/readme/

Import the desired functions from the package using ES module syntax.

```javascript
import { getGamesAmerica, getGamesEurope, getGamesJapan, getQueriedGamesAmerica } from 'nintendo-switch-eshop';
```

--------------------------------

### getQueriedGamesAmerica(query, options)

Source: https://favna.github.io/nintendo-switch-eshop/api/functions/getqueriedgamesamerica/

Fetches a subset of games from the American e-shops as based on a given query. The function takes a query string and optional options object, returning a promise with an array of QueriedGameUS objects.

```APIDOC
## getQueriedGamesAmerica(query, options)

### Description
Fetches a subset of games from the American e-shops as based on a given query.

### Method
Function

### Signature
`getQueriedGamesAmerica(query: string, options?: QueriedGamesAmericaOptions): Promise<QueriedGameUS[]>`

### Parameters
- **query** (`string`) - Required - The query to search for.
- **options** (`QueriedGamesAmericaOptions`) - Optional - Additional options for the call. Defaults to `{ hitsPerPage: 200, page: 0 }`.

### Returns
`Promise<QueriedGameUS[]>` - Promise containing the first `hitsPerPage` games that match your query.

```

--------------------------------

### Import functions using CommonJS

Source: https://favna.github.io/nintendo-switch-eshop/api/readme/

Import the desired functions from the package using CommonJS require syntax.

```javascript
const { getGamesAmerica, getGamesEurope, getGamesJapan, getQueriedGamesAmerica } = require('nintendo-switch-eshop');
```

--------------------------------

### GameEU Interface

Source: https://favna.github.io/nintendo-switch-eshop/api/interfaces/gameeu/

The GameEU interface defines the structure of game data for the European Nintendo Switch eShop. It includes properties for developer, digital version flag, eShop removal flag, excerpt, fs_id, game categories, game series, and gift finder related fields.

```APIDOC
## GameEU Interface

### Description
The GameEU interface defines the structure of game data for the European Nintendo Switch eShop. It includes properties for developer, digital version flag, eShop removal flag, excerpt, fs_id, game categories, game series, and gift finder related fields.

### Properties
- **developer** (`string`) - The developer of the game.
- **digital_version_b** (`boolean`) - Indicates whether a digital version is available.
- **eshop_removed_b** (`boolean`) - Indicates whether the game has been removed from the eShop.
- **excerpt** (`string`) - A short description or excerpt of the game.
- **fs_id** (`string`) - The unique identifier for the game.
- **game_categories_txt** (`string[]`) - An array of game category names.
- **game_category** (`string[]`) - An array of game category identifiers.
- **game_series_t** (`string`) - The game series title.
- **gift_finder_carousel_image_url_s** (`string`) - URL for the gift finder carousel image.
- **gift_finder_description_s** (`string`) - Description for the gift finder.
- **gift_finder_detail_page_image_url_s** (`string`) - URL for the gift finder detail page image.
- **gift_finder_detail_page_store_link_s** (`string`) - Store link for the gift finder detail page.
- **gift_finder_wishlist_image_url_s** (`string`) - URL for the gift finder wishlist image.

### Example
```typescript
interface GameEU {
  developer: string;
  digital_version_b: boolean;
  eshop_removed_b: boolean;
  excerpt: string;
  fs_id: string;
  game_categories_txt: string[];
  game_category: string[];
  game_series_t: string;
  gift_finder_carousel_image_url_s: string;
  gift_finder_description_s: string;
  gift_finder_detail_page_image_url_s: string;
  gift_finder_detail_page_store_link_s: string;
  gift_finder_wishlist_image_url_s: string;
}
```
```

--------------------------------

### getGamesAmerica()

Source: https://favna.github.io/nintendo-switch-eshop/api/functions/getgamesamerica/

Fetches all games on American e-shops. Currently only returns all games in the e-shop.

```APIDOC
## getGamesAmerica()

### Description
Fetches all games on American e-shops. Currently ONLY returns all games in the e-shop.

### Method
Function call

### Endpoint
`getGamesAmerica()`

### Parameters
None

### Returns
`Promise<GameUS[]>` - Promise containing all the games

### Example
```typescript
const games = await getGamesAmerica();
```
```

--------------------------------

### parseNSUID(game, region)

Source: https://favna.github.io/nintendo-switch-eshop/api/functions/parsensuid/

Extracts NSUID information from the game object. Returns the 14-digit NSUID as a string, or null if not found.

```APIDOC
## parseNSUID(game, region)

### Description
Extracts NSUID information from the game object. Returns the 14-digit NSUID as a string, or null if not found.

### Method
Function

### Signature
`parseNSUID(game, region): null | string`

### Parameters
- **game** (`GameEU | GameUS | GameJP`) - Required - The game object returned from one of the other methods.
- **region** (`Region`) - Required - Region code.

### Returns
`null | string` - The 14-digit NSUID, or null if not found.
```

--------------------------------

### parseGameCode(game, region)

Source: https://favna.github.io/nintendo-switch-eshop/api/functions/parsegamecode/

Parses the game code to extract the cross-region portion. Accepts a game object from other methods and a region code, returning the 4-digit game code or null.

```APIDOC
## parseGameCode(game, region)

### Description
Parses the game code to extract the cross-region portion.

### Method
Function

### Signature
`parseGameCode(game, region): null | string`

### Parameters
- **game** (`GameEU | GameUS | GameJP`) - Required - The game object returned from one of the other methods.
- **region** (`Region`) - Required - Region code.

### Returns
`null | string` - The 4-digit resulting game code.
```
Tokens:
Raw