Skip to content
logo Switch eShop API Wrapper

QueriedGameUS

Properties

_distinctSeqID

_distinctSeqID: number

Additional information returned by the API, it doesn’t really serve any purpose but documenting it anyway because it’s there.

Source

lib/utils/interfaces.ts:194

_highlightResult

_highlightResult: HighlightResult

Additional information returned by the API, it doesn’t really serve any purpose but documenting it anyway because it’s there.

Source

lib/utils/interfaces.ts:197

availability

availability: string[]

Whether this game is available or not

Source

lib/utils/interfaces.ts:200

boxart?

optional boxart: string

The box art of the game, if any. Generally undefined for games that are yet to release.

Source

lib/utils/interfaces.ts:203

classindDescriptors?

optional classindDescriptors: unknown

Source

lib/utils/interfaces.ts:205

classindRating?

optional classindRating: unknown

Source

lib/utils/interfaces.ts:207

collectionPriceRange

collectionPriceRange: string

Source

lib/utils/interfaces.ts:209

contentRatingCode

contentRatingCode: string

Source

lib/utils/interfaces.ts:211

corePlatforms

corePlatforms: string[]

Source

lib/utils/interfaces.ts:213

createdAt

createdAt: Date

Source

lib/utils/interfaces.ts:215

demoNsuid

demoNsuid: null | string

Source

lib/utils/interfaces.ts:217

depth?

optional depth: number

Source

lib/utils/interfaces.ts:219

description

description: string

A description about this game

Source

lib/utils/interfaces.ts:222

developers

developers: string[]

A list of companies that developed this game

Source

lib/utils/interfaces.ts:225

esrbDescriptors

esrbDescriptors: string[]

A list of ESRB descriptors

Source

lib/utils/interfaces.ts:228

esrbRating

esrbRating: string

The ESRB Rating

Source

lib/utils/interfaces.ts:231

exclusive

exclusive: boolean

Source

lib/utils/interfaces.ts:233

featured: boolean

Whether this game is featured on the nintendo.com homepage

Source

lib/utils/interfaces.ts:236

featuredProduct

featuredProduct: boolean

Whether this game is featured on the nintendo.com homepage

Source

lib/utils/interfaces.ts:239

franchises

franchises: string

The franchises this game is a part of

Source

lib/utils/interfaces.ts:242

freeToStart

freeToStart: boolean

Whether this game is free to start

Source

lib/utils/interfaces.ts:245

generalFilters

generalFilters: string[]

A list of general filters that could potentially be searched on nintendo.com to find this game with

Source

lib/utils/interfaces.ts:248

genres

genres: string[]

A list of genres this game

Source

lib/utils/interfaces.ts:251

hasDlc

hasDlc: boolean

Whether this game has downloadable content or not

Source

lib/utils/interfaces.ts:254

headerImage?

optional headerImage: string

A large wide image such as a screenshot or artwork of the game, if any.

Source

lib/utils/interfaces.ts:257

horizontalHeaderImage?

optional horizontalHeaderImage: string

The asset slug of a large wide image such as a screenshot or artwork of the game, if any.

Source

lib/utils/interfaces.ts:260

howToShop

howToShop: string[]

A list of methods through which the game can be acquired, such as retail or digital download.

Source

lib/utils/interfaces.ts:263

lastModified

lastModified: number

A Unix timestamp in milliseconds indicating when the information on this game was last modified

Source

lib/utils/interfaces.ts:266

lowestPrice

lowestPrice: number

The lowest price at which this game was ever sold

Source

lib/utils/interfaces.ts:269

msrp

msrp: number

The manufacturer’s suggested retail price for this game

Source

lib/utils/interfaces.ts:272

nsoFeatures

nsoFeatures: string[]

Features that added to this game when the player has a Nintendo Switch Online subscription

Source

lib/utils/interfaces.ts:275

nsuid

nsuid: string

The unique ID for this game.

Source

lib/utils/interfaces.ts:278

numOfPlayers

numOfPlayers: string

The amount of players that can simultaneously play this game

Source

lib/utils/interfaces.ts:281

objectID

objectID: string

A unique GUID that represents this game’s entry in the Nintendo API.

Source

lib/utils/interfaces.ts:284

platform

platform: string

The platform this game released on

Source

lib/utils/interfaces.ts:287

platformCode

platformCode: string

A unique identifier of the platform the game was released on

Example

'NINTENDO_SWITCH'

Source

lib/utils/interfaces.ts:293

platinumPoints?

optional platinumPoints: any

Source

lib/utils/interfaces.ts:295

playModes

playModes: string[]

An array of ways this game can be played

Example

['TV mode', 'Tabletop mode', 'Handheld mode']

Source

lib/utils/interfaces.ts:310

playerCount

playerCount: string

The amount of players that can simultaniously play this game

Example

'Single Player'

Source

lib/utils/interfaces.ts:301

playerFilters

playerFilters: string[]

A list of player filters that could potentially be searched on nintendo.com to find this game with

Source

lib/utils/interfaces.ts:304

price

price: object

The price information for this game

finalPrice

finalPrice: number

The final price for this game, which is QueriedGameUS.price.salePrice if the game is on sale or QueriedGameUS.price.regPrice if it is not.

regPrice

regPrice: number

The regular price for this game

salePrice

salePrice: null | number

The sale price for this game, or null if the game has never been on sale.

Source

lib/utils/interfaces.ts:313

priceRange

priceRange: string

A category price range that this game falls under. Can be used on nintendo.com to find this game with

Source

lib/utils/interfaces.ts:328

priority?

optional priority: number

Source

lib/utils/interfaces.ts:330

productImage

productImage: string

The slug to a product image of this game

Source

lib/utils/interfaces.ts:333

publishDate?

optional publishDate: Date

The date this game was published

Source

lib/utils/interfaces.ts:336

publishers

publishers: string[]

A list of companies that published this game

Source

lib/utils/interfaces.ts:339

releaseDateDisplay

releaseDateDisplay: string

A display of the release of this game. Can be either an ISO timestamp or some other representation of date.

Remark

Nintendo has a tendency to also have entries such as Early 2022 or Late 2021 here. Normally these kinds of dates would not be parsed by JavaScript, but NodeJS does parse these natural input types.

Source

lib/utils/interfaces.ts:345

salePrice

salePrice: null | number

The price of this game if and when it is on sale

Source

lib/utils/interfaces.ts:348

sku

sku: string

the SKU ID for this game

Source

lib/utils/interfaces.ts:351

slug

slug: string

A unique slug for this game

Source

lib/utils/interfaces.ts:354

smecDescriptors

smecDescriptors: string[]

The SMEC (Sistema Mexicano de Equivalencias de Clasificación) descriptors for this game

Source

lib/utils/interfaces.ts:360

smecRating

smecRating: string

The SMEC (Sistema Mexicano de Equivalencias de Clasificación) rating for this game

Source

lib/utils/interfaces.ts:366

softwareDeveloper

softwareDeveloper: string

The developer of this game

Source

lib/utils/interfaces.ts:371

softwarePublisher

softwarePublisher: string

The publisher of this game

Source

lib/utils/interfaces.ts:376

title

title: string

The title of this game

Source

lib/utils/interfaces.ts:379

topLevelCategory

topLevelCategory: string

The top level category of this game

Example

'Games'

Source

lib/utils/interfaces.ts:385

topLevelCategoryCode

topLevelCategoryCode: string

The top level category code of this game

Example

'GAMES'

Source

lib/utils/interfaces.ts:391

topLevelFilters

topLevelFilters: string[]

The top level filters for this game

Source

lib/utils/interfaces.ts:394

type

type: string

The type of search result

Example

'game'

Source

lib/utils/interfaces.ts:400

updatedAt

updatedAt: string

An ISO timestamp of when this game was last updated

Source

lib/utils/interfaces.ts:405

url

url: string

A unique to the information about this game. Prefix it with https://www.nintendo.com to have a valid URL.

Source

lib/utils/interfaces.ts:408

urlKey

urlKey: string

The key segment of the QueriedGameUS.url, often the last segment of the URL

Source

lib/utils/interfaces.ts:413

visibleInSearch

visibleInSearch: boolean

Whether this game is visible when searching for it on https://www.nintendo.com

Source

lib/utils/interfaces.ts:416