コンテンツにスキップ

所有ゲーム機の一覧

POST
/rest/v1/getConsoles
curl --request POST \
--url https://game.retrogather.com/rest/v1/getConsoles \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "ratingFrom": 1, "ratingTo": 1, "unrated": true, "buyDateFrom": "2026-04-15", "buyDateTo": "2026-04-15", "buyPriceFrom": 1, "buyPriceTo": 1, "sortBy": "name", "sortOrder": "asc", "page": 1, "limit": 1, "fields": [ "purchase" ] }'

LIGHT+. Owned hardware / 所有ゲーム機: list consoles with page/limit. Default sort is rating desc (same as the app). Maintenance history is omitted.

Plans: LIGHT / PREMIUM. Scopes: play:read.

Media typeapplication/json
object
name

Name or publisher (substring)

string
<= 30 characters
ratingFrom

Minimum rating (1-5)

integer
>= 1 <= 5
ratingTo

Maximum rating (1-5)

integer
>= 1 <= 5
unrated

Only consoles with no rating

boolean
buyDateFrom

YYYY-MM-DD

string format: date
buyDateTo

YYYY-MM-DD

string format: date
buyPriceFrom
integer
buyPriceTo
integer
sortBy
string
Allowed values: name rating buyDate buyPrice createdAt updatedAt
sortOrder

Asc or desc

string
Allowed values: asc desc
page
integer
>= 1
limit
integer
>= 1 <= 200
fields

Optional groups. Omit for default (purchase). [] returns core fields only (consoleId, name, rating, publisherName). purchase: buyDate, buyPrice, buyPlace. platforms: [{platformId,name,priority}]. memo: memo and nameKana. timestamps: createdAt, updatedAt.

Array<string>
Allowed values: purchase platforms timestamps memo

Tool result JSON (no MCP envelope). Delete previews also return 200 with confirmToken.

Media typeapplication/json
Any of:
object
items
required
Array<object>
object
consoleId
required
string
name
required
string
rating
integer
publisherName
string
buyDate
string
buyPrice
number
buyPlace
string
platforms
Array<object>
object
platformId
required
integer
name
string
priority
required
integer
key
additional properties
any
memo
string
nameKana
string
createdAt
string
updatedAt
string
platformPriorities
Array<object>
object
platformId
required
integer
priority
required
integer
key
additional properties
any
key
additional properties
any
page
required
integer
returnedCount
required
integer
totalCount
required
integer
hasMore
required
boolean
effectiveLimit
integer
limitReduced
boolean
limitReason
string
key
additional properties
any
Example
{
"code": "plan_required",
"status": "PLANNED",
"items": [
{
"status": "added"
}
]
}

Invalid_input (arguments, broken JSON body)

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}

Missing or invalid API key

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}

Insufficient_scope, plan_required, or access_suspended

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}

Target or tool not found

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}

Burst or daily quota exceeded. See resetAt.

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}
Retry-After
integer

Seconds

Unexpected server failure. Retrying the same call will not help.

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}

Temporary failure or maintenance. Retry after Retry-After.

Media typeapplication/json

Entry errors (auth, routing, quota) use error; tool errors use code and message. Check retryable when present.

object
error
string
code
string
message
string
retryable
boolean
retryAfterSec
integer
requestId
string
resetAt
string
remaining
integer
scopes
Array<string>
upgradeUrl
string
key
additional properties
any
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"retryable": true,
"retryAfterSec": 1,
"requestId": "example",
"resetAt": "example",
"remaining": 1,
"scopes": [
"example"
],
"upgradeUrl": "example"
}
Retry-After
integer

Seconds