QueriedGameUS
Defined in: utils/interfaces.ts:217
Properties
Section titled “Properties”_distinctSeqID
Section titled “_distinctSeqID”_distinctSeqID:
number
Defined in: utils/interfaces.ts:221
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:226
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:231
Whether this game is available or not
boxart?
Section titled “boxart?”
optionalboxart:string
Defined in: utils/interfaces.ts:236
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:238
classindRating?
Section titled “classindRating?”
optionalclassindRating:unknown
Defined in: utils/interfaces.ts:240
collectionPriceRange
Section titled “collectionPriceRange”collectionPriceRange:
string
Defined in: utils/interfaces.ts:242
contentRatingCode
Section titled “contentRatingCode”contentRatingCode:
string
Defined in: utils/interfaces.ts:244
corePlatforms
Section titled “corePlatforms”corePlatforms:
string[]
Defined in: utils/interfaces.ts:246
createdAt
Section titled “createdAt”createdAt:
Date
Defined in: utils/interfaces.ts:248
demoNsuid
Section titled “demoNsuid”demoNsuid:
null|string
Defined in: utils/interfaces.ts:250
depth?
Section titled “depth?”
optionaldepth:number
Defined in: utils/interfaces.ts:252
description
Section titled “description”description:
string
Defined in: utils/interfaces.ts:257
A description about this game
developers
Section titled “developers”developers:
string[]
Defined in: utils/interfaces.ts:262
A list of companies that developed this game
esrbDescriptors
Section titled “esrbDescriptors”esrbDescriptors:
string[]
Defined in: utils/interfaces.ts:267
A list of ESRB descriptors
esrbRating
Section titled “esrbRating”esrbRating:
string
Defined in: utils/interfaces.ts:272
The ESRB Rating
exclusive
Section titled “exclusive”exclusive:
boolean
Defined in: utils/interfaces.ts:274
featured
Section titled “featured”featured:
boolean
Defined in: utils/interfaces.ts:279
Whether this game is featured on the nintendo.com homepage
featuredProduct
Section titled “featuredProduct”featuredProduct:
boolean
Defined in: utils/interfaces.ts:284
Whether this game is featured on the nintendo.com homepage
franchises
Section titled “franchises”franchises:
string
Defined in: utils/interfaces.ts:289
The franchises this game is a part of
freeToStart
Section titled “freeToStart”freeToStart:
boolean
Defined in: utils/interfaces.ts:294
Whether this game is free to start
generalFilters
Section titled “generalFilters”generalFilters:
string[]
Defined in: utils/interfaces.ts:299
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:304
A list of genres this game
hasDlc
Section titled “hasDlc”hasDlc:
boolean
Defined in: utils/interfaces.ts:309
Whether this game has downloadable content or not
headerImage?
Section titled “headerImage?”
optionalheaderImage:string
Defined in: utils/interfaces.ts:314
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:319
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:324
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:329
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:334
The lowest price at which this game was ever sold
msrp:
number
Defined in: utils/interfaces.ts:339
The manufacturer’s suggested retail price for this game
nsoFeatures
Section titled “nsoFeatures”nsoFeatures:
string[]
Defined in: utils/interfaces.ts:344
Features that added to this game when the player has a Nintendo Switch Online subscription
nsuid:
string
Defined in: utils/interfaces.ts:349
The unique ID for this game.
numOfPlayers
Section titled “numOfPlayers”numOfPlayers:
string
Defined in: utils/interfaces.ts:354
The amount of players that can simultaneously play this game
objectID
Section titled “objectID”objectID:
string
Defined in: utils/interfaces.ts:359
A unique GUID that represents this game’s entry in the Nintendo API.
platform
Section titled “platform”platform:
string
Defined in: utils/interfaces.ts:364
The platform this game released on
platformCode
Section titled “platformCode”platformCode:
string
Defined in: utils/interfaces.ts:371
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:373
playerCount
Section titled “playerCount”playerCount:
string
Defined in: utils/interfaces.ts:387
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:392
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:380
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:397
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:416
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:418
productImage
Section titled “productImage”productImage:
string
Defined in: utils/interfaces.ts:423
The slug to a product image of this game
publishDate?
Section titled “publishDate?”
optionalpublishDate:Date
Defined in: utils/interfaces.ts:428
The date this game was published
publishers
Section titled “publishers”publishers:
string[]
Defined in: utils/interfaces.ts:433
A list of companies that published this game
releaseDateDisplay
Section titled “releaseDateDisplay”releaseDateDisplay:
string
Defined in: utils/interfaces.ts:440
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:445
The price of this game if and when it is on sale
sku:
string
Defined in: utils/interfaces.ts:450
the SKU ID for this game
slug:
string
Defined in: utils/interfaces.ts:455
A unique slug for this game
smecDescriptors
Section titled “smecDescriptors”smecDescriptors:
string[]
Defined in: utils/interfaces.ts:461
The SMEC (Sistema Mexicano de Equivalencias de Clasificación) descriptors for this game
smecRating
Section titled “smecRating”smecRating:
string
Defined in: utils/interfaces.ts:467
The SMEC (Sistema Mexicano de Equivalencias de Clasificación) rating for this game
softwareDeveloper
Section titled “softwareDeveloper”softwareDeveloper:
string
Defined in: utils/interfaces.ts:472
The developer of this game
softwarePublisher
Section titled “softwarePublisher”softwarePublisher:
string
Defined in: utils/interfaces.ts:477
The publisher of this game
title:
string
Defined in: utils/interfaces.ts:482
The title of this game
topLevelCategory
Section titled “topLevelCategory”topLevelCategory:
string
Defined in: utils/interfaces.ts:489
The top level category of this game
Example
Section titled “Example”'Games'topLevelCategoryCode
Section titled “topLevelCategoryCode”topLevelCategoryCode:
string
Defined in: utils/interfaces.ts:496
The top level category code of this game
Example
Section titled “Example”'GAMES'topLevelFilters
Section titled “topLevelFilters”topLevelFilters:
string[]
Defined in: utils/interfaces.ts:501
The top level filters for this game
type:
string
Defined in: utils/interfaces.ts:508
The type of search result
Example
Section titled “Example”'game'updatedAt
Section titled “updatedAt”updatedAt:
string
Defined in: utils/interfaces.ts:513
An ISO timestamp of when this game was last updated
url:
string
Defined in: utils/interfaces.ts:518
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:523
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:528
Whether this game is visible when searching for it on nintendo.com