Scrydex

The card object

Here is the documentation of the Gundam card object. Each field is described below with its field name and corresponding data type.

id <string>

The unique identifier for the card.

name <string>

The name of the Gundam card.

type <string>

The type of the card, such as UNIT.

number <string>

The number of the card, such as 2 in ST02-002.

printed_number <string>

The printed number of the card, such as ST02-002.

rarity <string>

The rarity of the card (e.g., "Common").

rarity_code <string>

The rarity code of the card (e.g., "C")

level <string>

The level of the card.

cost <string>

How much it costs to play the card.

converted_cost <number>

The number representation of how much it costs to play the card.

colors <array of strings>

The colors of the card (e.g., ["Green"]).

effects <array of maps>

Effects found on the card

timings <array of strings>: The timings found on the effect. (e.g., ["Deploy"])
text <string>: The full text of the effect.

zones <array of strings>

The zones of the card (e.g., ["Space"]).

traits <array of strings>

The traits of the card (e.g., ["Operation Meteor"]).

link <string>

The card link

attack_points <string>

The attack power of the card.

hit_points <string>

How many hit points the card has.

images <array of maps>

Contains URLs for the card's images in various sizes.

type <string>: The type of image (e.g., "front").
small <string>: The URL of the small image.
medium <string>: The URL of the medium image.
large <string>: The URL of the large image.

expansion <object>

Details about the card's expansion or set.

id <string>: The ID of the expansion.
name <string>: The name of the expansion.
code <string>: The code of the expansion.
type <string>: The type of the expansion.
total <integer>: Total cards in the set (not counting variants).
language <string>: The language of the expansion.
language_code <string>: The language code of the expansion.
release_date <string>: The release date of the expansion.
logo <string>: The logo url of the expansion.
symbol <string>: The symbol url of the expansion.

language <string>

The language of the card.

language_code <string>

The language code of the card.

expansion_sort_order <integer>

The position of the card in the expansion, used for sorting.

variants <array of maps>

A list of collectible variants of the card.

name <string>: The name of the variant.
images <array of maps>: Any images available for the specific variant.
prices <array>: The price data for the variant.

Here is an example JSON representation of the Lorcana card object.

Remember that you can use the casing parameter to change the casing of the field names. Default is snake case.

{
  "data": {
    "id": "ST02-002",
    "name": "Wing Gundam (Bird Mode)",
    "type": "UNIT",
    "number": "2",
    "printed_number": "ST02-002",
    "rarity_code": "C",
    "rarity": "Common",
    "block": "1",
    "level": "3",
    "cost": "3",
    "converted_cost": 3,
    "colors": [
      "Green"
    ],
    "effects": [
      {
        "timings": [
          "Deploy"
        ],
        "text": "[Deploy] Place 1 EX Resource."
      }
    ],
    "zones": [
      "Space",
      "Earth"
    ],
    "traits": [
      "Operation Meteor"
    ],
    "link": "Heero Yuy",
    "attack_points": "2",
    "hit_points": "2",
    "release_date": "2025/07/11",
    "source_title": "Mobile Suit Gundam Wing",
    "images": [
      {
        "type": "front",
        "small": "https://images.scrydex.com/gundam/ST02-002/small",
        "medium": "https://images.scrydex.com/gundam/ST02-002/medium",
        "large": "https://images.scrydex.com/gundam/ST02-002/large"
      }
    ],
    "expansion": {
      "id": "ST02",
      "name": "Wings of Advance",
      "code": "ST02",
      "type": "Starter Deck",
      "total": 16,
      "release_date": "2025/07/11",
      "logo": "https://images.scrydex.com/gundam/ST02-logo/logo",
      "symbol": "https://images.scrydex.com/gundam/ST02-symbol/symbol",
      "language": "English",
      "language_code": "EN"
    },
    "language": "English",
    "language_code": "EN",
    "expansion_sort_order": 2,
    "variants": [
      {
        "name": "normal",
        "images": [
          {
            "type": "front",
            "small": "https://images.scrydex.com/gundam/ST02-002/small",
            "medium": "https://images.scrydex.com/gundam/ST02-002/medium",
            "large": "https://images.scrydex.com/gundam/ST02-002/large"
          }
        ],
        "prices": []
      },
      {
        "name": "altArt",
        "images": [
          {
            "type": "front",
            "small": "https://images.scrydex.com/gundam/ST02-002A/small",
            "medium": "https://images.scrydex.com/gundam/ST02-002A/medium",
            "large": "https://images.scrydex.com/gundam/ST02-002A/large"
          }
        ],
        "prices": []
      },
      {
        "name": "beta",
        "images": [
          {
            "type": "front",
            "small": "https://images.scrydex.com/gundam/BETA-ST02-002/small",
            "medium": "https://images.scrydex.com/gundam/BETA-ST02-002/medium",
            "large": "https://images.scrydex.com/gundam/BETA-ST02-002/large"
          }
        ],
        "prices": []
      }
    ]
  }
}

Language:

Get a card

This endpoint retrieves a specific Gundam card by its unique identifier.

URL

GET https://api.scrydex.com/gundam/v1/cards/<id>

URL Parameters

id <string>
The unique identifier of the card to retrieve. This is a required parameter.

Query Parameters

select <comma-separated string>

Specifies which fields to return in the response (e.g., "name,colors").
casing <string>

Allows changing the output format of the response. Supported values are:
- camel
- snake
include <comma-separated string>

Fetch additional resources alongside the card. Supported values include:
- prices (Fetches price details for the card. It is recommended to not include prices if you don't need that data for a given request.)

Here is how you can retrieve a card using various programming languages (SDKs coming soon):

Language:

Search cards

Fetching and searching for multiple cards in the Scrydex API is simple yet powerful. Use the various query parameters to customize your requests and retrieve the specific cards or data you need.

Query Parameters

All query parameters are optional, but combining them allows for advanced and targeted searches.

Parameter	Description	Default Value
q	A search query for advanced filtering. Examples can be found below.	-
page	The page of data to access.	`1`
pageSize	The maximum number of cards to return per page. The highest allowable value is `100`.	`100` (max: `100`)
orderBy	Field(s) to order the results by. Use a comma-separated list. Examples below.	-
select	A comma-delimited list of fields to return in the response (e.g., `?select=id,name`). If omitted, all fields are returned.	-

Key Features of `q` (Search Queries)

Search queries use a Lucene-like syntax for filtering, making it easy to build powerful card searches. Below are examples of supported query operations:

Keyword Matching

Find cards that contain "freedom" in the name field: plaintext name:freedom
Search for the phrase "freedom gundam" in the name field: plaintext name:"freedom gundam"
Combine multiple conditions:
- Cards with "gundam" in the name AND "green" in the colors field: plaintext name:gundam colors:green
- Cards with "gundam" in the name AND either "green" or "blue" in colors: plaintext name:gundam (colors:green OR colors:blue)

Exclude Results

Retrieve only cards with name:gundam while excluding blue ones: plaintext name:gundam -colors:blue

Wildcard Matching

Cards where the name starts with "sky": plaintext name:sky*
Cards where the name starts with "sky" and ends with "easy": plaintext name:sky*easy

Exact Matching

Match cards where the name is exactly "skygrasper" (no other characters appear in the name field): plaintext !name:skygrasper

Range Searches

Fields containing numerical data (e.g., level, cost) support range searches:

Cards featuring the original 151 Pokémon: plaintext level:[1 TO 3]
Cards with level values up to 3: plaintext level:[* TO 3]
Cards with level values greater than or equal to 5: plaintext level:[5 TO *]

Pro Tip: Use square brackets [ ] for inclusive ranges, and curly braces { } for exclusive ranges.

Searching Nested Fields

Leverage the . separator to search nested fields:

Filter by set ID: plaintext expansion.id:ST02
Find cards with an effect timing named "Deploy": plaintext effects.timings:deploy

Example: Fetch & Search Cards

Use the query parameters to retrieve and search cards. Below are examples using Scrydex API:

Ordering Data

The orderBy parameter allows for flexible sorting of results:

Order cards by number within their set: plaintext ?orderBy=number
Combine ascending (ASC) and descending (DESC) order: plaintext ?orderBy=name,-number

Field Selection

Optimize and reduce response payload sizes using the select parameter to return only the fields you care about:

Example: Request only id and name fields for all cards: plaintext ?select=id,name

Response Example

Here’s a sample response for a search query:

{
  "data": [
    {
      "id": "ST01-001",
      "name": "Gundam",
      ...
    },
    {
      "id": "ST01-002",
      "name": "Wing Gundam",
      ...
    }
  ],
  "page": 1,
  "pageSize": 2,
  "count": 2,
  "totalCount": 500
}

Best Practices for Fetching & Searching

Paginate Results: Use the page and pageSize parameters to prevent overloading responses.
Limit Fields Returned: Use the select parameter to only get the data you need.
Avoid Overhead: Minimize wildcard or range queries for better performance.

Gundam

Cards

The card object

Get a card

URL

URL Parameters

Query Parameters

Search cards

Query Parameters

Key Features of q (Search Queries)

Keyword Matching

Exclude Results

Wildcard Matching

Exact Matching

Range Searches

Searching Nested Fields

Example: Fetch & Search Cards

Ordering Data

Field Selection

Response Example

Best Practices for Fetching & Searching

Key Features of `q` (Search Queries)