QueriedGameUS
Defined in: utils/interfaces.ts:220
Properties
Section titled “Properties”_distinctSeqID
Section titled “_distinctSeqID”_distinctSeqID:
number
Defined in: utils/interfaces.ts:224
Additional information returned by the API, it doesn’t really serve any purpose but documenting it anyway because it’s there.
_highlightResult
Section titled “_highlightResult”_highlightResult:
HighlightResult
Defined in: utils/interfaces.ts:229
Additional information returned by the API, it doesn’t really serve any purpose but documenting it anyway because it’s there.
availability
Section titled “availability”availability:
string[]
Defined in: utils/interfaces.ts:234
Whether this game is available or not
boxart?
Section titled “boxart?”
optionalboxart:string
Defined in: utils/interfaces.ts:239
The box art of the game, if any. Generally undefined for games that are yet to release.
classindDescriptors?
Section titled “classindDescriptors?”
optionalclassindDescriptors:unknown
Defined in: utils/interfaces.ts:241
classindRating?
Section titled “classindRating?”
optionalclassindRating:unknown
Defined in: utils/interfaces.ts:243
collectionPriceRange
Section titled “collectionPriceRange”collectionPriceRange:
string
Defined in: utils/interfaces.ts:245
contentRatingCode
Section titled “contentRatingCode”contentRatingCode:
string
Defined in: utils/interfaces.ts:247
corePlatforms
Section titled “corePlatforms”corePlatforms:
string[]
Defined in: utils/interfaces.ts:249
createdAt
Section titled “createdAt”createdAt:
Date
Defined in: utils/interfaces.ts:251
demoNsuid
Section titled “demoNsuid”demoNsuid:
null|string
Defined in: utils/interfaces.ts:253
depth?
Section titled “depth?”
optionaldepth:number
Defined in: utils/interfaces.ts:255
description
Section titled “description”description:
string
Defined in: utils/interfaces.ts:260
A description about this game
developers
Section titled “developers”developers:
string[]
Defined in: utils/interfaces.ts:265
A list of companies that developed this game
esrbDescriptors
Section titled “esrbDescriptors”esrbDescriptors:
string[]
Defined in: utils/interfaces.ts:270
A list of ESRB descriptors
esrbRating
Section titled “esrbRating”esrbRating:
string
Defined in: utils/interfaces.ts:275
The ESRB Rating
exclusive
Section titled “exclusive”exclusive:
boolean
Defined in: utils/interfaces.ts:277
featured
Section titled “featured”featured:
boolean
Defined in: utils/interfaces.ts:282
Whether this game is featured on the nintendo.com homepage
featuredProduct
Section titled “featuredProduct”featuredProduct:
boolean
Defined in: utils/interfaces.ts:287
Whether this game is featured on the nintendo.com homepage
franchises
Section titled “franchises”franchises:
string
Defined in: utils/interfaces.ts:292
The franchises this game is a part of
freeToStart
Section titled “freeToStart”freeToStart:
boolean
Defined in: utils/interfaces.ts:297
Whether this game is free to start
generalFilters
Section titled “generalFilters”generalFilters:
string[]
Defined in: utils/interfaces.ts:302
A list of general filters that could potentially be searched on nintendo.com to find this game with
genres
Section titled “genres”genres:
string[]
Defined in: utils/interfaces.ts:307
A list of genres this game
hasDlc
Section titled “hasDlc”hasDlc:
boolean
Defined in: utils/interfaces.ts:312
Whether this game has downloadable content or not
headerImage?
Section titled “headerImage?”
optionalheaderImage:string
Defined in: utils/interfaces.ts:317
A large wide image such as a screenshot or artwork of the game, if any.
horizontalHeaderImage?
Section titled “horizontalHeaderImage?”
optionalhorizontalHeaderImage:string
Defined in: utils/interfaces.ts:322
The asset slug of a large wide image such as a screenshot or artwork of the game, if any.
howToShop
Section titled “howToShop”howToShop:
string[]
Defined in: utils/interfaces.ts:327
A list of methods through which the game can be acquired, such as retail or digital download.
lastModified
Section titled “lastModified”lastModified:
number
Defined in: utils/interfaces.ts:332
A Unix timestamp in milliseconds indicating when the information on this game was last modified
lowestPrice
Section titled “lowestPrice”lowestPrice:
number
Defined in: utils/interfaces.ts:337
The lowest price at which this game was ever sold
msrp:
number
Defined in: utils/interfaces.ts:342
The manufacturer’s suggested retail price for this game
nsoFeatures
Section titled “nsoFeatures”nsoFeatures:
string[]
Defined in: utils/interfaces.ts:347
Features that added to this game when the player has a Nintendo Switch Online subscription
nsuid:
string
Defined in: utils/interfaces.ts:352
The unique ID for this game.
numOfPlayers
Section titled “numOfPlayers”numOfPlayers:
string
Defined in: utils/interfaces.ts:357
The amount of players that can simultaneously play this game
objectID
Section titled “objectID”objectID:
string
Defined in: utils/interfaces.ts:362
A unique GUID that represents this game’s entry in the Nintendo API.
platform
Section titled “platform”platform:
string
Defined in: utils/interfaces.ts:367
The platform this game released on
platformCode
Section titled “platformCode”platformCode:
string
Defined in: utils/interfaces.ts:374
A unique identifier of the platform the game was released on
Example
Section titled “Example”'NINTENDO_SWITCH'platinumPoints?
Section titled “platinumPoints?”
optionalplatinumPoints:any
Defined in: utils/interfaces.ts:376
playerCount
Section titled “playerCount”playerCount:
string
Defined in: utils/interfaces.ts:390
The amount of players that can simultaniously play this game
Example
Section titled “Example”'Single Player'playerFilters
Section titled “playerFilters”playerFilters:
string[]
Defined in: utils/interfaces.ts:395
A list of player filters that could potentially be searched on nintendo.com to find this game with
playModes
Section titled “playModes”playModes:
string[]
Defined in: utils/interfaces.ts:383
An array of ways this game can be played
Example
Section titled “Example”['TV mode', 'Tabletop mode', 'Handheld mode']price:
object
Defined in: utils/interfaces.ts:400
The price information for this game
finalPrice
Section titled “finalPrice”finalPrice:
number
The final price for this game,
which is salePrice if the game is on sale or regPrice if it is not.
regPrice
Section titled “regPrice”regPrice:
number
The regular price for this game
salePrice
Section titled “salePrice”salePrice:
null|number
The sale price for this game, or null if the game has never been on sale.
priceRange
Section titled “priceRange”priceRange:
string
Defined in: utils/interfaces.ts:419
A category price range that this game falls under. Can be used on nintendo.com to find this game with
priority?
Section titled “priority?”
optionalpriority:number
Defined in: utils/interfaces.ts:421
productImage
Section titled “productImage”productImage:
string
Defined in: utils/interfaces.ts:426
The slug to a product image of this game
publishDate?
Section titled “publishDate?”
optionalpublishDate:Date
Defined in: utils/interfaces.ts:431
The date this game was published
publishers
Section titled “publishers”publishers:
string[]
Defined in: utils/interfaces.ts:436
A list of companies that published this game
releaseDateDisplay
Section titled “releaseDateDisplay”releaseDateDisplay:
string
Defined in: utils/interfaces.ts:443
A display of the release of this game. Can be either an ISO timestamp or some other representation of date.
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.
salePrice
Section titled “salePrice”salePrice:
null|number
Defined in: utils/interfaces.ts:448
The price of this game if and when it is on sale
sku:
string
Defined in: utils/interfaces.ts:453
the SKU ID for this game
slug:
string
Defined in: utils/interfaces.ts:458
A unique slug for this game
smecDescriptors
Section titled “smecDescriptors”smecDescriptors:
string[]
Defined in: utils/interfaces.ts:464
The SMEC (Sistema Mexicano de Equivalencias de Clasificación) descriptors for this game
smecRating
Section titled “smecRating”smecRating:
string
Defined in: utils/interfaces.ts:470
The SMEC (Sistema Mexicano de Equivalencias de Clasificación) rating for this game
softwareDeveloper
Section titled “softwareDeveloper”softwareDeveloper:
string
Defined in: utils/interfaces.ts:475
The developer of this game
softwarePublisher
Section titled “softwarePublisher”softwarePublisher:
string
Defined in: utils/interfaces.ts:480
The publisher of this game
title:
string
Defined in: utils/interfaces.ts:485
The title of this game
topLevelCategory
Section titled “topLevelCategory”topLevelCategory:
string
Defined in: utils/interfaces.ts:492
The top level category of this game
Example
Section titled “Example”'Games'topLevelCategoryCode
Section titled “topLevelCategoryCode”topLevelCategoryCode:
string
Defined in: utils/interfaces.ts:499
The top level category code of this game
Example
Section titled “Example”'GAMES'topLevelFilters
Section titled “topLevelFilters”topLevelFilters:
string[]
Defined in: utils/interfaces.ts:504
The top level filters for this game
type:
string
Defined in: utils/interfaces.ts:511
The type of search result
Example
Section titled “Example”'game'updatedAt
Section titled “updatedAt”updatedAt:
string
Defined in: utils/interfaces.ts:516
An ISO timestamp of when this game was last updated
url:
string
Defined in: utils/interfaces.ts:521
A unique to the information about this game. Prefix it with nintendo.com to have a valid URL.
urlKey
Section titled “urlKey”urlKey:
string
Defined in: utils/interfaces.ts:526
The key segment of the QueriedGameUS.url, often the last segment of the URL
visibleInSearch
Section titled “visibleInSearch”visibleInSearch:
boolean
Defined in: utils/interfaces.ts:531
Whether this game is visible when searching for it on nintendo.com