Skip to content

DominionCardAPI v2.0.0

Compare
Choose a tag to compare
@wesbuck wesbuck released this 07 Oct 01:04

A full-featured Dominion Kingdom Cards API.

This API is intended to power companion apps for the board game Dominion and allows you to quickly and easily obtain card sets and card details for the Kingdom Cards used to play the game.

Documentation

See https://documenter.getpostman.com/view/5603098/RWguxcDR for more information.

Params

The complete list of params returned in the results for all requests to this API:

Param Type Editable Description
id Integer No The primary key of the card.
uuid String No Each card has a unique 36 character UUID4 identifier.
card_name String Yes The unique name of the card.
set_name String Yes The name of the expansion set this card is a part of.
type String Yes The type of card.
cost String Yes The cost of this card.
card_text String Yes The full description of the card.
is_kingdom_card Boolean Yes Whether or not this is a kingdom card.
source String No The original source of this card.

Data Information

  • In the cost field, Þ represents "potion(s)".
  • In the description field, \\n denotes where a new line should be inserted.
  • In the description field, \\d denotes where a horizontal break should be inserted.

Changes for v2.0.0

API Function Changes

  • source field has been added
  • set_num field has been removed
  • Added DELETE, PUT, PATCH endpoints
  • All endpoints now properly return all 9 params for each card
  • The following fields are now required to POST a new card:
    • card_name, set_name, type, is_kingdom_card, cost, card_text

Package Changes

  • Removed set_num field from source csv file
  • Updated & added unit tests
  • Updated travis.yml