RingsDB API

https://ringsdb.com/api/doc
Admin
RingsDB API provides RESTful endpoints to access card, deck, decklist, pack, and scenario data for...
Tokens:3,090
Snippets:17
Trust Score:8.8
Update:8 months ago
Show doc for...
Tokens:
Raw
### GET /api/public/cards/

Source: https://ringsdb.com/api/doc/index

Retrieves a list of all available cards in the system.

```APIDOC
## GET /api/public/cards/

### Description
Get the description of all the cards as an array of JSON objects.

### Method
GET

### Endpoint
/api/public/cards/

### Parameters
#### Query Parameters
- **jsonp** (string) - Optional - JSONP callback

### Response
#### Success Response (200)
- **[Array of Card Objects]** (array) - A list of all cards.

#### Response Example
```json
{
  "example": "[{\"code\": \"01001\", \"name\": \"Frodo Baggins\"}, {\"code\": \"01002\", \"name\": \"Samwise Gamgee\"}]"
}
```
```

--------------------------------

### GET /api/oauth2/deck/load/{id}

Source: https://ringsdb.com/api/doc/index

Loads a specific deck belonging to the authenticated user.

```APIDOC
## GET /api/oauth2/deck/load/{id}

### Description
Get the description of one Deck of the authenticated user.

### Method
GET

### Endpoint
/api/oauth2/deck/load/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The numeric identifier of the Deck to load

### Response
#### Success Response (200)
- **[Deck Object]** (object) - The deck details.

#### Response Example
```json
{
  "example": "{\"id\": 123, \"name\": \"My First Deck\", ...}"
}
```
```

--------------------------------

### GET /api/public/packs/

Source: https://ringsdb.com/api/doc/index

Retrieves a list of all available packs as an array of JSON objects.

```APIDOC
## GET /api/public/packs/

### Description
Get the description of all the packs as an array of JSON objects.

### Method
GET

### Endpoint
/api/public/packs/

### Parameters
#### Query Parameters
- **jsonp** (string) - Optional - JSONP callback function name.

### Response
#### Success Response (200)
- **packs** (array) - An array of pack objects.

#### Response Example
```json
{
  "packs": [
    {
      "code": "core",
      "name": "Core Set"
    }
  ]
}
```
```

--------------------------------

### Public API - Get All Packs Data

Source: https://ringsdb.com/api/doc/api

Retrieve data for all available packs.

```APIDOC
## GET /api/public/packs/

### Description
Retrieves a list of all available packs and their associated data.

### Method
GET

### Endpoint
`/api/public/packs/`

### Parameters
#### Query Parameters
- **jsonp** (string) - Optional - A callback function name to wrap the JSON response for JSONP requests.

### Request Example
```
GET https://ringsdb.com/api/public/packs/?jsonp=parseSets
```

### Response
#### Success Response (200)
- **packs_data** (array) - An array of objects, where each object represents a pack.

#### Response Example
```json
{
  "packs_data": [
    {
      "code": "core",
      "name": "Core Set",
      "cycle_code": "core",
      "cycle_name": "Core Set",
      "position": 1,
      "available": 3,
      "known": 3,
      "total": 3,
      "url": "/pack/core"
    },
    {
      "code": "taf",
      "name": "The Antourage of Frodos",
      "cycle_code": "taf",
      "cycle_name": "The Antourage of Frodos",
      "position": 2,
      "available": 3,
      "known": 3,
      "total": 3,
      "url": "/pack/taf"
    }
  ]
}
```
```

--------------------------------

### GET /api/public/decklists/by_date/{date}

Source: https://ringsdb.com/api/doc/index

Retrieves all decklists published on a specific date. Returns an array of JSON objects, each representing a decklist.

```APIDOC
## GET /api/public/decklists/by_date/{date}

### Description
Get the description of all the decklists published at a given date, as an array of JSON objects.

### Method
GET

### Endpoint
/api/public/decklists/by_date/{date}.{_format}

### Parameters
#### Path Parameters
- **date** (string) - Required - The date in 'Y-m-d' format.
- **_format** (string) - Required - The format of the returned data. Only 'json' is supported at the moment.

#### Query Parameters
- **jsonp** (string) - Optional - JSONP callback function name.

### Response
#### Success Response (200)
- **decklists** (array) - An array of decklist objects.

#### Response Example
```json
{
  "decklists": [
    {
      "id": 12345,
      "name": "Deck One"
    },
    {
      "id": 67890,
      "name": "Deck Two"
    }
  ]
}
```
```

--------------------------------

### GET /api/oauth2/decks

Source: https://ringsdb.com/api/doc/index

Retrieves a list of all decks belonging to the authenticated user.

```APIDOC
## GET /api/oauth2/decks

### Description
Get the description of all the Decks of the authenticated user.

### Method
GET

### Endpoint
/api/oauth2/decks

### Response
#### Success Response (200)
- **[Array of Deck Objects]** (array) - A list of the user's decks.

#### Response Example
```json
{
  "example": "[{\"id\": 123, \"name\": \"My First Deck\"}, {\"id\": 789, \"name\": \"Another Deck\"}]"
}
```
```

--------------------------------

### GET /api/public/cards/{pack_code}

Source: https://ringsdb.com/api/doc/index

Retrieves all cards belonging to a specific pack.

```APIDOC
## GET /api/public/cards/{pack_code}

### Description
Get the description of all the card from a pack, as an array of JSON objects.

### Method
GET

### Endpoint
/api/public/cards/{pack_code}.{_format}

### Parameters
#### Path Parameters
- **pack_code** (string) - Required - The code of the pack to get the cards from, e.g. 'core'
- **_format** (string) - Required - The format of the returned data. Only 'json', 'xml', 'xlsx', 'xls' are supported at the moment.

#### Query Parameters
- **jsonp** (string) - Optional - JSONP callback

### Response
#### Success Response (200)
- **[Array of Card Objects]** (array) - A list of cards from the specified pack.

#### Response Example
```json
{
  "example": "[{\"code\": \"01001\", \"name\": \"Frodo Baggins\"}, {\"code\": \"01002\", \"name\": \"Samwise Gamgee\"}]"
}
```
```

--------------------------------

### GET /api/public/decklist/{decklist_id}

Source: https://ringsdb.com/api/doc/index

Retrieves the description of a specific decklist as a JSON object. Requires a decklist ID and supports JSON format.

```APIDOC
## GET /api/public/decklist/{decklist_id}

### Description
Get the description of a decklist as a JSON object.

### Method
GET

### Endpoint
/api/public/decklist/{decklist_id}.{_format}

### Parameters
#### Path Parameters
- **decklist_id** (integer) - Required - The numeric identifier of the decklist.
- **_format** (string) - Required - The format of the returned data. Only 'json' is supported at the moment.

#### Query Parameters
- **jsonp** (string) - Optional - JSONP callback function name.

### Response
#### Success Response (200)
- **decklist_data** (object) - Contains the decklist details.

#### Response Example
```json
{
  "decklist_data": {
    "id": 12345,
    "name": "Example Deck",
    "description": "A sample deck for testing."
  }
}
```
```

--------------------------------

### GET /api/public/scenario/{scenario_id}

Source: https://ringsdb.com/api/doc/index

Retrieves the description of a specific scenario as a JSON object. Requires a scenario ID and supports JSON format.

```APIDOC
## GET /api/public/scenario/{scenario_id}

### Description
Get the description of a scenario as a JSON object.

### Method
GET

### Endpoint
/api/public/scenario/{scenario_id}.{_format}

### Parameters
#### Path Parameters
- **scenario_id** (integer) - Required - The numeric identifier of the scenario.
- **_format** (string) - Required - The format of the returned data. Only 'json' is supported at the moment.

#### Query Parameters
- **jsonp** (string) - Optional - JSONP callback function name.

### Response
#### Success Response (200)
- **scenario_data** (object) - Contains the scenario details.

#### Response Example
```json
{
  "scenario_data": {
    "id": 101,
    "name": "The Black Gate Opens"
  }
}
```
```

--------------------------------

### GET /api/public/card/{card_code}

Source: https://ringsdb.com/api/doc/index

Retrieves the details of a specific card using its unique card code.

```APIDOC
## GET /api/public/card/{card_code}

### Description
Get the description of a card as a JSON object.

### Method
GET

### Endpoint
/api/public/card/{card_code}.{_format}

### Parameters
#### Path Parameters
- **card_code** (string) - Required - The code of the card to get, e.g. '01001'
- **_format** (string) - Required - The format of the returned data. Only 'json' is supported at the moment.

#### Query Parameters
- **jsonp** (string) - Optional - JSONP callback

### Response
#### Success Response (200)
- **[Card Object]** (object) - Description of the card

#### Response Example
```json
{
  "example": "{\"code\": \"01001\", \"name\": \"Frodo Baggins\", ...}"
}
```
```

--------------------------------

### Public API - Get Card Data

Source: https://ringsdb.com/api/doc/api

Retrieve data for a specific card using its ID.

```APIDOC
## GET /api/public/card/{card_id}

### Description
Retrieves detailed information about a specific card from the RingsDB database.

### Method
GET

### Endpoint
`/api/public/card/{card_id}`

### Parameters
#### Path Parameters
- **card_id** (string) - Required - The unique identifier of the card.

### Request Example
```
GET https://ringsdb.com/api/public/card/01001
```

### Response
#### Success Response (200)
- **card_data** (object) - Contains all details about the requested card.

#### Response Example
```json
{
  "card_data": {
    "id": "01001",
    "name": "Frodo Baggins",
    "code": "01001",
    "pack_code": "core",
    "pack_name": "Core Set",
    "type_code": "hero",
    "type_name": "Hero",
    "sphere_code": "spirit",
    "sphere_name": "Spirit",
    "text": "...",
    "flavor": "...",
    "artist": "T $ T",
    "illustrator": "T $ T",
    "is_unique": true,
    "threat": 2,
    "willpower": 2,
    "attack": 1,
    "defense": 2,
    "cost": 3,
    "quantity": 3,
    "available": 3,
    "imagesrc": "/images/cards/01001.png",
    "url": "/card/01001"
  }
}
```
```

--------------------------------

### GET /api/public/decklists/top_by_card/{card_code}

Source: https://ringsdb.com/api/doc/index

Retrieves the top 10 decklists that include a specific card. Returns an array of JSON objects.

```APIDOC
## GET /api/public/decklists/top_by_card/{card_code}

### Description
Get the top 10 decklists published containing given card, as an array of JSON objects.

### Method
GET

### Endpoint
/api/public/decklists/top_by_card/{card_code}.{_format}

### Parameters
#### Path Parameters
- **card_code** (string) - Required - The code of the card to get, e.g. '01001'.
- **_format** (string) - Required - The format of the returned data. Only 'json' is supported at the moment.

#### Query Parameters
- **jsonp** (string) - Optional - JSONP callback function name.

### Response
#### Success Response (200)
- **decklists** (array) - An array of the top 10 decklist objects containing the specified card.

#### Response Example
```json
{
  "decklists": [
    {
      "id": 12345,
      "name": "Deck with Card X"
    }
  ]
}
```
```

--------------------------------

### PUT /api/oauth2/deck/publish/{id}

Source: https://ringsdb.com/api/doc/index

Publishes a specific deck belonging to the authenticated user, updating its version if successful.

```APIDOC
## PUT /api/oauth2/deck/publish/{id}

### Description
Try to publish one Deck of the authenticated user. If publication is successful, update the version of the deck and return the id of the decklist.

### Method
PUT

### Endpoint
/api/oauth2/deck/publish/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The numeric identifier of the Deck to publish

#### Query Parameters
- **description_md** (string) - Optional - Description of the Decklist in Markdown
- **precedent_id** (integer) - Optional - Identifier of the Predecessor of the Decklist

### Response
#### Success Response (200)
- **decklist_id** (integer) - The ID of the published decklist.

#### Response Example
```json
{
  "example": "{\"decklist_id\": 456}"
}
```
```
Tokens:
Raw