Docs

Retrieve a game

Returns the game's policy, formats and `attributes` JSON Schema. Generic clients can read `attributes_schema` to build game-specific filters without hardcoding publisher fields.

Returns the game's policy, formats and attributes JSON Schema. Generic clients can read attributes_schema to build game-specific filters without hardcoding publisher fields.

Authorization

ApiKey
headerAuthorizationBearer <rar_live_*>

Send Authorization: Bearer rar_live_..., or use rar_test_... for a test key. Both lanes currently read the same catalogue. Without a key you stay in the anonymous lane: 30 requests/minute and 1,000/day, against 60/minute per key and 2,000/day per organization with one on the Free plan. Sending a key that is malformed, revoked or unknown is a 401; sending none is not.

Path Parameters

game*string

Game code, as returned in a card's game.

Match^[^\u0000-\u001f\u007f-\u009f]*[^\u0000-\u001f\u007f-\u009f\s][^\u0000-\u001f\u007f-\u009f]*$

Header Parameters

If-None-Match?string

ETag already known to the client. A 304 does not consume rate limit.

Response Body

The game.

application/json
  1. response

A registered game: its policy, its formats, and the schema of its attributes.

object*string
code*GameCode

Game code. The list grows: treat it as an open string. Adding a value is not a breaking change.

policy*
formats*array<>
attributes_schema*

JSON Schema 2020-12 for this game's attributes object, returned as data. Generic clients can read it to build game-specific filters. Adding a game changes this schema without changing the shared card fields.

search_uri*string

Every card of this game. Relations in this API are search URLs, never sub-collections.

Formaturi
Example Request
cURL
curl -X GET 'https://api.rarity.dev/v1/games/one_piece' \  -A 'my-app/1.0 (you@example.com)'
Example Response
{  "object": "game",  "code": "one_piece",  "policy": {    "monetizable": true,    "images": "hosted",    "since": "string",    "notes": [      "string"    ]  },  "formats": [    {      "format": "standard",      "blocks": [        "string"      ],      "rotated": [        "string"      ],      "since": "string"    }  ],  "attributes_schema": {},  "search_uri": "http://example.com"}