Gwent API

A consumption-only API of all Gwent data

Default request content-types: application/json, application/xml, application/gob, application/x-gob
Default response content-types: application/json
Schemes: https

Summary

Tag: index

Operation Description
GET /v0

show index

Tag: card

Operation Description
GET /v0/cards

list card

GET /v0/cards/{cardID}

show card

GET /v0/cards/{cardID}/variations/

cardVariations card

GET /v0/cards/{cardID}/variations/{variationID}

cardVariation card

GET /v0/cards/factions/{factionID}

cardFaction card

GET /v0/cards/leaders

cardLeader card

GET /v0/cards/rarities/{rarityID}

cardRarity card

Tag: category

Operation Description
GET /v0/categories

list category

GET /v0/categories/{categoryID}

show category

Tag: faction

Operation Description
GET /v0/factions

list faction

GET /v0/factions/{factionID}

show faction

Tag: group

Operation Description
GET /v0/groups

list group

GET /v0/groups/{groupID}

show group

Tag: rarity

Operation Description
GET /v0/rarities

list rarity

GET /v0/rarities/{rarityID}

show rarity

Paths

show index

GET /v0

Tags: index

Listing of all supported resources endpoint

application/vnd.gwentapi.resource+json

200 OK

OK

404 Not Found

Not Found

list card

GET /v0/cards

Tags: card

Return a page of cards.

lang

Localization of the returned resource

query string , x ∈ { en-US (default) , de-DE , es-ES , es-MX , fr-FR , it-IT , ja-JP , pl-PL , pt-BR , ru-RU }
limit

Number of cards to receive

query integer , { x ∈ ℤ | x ≥ 1 } 20
name

Query to search for cards with the name starting by the entered value

query string (3 to 100 chars)
offset

Offset of the starting count

query integer , { x ∈ ℤ | x ≥ 0 }
If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.pagecard+json

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

cardFaction card

GET /v0/cards/factions/{factionID}

Tags: card

Return all cards with given faction id.

factionID

Faction ID

path string
lang

Localization of the returned resource

query string , x ∈ { en-US (default) , de-DE , es-ES , es-MX , fr-FR , it-IT , ja-JP , pl-PL , pt-BR , ru-RU }
limit

Number of cards to receive

query integer , { x ∈ ℤ | x ≥ 1 } 20
offset

Offset of the starting count

query integer , { x ∈ ℤ | x ≥ 0 }
If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.pagecard+json

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

cardLeader card

GET /v0/cards/leaders

Tags: card

Return all leader cards.

lang

Localization of the returned resource

query string , x ∈ { en-US (default) , de-DE , es-ES , es-MX , fr-FR , it-IT , ja-JP , pl-PL , pt-BR , ru-RU }
limit

Number of cards to receive

query integer , { x ∈ ℤ | x ≥ 1 } 20
offset

Offset of the starting count

query integer , { x ∈ ℤ | x ≥ 0 }
If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.pagecard+json

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

cardRarity card

GET /v0/cards/rarities/{rarityID}

Tags: card

Return all cards with given rarity id.

lang

Localization of the returned resource

query string , x ∈ { en-US (default) , de-DE , es-ES , es-MX , fr-FR , it-IT , ja-JP , pl-PL , pt-BR , ru-RU }
limit

Number of cards to receive

query integer , { x ∈ ℤ | x ≥ 1 } 20
offset

Offset of the starting count

query integer , { x ∈ ℤ | x ≥ 0 }
rarityID

Rarity ID

path string
If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.pagecard+json

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

show card

GET /v0/cards/{cardID}

Tags: card

Return card with given id.

cardID

Card ID

path string
lang

Localization of the returned resource

query string , x ∈ { en-US (default) , de-DE , es-ES , es-MX , fr-FR , it-IT , ja-JP , pl-PL , pt-BR , ru-RU }
If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.card+json

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

cardVariations card

GET /v0/cards/{cardID}/variations/

Tags: card

Return the variations of a card with the given id.

cardID

Card ID

path string
lang

Localization of the returned resource

query string , x ∈ { en-US (default) , de-DE , es-ES , es-MX , fr-FR , it-IT , ja-JP , pl-PL , pt-BR , ru-RU }
If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.variation+json; type=collection

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

cardVariation card

GET /v0/cards/{cardID}/variations/{variationID}

Tags: card

Return the variation of a given id of a card with the given id.

cardID

Card ID

path string
lang

Localization of the returned resource

query string , x ∈ { en-US (default) , de-DE , es-ES , es-MX , fr-FR , it-IT , ja-JP , pl-PL , pt-BR , ru-RU }
variationID

Variation ID

path string
If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.variation+json

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

list category

GET /v0/categories

Tags: category

Return all card categories.

If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.category+json; type=collection

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

show category

GET /v0/categories/{categoryID}

Tags: category

Return card category with given id.

categoryID

Card category ID

path string
If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.category+json

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

list faction

GET /v0/factions

Tags: faction

Return all factions.

If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.faction+json; type=collection

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

show faction

GET /v0/factions/{factionID}

Tags: faction

Return faction with given id.

factionID

Faction ID

path string
If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.faction+json

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

list group

GET /v0/groups

Tags: group

Return all card groups.

If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.group+json; type=collection

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

show group

GET /v0/groups/{groupID}

Tags: group

Return card group with given id.

groupID

Card group ID

path string
If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.group+json

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

list rarity

GET /v0/rarities

Tags: rarity

Return all rarities.

If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.rarity+json; type=collection

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

show rarity

GET /v0/rarities/{rarityID}

Tags: rarity

Return rarity with given id.

rarityID

Rarity ID

path string
If-Modified-Since

DateTime in RFC1123 format.

header string

application/vnd.gwentapi.rarity+json

200 OK

OK

Last-Modified

DateTime in RFC1123 format.

string
304 Not Modified

Not Modified

404 Not Found

Not Found

500 Internal Server Error

Internal Server Error

Response definitions

NotFound

Not Found

OK

OK

Schema definitions

artType: object

Type of card art

{
"artist": "Marek Madej",
"fullsizeImage": "http://huel.net/rylan",
"mediumsizeImage": "http://jacobs.info/wyman",
"thumbnailImage": "http://legros.net/ally.simonis"
}
artist: string

Name of the artist

"Marek Madej"
                                                        
fullsizeImage: string (uri)

Href to full size artwork

"http://huel.net/rylan"
                                                        
mediumsizeImage: string (uri)

Href to medium size artwork

"http://jacobs.info/wyman"
                                                        
thumbnailImage: string (uri)

Href to thumbnail size artwork

"http://legros.net/ally.simonis"
                                                        

costType: object

Type used to define the associated crafting/milling cost cost

{
"normal": 30,
"premium": 200
}
normal: integer (int64)

Normal cost

30
                                                        
premium: integer (int64)

Premium cost

200
                                                        

GwentapiCard: object

A card (default view)

{
"categories": [
{
"href": "http://bodehickle.net/gardner",
"name": "Insectoid"
}
]
,
"faction": {
"href": "http://bogan.info/francesco.hegmann",
"name": "Monster"
}
,
"flavor": "Ugly – Nature's Way of saying stay away.",
"group": {
"href": "http://prohaskamarks.name/austyn.hartmann",
"name": "Bronze"
}
,
"href": "http://torpmarquardt.info/lauriane",
"info": "Deploy: Play all Arachasae from your Deck.",
"name": "Arachas",
"positions": [
"Ranged"
]
,
"strength": 3,
"uuid": "oe6UPiaDSNyI-630fYz4LA",
"variations": [
{
"availability": "BaseSet",
"href": "http://koepp.name/lucius_braun",
"rarity": {
"href": "http://mcclure.info/eddie",
"name": "Common"
}
},
{
"availability": "BaseSet",
"href": "http://koepp.name/lucius_braun",
"rarity": {
"href": "http://mcclure.info/eddie",
"name": "Common"
}
}
]
}
categories: GwentapiCategoryLinkCollection
faction: GwentapiFactionLink
flavor: string

Flavor text of the card

"Ugly – Nature's Way of saying stay away."
                                                        
group: GwentapiGroupLink
href: string (uri)

API href for making requests on the card

"http://torpmarquardt.info/lauriane"
                                                        
info: string

Text of the card detailing its abilities and how it plays

"Deploy: Play all Arachasae from your Deck."
                                                        
name: string

Name of the card

"Arachas"
                                                        
positions: string[]

Positions where the card can be played

[
"Ranged"
]
string
"Debitis debitis reprehenderit voluptas doloremque voluptatem et."
                                                                                
strength: integer (int64)

Strength of the card

3
                                                        
uuid: string

Unique card UUID

"oe6UPiaDSNyI-630fYz4LA"
                                                        
variations: GwentapiVariationLinkCollection

GwentapiCardLinkCollection: object[]

GwentapiCardLinkCollection is the media type for an array of GwentapiCardLink (default view)

[
{
"href": "http://torpmarquardt.info/lauriane",
"name": "Arachas"
}
]
GwentapiCardLink

GwentapiCategory: object

A card category (default view)

{
"href": "http://feeney.name/julian",
"name": "Insectoid",
"uuid": "0PcjdpZ6QR2NKutLFGx-oQ"
}
href: string (uri)

API href for making requests on the category

"http://feeney.name/julian"
                                                        
name: string

Name of the category

"Insectoid"
                                                        
uuid: string

Unique category UUID

"0PcjdpZ6QR2NKutLFGx-oQ"
                                                        

GwentapiCategoryCollection: object[]

GwentapiCategoryCollection is the media type for an array of GwentapiCategory (default view)

[
{
"href": "http://feeney.name/julian",
"name": "Insectoid",
"uuid": "0PcjdpZ6QR2NKutLFGx-oQ"
}
]
GwentapiCategory

GwentapiCategoryLinkCollection: object[]

GwentapiCategoryLinkCollection is the media type for an array of GwentapiCategoryLink (default view)

[
{
"href": "http://bodehickle.net/gardner",
"name": "Insectoid"
}
]
GwentapiCategoryLink

GwentapiFaction: object

A card faction (default view)

{
"href": "http://pfannerstillkuhic.name/mozelle.o'reilly",
"name": "Monster",
"uuid": "9wM9vGWiRzCvEwSLnLfY1w"
}
href: string (uri)

API href for making requests on the faction

"http://pfannerstillkuhic.name/mozelle.o'reilly"
                                                        
name: string

Name of the faction

"Monster"
                                                        
uuid: string

Unique faction UUID

"9wM9vGWiRzCvEwSLnLfY1w"
                                                        

GwentapiFactionCollection: object[]

GwentapiFactionCollection is the media type for an array of GwentapiFaction (default view)

[
{
"href": "http://pfannerstillkuhic.name/mozelle.o'reilly",
"name": "Monster",
"uuid": "9wM9vGWiRzCvEwSLnLfY1w"
}
]
GwentapiFaction

GwentapiGroup: object

A card group (default view)

{
"href": "http://bogan.name/abbey",
"name": "Bronze",
"uuid": "GbmwHbkcQniDKJq6rKz-bQ"
}
href: string (uri)

API href for making requests on the group

"http://bogan.name/abbey"
                                                        
name: string

Name of the group

"Bronze"
                                                        
uuid: string

Unique group UUID

"GbmwHbkcQniDKJq6rKz-bQ"
                                                        

GwentapiGroupCollection: object[]

GwentapiGroupCollection is the media type for an array of GwentapiGroup (default view)

[
{
"href": "http://bogan.name/abbey",
"name": "Bronze",
"uuid": "GbmwHbkcQniDKJq6rKz-bQ"
},
{
"href": "http://bogan.name/abbey",
"name": "Bronze",
"uuid": "GbmwHbkcQniDKJq6rKz-bQ"
},
{
"href": "http://bogan.name/abbey",
"name": "Bronze",
"uuid": "GbmwHbkcQniDKJq6rKz-bQ"
}
]
GwentapiGroup

GwentapiPagecard: object

Paginated card (default view)

{
"count": 280,
"next": "http://volkman.name/kenyatta",
"previous": "http://hacketttromp.net/sam",
"results": [
{
"href": "http://torpmarquardt.info/lauriane",
"name": "Arachas"
},
{
"href": "http://torpmarquardt.info/lauriane",
"name": "Arachas"
}
]
}
count: integer (int64)

Total number of cards stored in the database

280
                                                        
next: string (uri)

Href to the next page

"http://volkman.name/kenyatta"
                                                        
previous: string (uri)

Href to the previous page

"http://hacketttromp.net/sam"
                                                        
results: GwentapiCardLinkCollection

GwentapiRarity: object

A card rarity (default view)

{
"href": "http://schaden.info/lia",
"name": "Common",
"uuid": "TPCvIPOjRjO0s7Jfeo1NtA"
}
href: string (uri)

API href for making requests on the rarity

"http://schaden.info/lia"
                                                        
name: string

Name of the rarity

"Common"
                                                        
uuid: string

Unique rarity UUID

"TPCvIPOjRjO0s7Jfeo1NtA"
                                                        

GwentapiRarityCollection: object[]

GwentapiRarityCollection is the media type for an array of GwentapiRarity (default view)

[
{
"href": "http://schaden.info/lia",
"name": "Common",
"uuid": "TPCvIPOjRjO0s7Jfeo1NtA"
},
{
"href": "http://schaden.info/lia",
"name": "Common",
"uuid": "TPCvIPOjRjO0s7Jfeo1NtA"
}
]
GwentapiRarity

GwentapiResource: object

Listing of all available resource endpoint and a link to the api definition (default view)

{
"cards": "http://keeling.biz/stan_ebert",
"categories": "http://mckenzie.name/marlee_graham",
"factions": "http://johnson.info/kelli_kassulke",
"groups": "http://blick.biz/lia",
"rarities": "http://schroederharris.net/myron",
"swagger": "http://bahringer.org/rey.hackett",
"version": "v0.5.5-rc.2"
}
cards: string (uri)

API href for making requests on cards

"http://keeling.biz/stan_ebert"
                                                        
categories: string (uri)

API href for making requests on categories

"http://mckenzie.name/marlee_graham"
                                                        
factions: string (uri)

API href for making requests on factions

"http://johnson.info/kelli_kassulke"
                                                        
groups: string (uri)

API href for making requests on groups

"http://blick.biz/lia"
                                                        
rarities: string (uri)

API href for making requests on rarities

"http://schroederharris.net/myron"
                                                        
swagger: string (uri)

Href linking to the swagger definition

"http://bahringer.org/rey.hackett"
                                                        
version: string

Semver of the software that is currently running

"v0.5.5-rc.2"
                                                        

GwentapiVariation: object

Variation of a card containing artworks, crafting/milling cost, set availability, and rarity. (default view)

{
"art": {
"artist": "Marek Madej",
"fullsizeImage": "http://huel.net/rylan",
"mediumsizeImage": "http://jacobs.info/wyman",
"thumbnailImage": "http://legros.net/ally.simonis"
}
,
"availability": "BaseSet",
"craft": {
"normal": 30,
"premium": 200
}
,
"href": "http://bergstrom.biz/zachariah_jacobi",
"mill": {
"normal": 30,
"premium": 200
}
,
"rarity": {
"href": "http://mcclure.info/eddie",
"name": "Common"
}
,
"uuid": "pcN4QMTlTAaIOwicgNwtKA"
}
art: artType
availability: string

Describe from which set the variation comes from and its general availability

"BaseSet"
                                                        
craft: costType
href: string (uri)

API href for making requests on the artwork

"http://bergstrom.biz/zachariah_jacobi"
                                                        
mill: costType
rarity: GwentapiRarityLink
uuid: string

Unique artwork UUID

"pcN4QMTlTAaIOwicgNwtKA"
                                                        

GwentapiVariationCollection: object[]

GwentapiVariationCollection is the media type for an array of GwentapiVariation (default view)

[
{
"art": {
"artist": "Marek Madej",
"fullsizeImage": "http://huel.net/rylan",
"mediumsizeImage": "http://jacobs.info/wyman",
"thumbnailImage": "http://legros.net/ally.simonis"
}
,
"availability": "BaseSet",
"craft": {
"normal": 30,
"premium": 200
}
,
"href": "http://bergstrom.biz/zachariah_jacobi",
"mill": {
"normal": 30,
"premium": 200
}
,
"rarity": {
"href": "http://mcclure.info/eddie",
"name": "Common"
}
,
"uuid": "pcN4QMTlTAaIOwicgNwtKA"
}
]
GwentapiVariation

GwentapiVariationLinkCollection: object[]

GwentapiVariationLinkCollection is the media type for an array of GwentapiVariationLink (default view)

[
{
"availability": "BaseSet",
"href": "http://koepp.name/lucius_braun",
"rarity": {
"href": "http://mcclure.info/eddie",
"name": "Common"
}
},
{
"availability": "BaseSet",
"href": "http://koepp.name/lucius_braun",
"rarity": {
"href": "http://mcclure.info/eddie",
"name": "Common"
}
},
{
"availability": "BaseSet",
"href": "http://koepp.name/lucius_braun",
"rarity": {
"href": "http://mcclure.info/eddie",
"name": "Common"
}
}
]
GwentapiVariationLink