Documentation

GET Only

This is a consumption-only REST API. It only offers the GET method for resources.

Authentication Not Required

This API does not require authentication to connect to it. This was done so that you can easily use it for your projects. However, this could change in the future if there are too many requests to the API.


Deck of Playing Cards

Get All Playing Cards

Get all cards in the deck of playing cards.

GET

https://api.projectgamesapi.xyz/v1/cards

Copied!
{
  "statusCode": 200,
  "success": true,
  "messages": [],
  "data": {
    "rows_returned": 52,
      "cards": [
      {
      "id": 1,
      "name": "Ace",
      "suit": "Spades",
      "value": 1,
      "image": "https://api.projectgamesapi.xyz/v1/images/AS.png"
      },
      {
      "id": 2,
      "name": "Two",
      "suit": "Spades",
      "value": 2,
      "image": "https://api.projectgamesapi.xyz/v1/images/2S.png"
      },
      {
      "id": 3,
      "name": "Three",
      "suit": "Spades",
      "value": 3,
      "image": "https://api.projectgamesapi.xyz/v1/images/3S.png"
      },
      ...
    ]
  }
}

Note: The JSON output shown above is truncated. The full result includes all 52 cards.

Name Description Type
statusCode The HTTP status code of the GET request. integer
success Whether or not the request was successful. boolean
messages Error messages related to the request. array
data This is the main set of data that the GET request returns. object
rows_returned This number of rows returned with the request. integer
cards This is the resource that is being returned from the database. array of objects
id The ID of the card. integer
name The name of the card. string
suit The suit of the card. Will only contain "Spades", "Hearts", "Clubs", or "Diamonds". string
value The value of the card. integer
image The file path to the image for the card. string

Get Playing Card By ID

Get one card in the deck of playing cards by ID number.

GET

https://api.projectgamesapi.xyz/v1/cards/{id}

Copied!
{
  "statusCode": 200,
  "success": true,
  "messages": [],
  "data": {
    "rows_returned": 1,
    "cards": [
      {
      "id": 1,
      "name": "Ace",
      "suit": "Spades",
      "value": 1,
      "image": "https://api.projectgamesapi.xyz/v1/images/AS.png"
      }
    ]
  }
}

Note: Replace {id} with the ID of the card you want to retrieve.

Name Description Type
statusCode The HTTP status code of the GET request. integer
success Whether or not the request was successful. boolean
messages Error messages related to the request. array
data This is the main set of data that the GET request returns. object
rows_returned This number of rows returned with the request. integer
cards This is the resource that is being returned from the database. array of objects
id The ID of the card. integer
name The name of the card. string
suit The suit of the card. Will only contain "Spades", "Hearts", "Clubs", or "Diamonds". string
value The value of the card. integer
image The file path to the image for the card. string

Deck of Tarot Cards

Get All Tarot Cards

Get all cards in the deck of tarot cards.

GET

https://api.projectgamesapi.xyz/v1/tarot

Copied!
{
"statusCode": 200,
"success": true,
"messages": [],
"data": {
  "rows_returned": 78,
  "tarot": [
      {
        "id": 1,
        "name": "The Fool",
        "suit": "Major",
        "description": "Folly, mania, extravagance, intoxication, delirium, frenzy, bewrayment.",
        "image": "https://api.projectgamesapi.xyz/v1/images/Tarot_00_Fool.jpg"
      },
      {
        "id": 2,
        "name": "The Magician",
        "suit": "Major",
        "description": "Skill, diplomacy, address, subtlety; sickness, pain, loss, disaster, snares of enemies; self-confidence, will; the Querent himself, if male.",
        "image": "https://api.projectgamesapi.xyz/v1/images/Tarot_01_Magician.jpg"
      },
      {
        "id": 3,
        "name": "High Priestess",
        "suit": "Major",
        "description": "Secrets, mystery, the future as yet unrevealed; the woman who interests the Querent, if male; the Querent herself, if female; silence, tenacity; mystery, wisdom, science.",
        "image": "https://api.projectgamesapi.xyz/v1/images/Tarot_02_High_Priestess.jpg"
      },
    ...
    ]
  }
}

Note: The JSON output shown above is truncated. The full result includes all 78 cards.

Name Description Type
statusCode The HTTP status code of the GET request. integer
success Whether or not the request was successful. boolean
messages Error messages related to the request. array
data This is the main set of data that the GET request returns. object
rows_returned This number of rows returned with the request. integer
tarot This is the resource that is being returned from the database. array of objects
id The ID of the card. integer
name The name of the card. string
suit The suit of the card. Will only contain "Major", "Cups", "Wands", "Swords", or "Pentacles". string
description The description for the card. string
image The file path to the image for the card. string

Get Tarot Card By ID

Get one card in the deck of tarot cards by ID number.

GET

https://api.projectgamesapi.xyz/v1/tarot/{id}

Copied!
{
  "statusCode": 200,
  "success": true,
  "messages": [],
  "data": {
    "rows_returned": 1,
    "cards": [
      {
      "id": 1,
      "name": "The Fool",
      "suit": "Major",
      "description": "Folly, mania, extravagance, intoxication, delirium, frenzy, bewrayment.",
      "image": "https://api.projectgamesapi.xyz/v1/images/Tarot_00_Fool.jpg"
      }
    ]
  }
}

Note: Replace {id} with the ID of the card you want to retrieve.

Name Description Type
statusCode The HTTP status code of the GET request. integer
success Whether or not the request was successful. boolean
messages Error messages related to the request. array
data This is the main set of data that the GET request returns. object
rows_returned This number of rows returned with the request. integer
tarot This is the resource that is being returned from the database. array of objects
id The ID of the card. integer
name The name of the card. string
suit The suit of the card. Will only contain "Major, "Cups", "Wands", "Swords", or "Pentacles". string
description The description for the card. string
image The file path to the image for the card. string

Coins

Get All Coins

Get all available coin faces.

GET

https://api.projectgamesapi.xyz/v1/coins

Copied!
{
  "statusCode": 200,
  "success": true,
  "messages": [],
  "data": {
    "rows_returned": 10,
    "coins": [
      {
        "id": 1,
        "name": "Penny",
        "side": "Heads",
        "value": 1,
        "image": "https://api.projectgamesapi.xyz/v1/images/penny-heads.png"
      },
      {
        "id": 2,
        "name": "Penny",
        "side": "Tails",
        "value": 1,
        "image": "https://api.projectgamesapi.xyz/v1/images/penny-tails.png"
      },
      {
        "id": 3,
        "name": "Nickel",
        "side": "Heads",
        "value": 5,
        "image": "https://api.projectgamesapi.xyz/v1/images/nickel-heads.png"
      },
      ...
    ]
  }
}

Note: The JSON output shown above is truncated. The full result includes all 10 coins.

Name Description Type
statusCode The HTTP status code of the GET request. integer
success Whether or not the request was successful. boolean
messages Error messages related to the request. array
data This is the main set of data that the GET request returns. object
rows_returned This number of rows returned with the request. integer
coins This is the resource that is being returned from the database. array of objects
id The ID of the coin. integer
name The name of the coin. string
side The side of the coin. Will only contain "Heads" or "Tails". string
value The value of the coin. integer
image The file path to the image for the coin. string

Get Coin By ID

Get one coin face by ID number.

GET

https://api.projectgamesapi.xyz/v1/coins/{id}

Copied!
{
  "statusCode": 200,
  "success": true,
  "messages": [],
  "data": {
    "rows_returned": 1,
    "coins": [
      {
        "id": 1,
        "name": "Penny",
        "side": "Heads",
        "value": 1,
        "image": "https://api.projectgamesapi.xyz/v1/images/penny-heads.png"
      }
    ]
  }
}

Note: Replace {id} with the ID of the coin you want to retrieve.

Name Description Type
statusCode The HTTP status code of the GET request. integer
success Whether or not the request was successful. boolean
messages Error messages related to the request. array
data This is the main set of data that the GET request returns. object
rows_returned This number of rows returned with the request. integer
coins This is the resource that is being returned from the database. array of objects
id The ID of the coin. integer
name The name of the coin. string
side The side of the coin. Will only contain "Heads" or "Tails". string
value The value of the coin. integer
image The file path to the image for the coin. string

Dice

Get All Dice

Get all available die faces.

GET

https://api.projectgamesapi.xyz/v1/dice

Copied!
{
"statusCode": 200,
"success": true,
"messages": [],
"data": {
  "rows_returned": 18,
  "dice": [
      {
        "id": 1,
        "name": "One",
        "color": "White",
        "value": 1,
        "image": "https://api.projectgamesapi.xyz/v1/images/dice-white-1.png"
      },
      {
        "id": 2,
        "name": "Two",
        "color": "White",
        "value": 2,
        "image": "https://api.projectgamesapi.xyz/v1/images/dice-white-2.png"
      },
      {
        "id": 3,
        "name": "Three",
        "color": "White",
        "value": 3,
        "image": "https://api.projectgamesapi.xyz/v1/images/dice-white-3.png"
      },
      ...
    ]
  }
}

Note: The JSON output shown above is truncated. The full result includes all 18 die faces.

Name Description Type
statusCode The HTTP status code of the GET request. integer
success Whether or not the request was successful. boolean
messages Error messages related to the request. array
data This is the main set of data that the GET request returns. object
rows_returned This number of rows returned with the request. integer
dice This is the resource that is being returned from the database. array of objects
id The ID of the die. integer
name The name of the die. string
color The face of the die. Will only contain "Red", "Black", or "White". string
value The number of pips on the die face. integer
image The file path to the image for the die face. string

Get Die By ID

Get one die face by ID number.

GET

https://api.projectgamesapi.xyz/v1/dice/{id}

Copied!
{
"statusCode": 200,
"success": true,
"messages": [],
"data": {
  "rows_returned": 1,
  "dice": [
      {
        "id": 1,
        "name": "One",
        "color": "White",
        "value": 1,
        "image": "https://api.projectgamesapi.xyz/v1/images/dice-white-1.png"
      }
    ]
  }
}

Note: Replace {id} with the ID of the die face you want to retrieve.

Name Description Type
statusCode The HTTP status code of the GET request. integer
success Whether or not the request was successful. boolean
messages Error messages related to the request. array
data This is the main set of data that the GET request returns. object
rows_returned This number of rows returned with the request. integer
dice This is the resource that is being returned from the database. array of objects
id The ID of the die. integer
name The name of the die. string
color The face of the die. Will only contain "Red", "Black", or "White". string
value The number of pips on the die face. integer
image The file path to the image for the die face. string

Get Dice by Color

Get a set of dice by color.

GET

https://api.projectgamesapi.xyz/v1/dice/{color}

Copied!
{
"statusCode": 200,
"success": true,
"messages": [],
"data": {
  "rows_returned": 6,
  "dice": [
      {
        "id": 13,
        "name": "One",
        "color": "Red",
        "value": 1,
        "image": "https://api.projectgamesapi.xyz/v1/images/dice-red-1.png"
      },
      {
        "id": 14,
        "name": "Two",
        "color": "Red",
        "value": 2,
        "image": "https://api.projectgamesapi.xyz/v1/images/dice-red-2.png"
      },
      {
        "id": 15,
        "name": "Three",
        "color": "Red",
        "value": 3,
        "image": "https://api.projectgamesapi.xyz/v1/images/dice-red-3.png"
      },
      {
        "id": 16,
        "name": "Four",
        "color": "Red",
        "value": 4,
        "image": "https://api.projectgamesapi.xyz/v1/images/dice-red-4.png"
      },
      {
        "id": 17,
        "name": "Five",
        "color": "Red",
        "value": 5,
        "image": "https://api.projectgamesapi.xyz/v1/images/dice-red-5.png"
      },
      {
        "id": 18,
        "name": "Six",
        "color": "Red",
        "value": 6,
        "image": "https://api.projectgamesapi.xyz/v1/images/dice-red-6.png"
      }
    ]
  }
}

Note: Replace {color} with the color of dice you want to retrieve (red, black, or white.)

Name Description Type
statusCode The HTTP status code of the GET request. integer
success Whether or not the request was successful. boolean
messages Error messages related to the request. array
data This is the main set of data that the GET request returns. object
rows_returned This number of rows returned with the request. integer
dice This is the resource that is being returned from the database. array of objects
id The ID of the die. integer
name The name of the die. string
color The face of the die. Will only contain "Red", "Black", or "White". string
value The number of pips on the die face. integer
image The file path to the image for the die face. string

Words

Get All Words

Get all words across all available topics.

GET

https://api.projectgamesapi.xyz/v1/words

Copied!
{
"statusCode": 200,
"success": true,
"messages": [],
"data": {
  "rows_returned": 74,
  "words": [
      {
        "id": 1,
        "word": "January",
        "num_chars": 7,
        "topic": "Months"
      },
      {
        "id": 2,
        "word": "February",
        "num_chars": 8,
        "topic": "Months"
      },
      {
        "id": 3,
        "word": "March",
        "num_chars": 5,
        "topic": "Months"
      },
      ...
    ]
  }
}

Note: The JSON output shown above is truncated. The full result includes all 74 words.

Name Description Type
statusCode The HTTP status code of the GET request. integer
success Whether or not the request was successful. boolean
messages Error messages related to the request. array
data This is the main set of data that the GET request returns. object
rows_returned This number of rows returned with the request. integer
words This is the resource that is being returned from the database. array of objects
id The ID of the word. integer
word The word. string
num_chars The number characters in the word. integer
topic The topic or group that the word belongs to. Will only contain "Months", "States", or "Games". string

Get Word By ID

Get one word by ID number.

GET

https://api.projectgamesapi.xyz/v1/words/{id}

Copied!
{
"statusCode": 200,
"success": true,
"messages": [],
"data": {
  "rows_returned": 1,
  "words": [
      {
        "id": 1,
        "word": "January",
        "num_chars": 7,
        "topic": "Months"
      }
    ]
  }
}

Note: Replace {id} with the ID of the word you want to retrieve.

Name Description Type
statusCode The HTTP status code of the GET request. integer
success Whether or not the request was successful. boolean
messages Error messages related to the request. array
data This is the main set of data that the GET request returns. object
rows_returned This number of rows returned with the request. integer
words This is the resource that is being returned from the database. array of objects
id The ID of the word. integer
word The word. string
num_chars The number characters in the word. integer
topic The topic or group that the word belongs to. Will only contain "Months", "States", or "Games". string

Get Word by Topic

Get a group of words by topic.

GET

https://api.projectgamesapi.xyz/v1/words/{topic}

Copied!
{
"statusCode": 200,
"success": true,
"messages": [],
"data": {
  "rows_returned": 12,
  "words": [
      {
        "id": 1,
        "word": "January",
        "num_chars": 7,
        "topic": "Months"
      },
      {
        "id": 2,
        "word": "February",
        "num_chars": 8,
        "topic": "Months"
      },
      {
        "id": 3,
        "word": "March",
        "num_chars": 5,
        "topic": "Months"
      },
      {
        "id": 4,
        "word": "April",
        "num_chars": 5,
        "topic": "Months"
      },
      {
        "id": 5,
        "word": "May",
        "num_chars": 3,
        "topic": "Months"
      },
      {
        "id": 6,
        "word": "June",
        "num_chars": 4,
        "topic": "Months"
      },
      {
        "id": 7,
        "word": "July",
        "num_chars": 4,
        "topic": "Months"
      },
      {
        "id": 8,
        "word": "August",
        "num_chars": 6,
        "topic": "Months"
      },
      {
        "id": 9,
        "word": "September",
        "num_chars": 9,
        "topic": "Months"
      },
      {
        "id": 10,
        "word": "October",
        "num_chars": 7,
        "topic": "Months"
      },
      {
        "id": 11,
        "word": "November",
        "num_chars": 8,
        "topic": "Months"
      },
      {
        "id": 12,
        "word": "December",
        "num_chars": 8,
        "topic": "Months"
      }
    ]
  }
}

Note: Replace {topic} with the types of words you want to retrieve (months, states, or games.)

Name Description Type
statusCode The HTTP status code of the GET request. integer
success Whether or not the request was successful. boolean
messages Error messages related to the request. array
data This is the main set of data that the GET request returns. object
rows_returned This number of rows returned with the request. integer
words This is the resource that is being returned from the database. array of objects
id The ID of the word. integer
word The word. string
num_chars The number characters in the word. integer
topic The topic or group that the word belongs to. Will only contain "Months", "States", or "Games". string