Collectibles Text Search

Quickstart Taxonomy Blog

In order to get access to the Collectibles Text Search service, please register at https://app.ximilar.com. In the app pick "Ready-To-Use Image Recognition" on the main dashboard and then Collectibles Recognition. This service is available only in Business and Professional pricing plans.

This page describes API of Collectibles Text Search service. With this service you can search through our extensive database of collectible items and their pricing information using text queries. The API provides two main endpoints: one for searching the collectibles catalog and another for searching pricing data.

Currently these endpoints are supported:

https://api.ximilar.com/collectibles/text/v2/tcg/list        (for searching TCG catalog data)
https://api.ximilar.com/collectibles/text/v2/tcg/pricing     (for searching TCG pricing data)

If you are looking for image-based identification of collector items, please check our Collectibles Recognition documentation. For custom search solutions or additional features, please contact us at care@ximilar.com.

POST/text/v2/tcg/list

TCG Catalog Search

This endpoint allows you to search through our comprehensive catalog of collectible items using text queries. You can search by card names, set names, series, or any other textual information related to collectibles.

The service covers various collectible categories including Pokemon, Yu-Gi-Oh!, Magic The Gathering, One Piece, Lorcana, and many other trading card games (see our Taxonomy).

Required attributes

Name
query_record
Type
dict
Description
A record containing the search query with _text_data field specifying the text to search for.

Optional attributes

Name
page
Type
integer
Default
Default:1
Description
Page number for pagination (starts from 1).
Name
size
Type
integer
Default
Default:10
Max
Maximum:20
Description
Number of results per page.
Name
k
Type
integer
Description
Number of top results to consider for relevance ranking.
Name
filter
Type
str
Description
String filter. Supported operators include: =, !=, >, >=, <, <=, EXISTS.

Returns

HTTP error code 2XX, if the method was OK and other HTTP error code, if the method failed. Body of the response is a JSON object with the following fields:

Name
answer_records
Type
array
Description
Array of collectible items matching the search query, each containing detailed information about the item including name, set, series, rarity, and other attributes.
Name
answer_count
Type
integer
Description
Total number of items matching the search query across all pages.
Name
page
Type
integer
Description
Current page number.
Name
totalPages
Type
integer
Description
Number of total pages.

Request

POST

/text/v2/tcg/list

curl --location 'https://api.ximilar.com/collectibles/text/v2/tcg/list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token __API_TOKEN__' \
--data '{
  "query_record": {
    "_text_data": "Pikachu ex 247 Surging Sparks"
  },
  "page": 1,
  "size": 10,
  "filter": "lang = 'en'"
}'

Response

{
  "answer_count": 571,
  "answer_records": [
    {
      "Subcategory": "Pokemon",
      "_id": "eb863290-c435-4b48-9ea5-ae3dc73fec4e",
      "card_number": "247",
      "lang": "en",
      "name": "Pikachu ex",
      "rarity": "Hyper Rare",
      "series": "Scarlet & Violet",
      "set": "Surging Sparks",
      "set_code": "SSP",
      "year": 2024
    },
    {
      "Subcategory": "Pokemon",
      "_id": "bc8f12eb-894e-46bc-ae81-48f2aff424fa",
      "card_number": "057",
      "lang": "en",
      "name": "Pikachu ex",
      "rarity": "Double Rare",
      "series": "Scarlet & Violet",
      "set": "Surging Sparks",
      "set_code": "SSP",
      "year": 2024
    },
    {
      "Subcategory": "Pokemon",
      "_id": "2bc0df4a-3d2c-47fa-a3d7-688add47a4fa",
      "card_number": "179",
      "lang": "en",
      "name": "Pikachu ex",
      "rarity": "Hyper Rare",
      "series": "Scarlet & Violet Series",
      "set": "Prismatic Evolutions",
      "set_code": "PRE",
      "year": 2025
    },
    {
      "Subcategory": "Pokemon",
      "_id": "358b4d8c-4f7f-471a-b2b9-5ef2c942e5bb",
      "card_number": "219",
      "lang": "en",
      "name": "Pikachu ex",
      "rarity": "Ultra Rare",
      "series": "Scarlet & Violet",
      "set": "Surging Sparks",
      "set_code": "SSP",
      "year": 2024
    },
    ...
  ],
  "page": 1,
  "query_records": [
    "Pikachu ex 247 Surging Sparks"
  ],
  "size": 10,
  "statistics": {
    "OperationTime": 718
  },
  "totalPages": 58
}

Available Filter Fields

When using the filter parameter in the pricing endpoint, you can filter by the following fields:

Subcategory: Pokemon, Magic The Gathering, ...
lang: language (jp, en, zh_TW, zh_CN)
set_code: set code of the game (string)
year: numerical value (year of release)
card_number: string that represents card number

Filter Examples

"Subcategory = 'Magic The Gathering'"
"set_code = 'BW1'"
"lang = 'jp'"
"card_number = '247'"
"year < 2020"

The whole request with filter:

cURL

  curl --location 'https://api.ximilar.com/collectibles/text/v2/tcg/list' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Token __API_TOKEN__' \
  --data '{
    "query_record": {
      "_text_data": "Snow"
    },
    "filter": "Subcategory = 'Magic The Gathering'"
    "page": 1,
    "size": 10
  }'

POST/text/v2/tcg/pricing

TCG Pricing Search

This endpoint allows you to search through pricing data for TCG card items using text queries. You can find current market prices, historical sales data for TCGs.

The pricing data includes information from multiple sources including eBay, TCGPlayer, and other marketplaces, providing comprehensive market insights for collectors and traders.