API Documentation

Currently, the database contains Weiß Schwarz, Force of Will, Magic the Gathering card games. Adding Pokemon in the coming weeks.

This documentation will detail the API endpoints for searching and retrieving card details.

Retrieving card information by Card ID.

Returns a card object.

Options (URL Query)

id

string

Card Identifier normally found at the bottom of the card.

id=AO1-004

include

string ( ',' deliminator )

Include only fields defined from the card information.

include=title,textObj.text

exclude

string ( ',' deliminator )

Exclude fields from the card information

exclude=flavor,defense,attack,image

Retrieving Image by Card ID.

Returns an image.

Search cards by fields using Lucene Query.

Returns an array of card objects.

Options (URL Query)

offset

integer
used for pagination

offset=25

size

integer ( valid range 1-100 )

How many results to return per API request.

size=25

search

string (Lucene query)

Lucene Query string for searching through cards, returns a list of all cards, pagination is required for large results.

search=set:AO1 AND (number:002 OR number:001)
search=set:AO1 AND type:"Resonator"

include

string ( ',' deliminator )

Include only fields defined from the search results.

include=title,textObj.text

exclude

string ( ',' deliminator )

Exclude fields from the search results

exclude=flavor,defense,attack,image