Docs

List sets

Cursor-paginated list of sets, ordered by game and then by code. A card's `set` is the `code` of one of these, in the card's game and language. Send `game` to list one game's sets. Zero results is a 200, not a 404.

Cursor-paginated list of sets, ordered by game and then by code. A card's set is the code of one of these, in the card's game and language. Send game to list one game's sets. Zero results is a 200, not a 404.

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.

Query Parameters

lang?string

Language of the print. Never negotiated through Accept-Language.

Match^[^\u0000-\u001f\u007f-\u009f]*[^\u0000-\u001f\u007f-\u009f\s][^\u0000-\u001f\u007f-\u009f]*$
Default"en"
cursor?string

Opaque cursor returned in next_cursor. Do not build it by hand.

Lengthlength <= 512
limit?integer

Items per page. Safe integers are clamped to 1-100, not rejected.

Range-9007199254740991 <= value <= 9007199254740991
Default20
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

A page of sets. Zero results = 200 with data: [].

application/json
  1. response

List envelope. Zero results is a 200 with data: [], never a 404.

object*string
data*array<>
has_more*boolean

The only end-of-pagination signal.

next_cursor*|

Present and non-null if and only if has_more is true.

Example Request
cURL
curl -X GET 'https://api.rarity.dev/v1/sets' \  -A 'my-app/1.0 (you@example.com)'
Example Response
{  "object": "list",  "data": [    {      "object": "set",      "game": "one_piece",      "lang": "string",      "code": "OP01",      "name": "string",      "release_date": "2019-08-24",      "source_code": "string",      "updated_at": "2019-08-24T14:15:22Z",      "search_uri": "http://example.com"    }  ],  "has_more": true,  "next_cursor": "string"}