所有ゲーム機の一覧

GET

/rest/v1/getConsoles

curl --request GET \
  --url 'https://game.retrogather.com/rest/v1/getConsoles?sortBy=name&sortOrder=asc' \
  --header 'Authorization: Bearer <token>'

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

Arrays are comma-separated. Percent-encode query values; Japanese values are easier to send with POST JSON. Plans: LIGHT / PREMIUM. Scopes: play:read.

Authorizations

• apiKey

Parameters

Query Parameters

name

string

<= 30 characters

Name or publisher (substring)

ratingFrom

integer

>= 1 <= 5

Minimum rating (1-5)

ratingTo

integer

>= 1 <= 5

Maximum rating (1-5)

unrated

boolean

Only consoles with no rating

buyDateFrom

string format: date

YYYY-MM-DD

buyDateTo

string format: date

YYYY-MM-DD

buyPriceFrom

integer

buyPriceTo

integer

sortBy

string

Allowed values: name rating buyDate buyPrice createdAt updatedAt

sortOrder

string

Allowed values: asc desc

Asc or desc

page

integer

>= 1

limit

integer

>= 1 <= 200

fields

Array<string>

Allowed values: purchase platforms timestamps memo

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.

Responses

200

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

Media typeapplication/json

Any of:

object

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

object

object

code

required

string

Allowed values: plan_required not_found invalid_input unavailable already_exists revision_conflict insufficient_scope

message

string

upgradeUrl

string

field

string

allowedValues

Array<string>

scope

string

additionalScopesRequired

Array<string>

playId

string

saved

boolean

physicalId

string

physicalIds

Array<string>

createdPhysicalIds

Array<string>

deletedId

string

status

string

Allowed values: PLANNED PLAYING PAUSED COMPLETED DROPPED

items

Array<object>

object

gameId

required

integer

status

required

string

Allowed values: added already_in_library not_found

fromWishlist

boolean

key

additional properties

any

limit

object

max

required

integer

current

required

integer

requested

required

integer

key

additional properties

any

key

additional properties

any

Example

{
  "code": "plan_required",
  "status": "PLANNED",
  "items": [
    {
      "status": "added"
    }
  ]
}

400

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

401

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

403

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

404

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

429

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

Headers

Retry-After

integer

Seconds

500

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

503

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "retryable": true,
  "retryAfterSec": 1,
  "requestId": "example",
  "resetAt": "example",
  "remaining": 1,
  "scopes": [
    "example"
  ],
  "upgradeUrl": "example"
}

Headers

Retry-After

integer

Seconds