Chaotic TCG API

Chaotic TCG API

  • Documentation
Edit

Documentation

Documentation for the Chaotic Trading Card Game API.

Getting Started

To begin with this API, let's start by making our first API call to the server.

Making an API Call

You can try this from your terminal.

$ curl http://www.chaoticga.me/creatures/DOP/15

This is the response that you should get.

{
    "_id":"5c3be280775bf784097efcbf",
    "name":"Maxxor",
    "set":"DOP",
    "rarity":"Ultra Rare",
    "id":15,
    "tribe":"OverWorld",
    "courage":100,
    "power":65,
    "wisdom":80,
    "speed":50,
    "energy":60,
    "mugic":2,
    "elements":"Fire, Earth",
    "types":"Hero",
    "ability":"{{MC}}: Heal 10 damage to target Creature.",
    "flavor":"No OverWorlder has ever seen Maxxor’s face in battle because he is always in the frontline, leading the charge!","brainwashed":"",
    "unique":"1",
    "loyal":"1",
    "legendary":"",
    "artist":"",
    "gender":"Male"
}

Getting card images

To get card images, use endpoints that have the set and id of the card.

http://www.chaoticga.me/DOP/15

If you do this that URL, this is what you should get.

Chaotic Card

Chaotic Cards

The following is how to make requests for many, or certain, cards in the database.

Requesting all cards

To get all cards in the Chaotic Trading Card Game, make a request to this endpoint

http://www.chaoticga.me/cards

This will return you an array with all cards in the game.

Requesting all cards by a type

You can even get all cards by their respective type classifications.

http://www.chaoticga.me/creatures

This will return you an array with all cards in that class.

Filtering cards by set

To filter all cards by their respective sets, just ad the set id to the end of the route.

http://www.chaoticga.me/cards/DOP

This will return you an array with all cards in a particular set.

Getting Specific Card Data

To get the data of a certain card, you must specify the cards type, set, and id.

http:www.chaoticga.me/creatures/DOP/15

This will return you the specific card's data.

Valid Parameters

These are all valid route parameters that are accepted by the API.

Card Types

Card Type
/creatures
/battlegear
/locations
/mugic
/attacks

Card Sets

Set NameSet
Alliances Unraveled/AU
Dawn of Perim/DOP
Forged Unity/FUN
Marillian Invasion/MI
Organized Play/OP1
Rise of the Oligarch/ROTO
Silent Sands/SS
Turn of the Tide/TOTT
Zenith of the Hive/ZOTH

Models

These are valid schemas for what you can expect to be returned for a given card's data.

Creature

PropertyTypeDetails
_idStringUnique database id
NameStringName of the card
SetStringThe set id of the card
RarityStringThe cards rarity in the game
IdNumberThe card's id number in its respective set
TribeStringThe card's tribe in the game
CourageNumberAverage stat among the cards minimum and maximum potential value.
PowerNumberAverage stat among the cards minimum and maximum potential value.
WisdomNumberAverage stat among the cards minimum and maximum potential value.
SpeedNumberAverage stat among the cards minimum and maximum potential value.
EnergyNumberAverage stat among the cards minimum and maximum potential value.
ElementsStringElements of the card that are comma seperated
"Earth, Fire"
TypeStringThe card's type
AbilityStringCard's printed mechanical game text
FlavorStringCard's flavor text printed
UniqueStringString with either "0" or "1"
"1" represents true
LoyalStringString with either "0" or "1"
"1" represents true
LegendaryString
ArtistStringThe card art illustrator
GenderStringThe creature's gender

Location

PropertyTypeDetails
_idStringUnique database id
NameStringName of the card
SetStringThe set id of the card
RarityStringThe cards rarity in the game
IdNumberThe card's id number in its respective set
InitiativeStringThe card's printed initiative stat
AbilityStringCard's printed mechanical game text
FlavorStringThe card's printed flavor text
UniqueString
MirageString
PastString
ArtistStringThe card art illustrator

Attack

PropertyTypeDetails
_idStringUnique database id
NameStringName of the card
SetStringThe set id of the card
RarityStringThe cards rarity in the game
IdNumberThe card's id number in its respective set
BpNumberThe card's build point value
BaseNumberThe attack card's base damage
FireNumberThe attack card's fire damage
AirNumberThe attack card's air damage
EarthNumberThe attack card's earth damage
WaterNumberThe attack card's water damage
AbilityStringCard's printed mechanical game text
Flavor TextStringThe card's printed flavor text
UniqueString
ArtistStringThe card art illustrator

Mugic

PropertyTypeDetails
_idStringUnique database id
NameStringName of the card
SetStringThe set id of the card
RarityStringThe cards rarity in the game
IdNumberThe card's id number in its respective set
TribeStringThe card's tribe in the game
CostNumberThe cards mugic cost
AbilityStringCard's printed mechanical game text
FlavorStringThe card's printed flavor text
UniqueString
PastString
ArtistStringThe card art illustrator

Battlegear

PropertyTypeDetails
_idStringUnique database id
NameStringName of the card
SetStringThe set id of the card
RarityStringThe cards rarity in the game
IdNumberThe card's id number in its respective set
AbilityStringCard's printed mechanical game text
Flavor TextStringThe card's printed flavor text
UniqueString
LoyalString
LegendaryString
PastString
ShardString
ArtistStringThe card art illustrator

API Limits

The API limits all calls from original source to 100 calls every 15 minutes

  • Getting Started
    • Making an API Call
    • Getting card images
  • Chaotic Cards
    • Requesting all cards
    • Requesting all cards by a type
    • Filtering cards by set
    • Getting Specific Card Data
  • Valid Parameters
    • Card Types
    • Card Sets
  • Models
    • Creature
    • Location
    • Attack
    • Mugic
    • Battlegear
  • API Limits
Chaotic TCG API
Docs
Getting Started (or other categories)Guides (or other categories)API Reference (or other categories)
Community
User ShowcaseStack OverflowProject ChatTwitter
More
BlogGitHubStar
Facebook Open Source
Copyright © 2019 Henry Unite