Notes

The search syntax is the same between the Card and Printing endpoints aside from some fields that only exist in one or the other.

In constructed URLs for calls to the API, ensure that you URL Encode the value to the filter[search] argument.

Search Query Structure

• A search query is a series of one or more conditions separated by one or more spaces (which acts as an implicit and) or explicit conjuctions (and and or):
  • condition1 condition2 condition3 - gets all cards that meet the requirements of all three conditions
• Multiple values for a given term can be provided with | ( acts as or) or &.
  • text:"Runner is tagged"&meat will return all cards with both Runner is tagged and meat in their text.
  • text:"Runner is tagged"|meat will return all cards with either Runner is tagged or meat in their text.
• Each condition must be some or all of the name of a card or a criteria search:
  • Street - gets all cards with “Street” in their name
  • x:credit - gets all cards with “credit” in their ability text (see below for the full list of accepted criteria)
• Note that conditions containing spaces must be surrounded with quotation marks:
  • "Street Magic" or x:"take all credits"
• Negation operators
  • In addition to using a match or negated match operator (like faction!anarch), you can preface any condition with ! or - to negate the whole condition.
  • f:adam -card_type:resource will return all non-resource Adam cards.
  • f:apex !card_type:event will return all non-event Apex cards.
• Conjunctions and grouping
  • Explicit and and or conjunctions are supported by the Search Syntax.
    • t:identity and f:criminal will return all Criminal Identities.
  • Explicit parenthesis will control grouping.
    • (f:criminal or f:shaper) and t:identity or (f:criminal or f:shaper) t:identity will return all Criminal or Shaper Identities.
  • A literal and or one using a space will have a higher precedence than an or.
    • f:criminal or f:shaper and t:identity and f:criminal or f:shaper t:identity will return all Criminal cards and Shaper Identities.

Field Types and Operators

There are 5 types of fields in the Search Filter:

• Array - supports the : (an element in the array is an exact match) and ! (an element in the array is not an exact match) operators.
  • card_pool_ids:eternal|snapshot returns all cards in the eternal or snapshot card pools.
  • card_pool!snapshot returns all cards not in the snapshot card pool.
• Boolean - supports the : (match) and ! (negated match) operators. true, false, t, f, 1, and 0 are all acceptable values.
  • advanceable:true, advanceable:t, and advanceable:1 will all return all results where advanceable is true.
• Date - supports the : (match), ! (negated match), <, <=, >, and >= operators. Requires date in YYYY-MM-DD format.
  • release_date<=2020-01-01 will return everything with a release date less than or equal to New Year’s Day, 2020.
• Integer - supports the : (match), ! (negated match), <, <=, >, and >= operators. Requires simple integer input.
  • For cards that have an X value, you can match with X, like cost:X (case insensitive). an X value is treated as -1 behind the scenes.
• String - supports the : (LIKE) and ! (NOT LIKE) operators. Input is transformed to lower case and the % decorations are added automatically, turning a query like title:street into a SQL fragment like LOWER(stripped_title) LIKE '%street%.
  • title:clearance returns everything with clearance in the title.
  • title!clearance returns everything without clearance in the title.

Fields and their types

• card_pool, z: Type: array
  • card_pool_ids for a card pool containing a card.
• card_subtype, s: Type: array
  • text names for card subtypes, matched as lowercase.
• card_subtype_id: Type: array
  • card_subtype_ids for the card.
• eternal_points: Type: array
  • Concatenation of restriction_id and an Eternal Points value, joined by a hyphen, like eternal_points:eternal_points_list_22_09-2.
• format: Type: array
  • format_id for any format containing the card at any time.
• has_global_penalty: Type: array
  • restriction_id restricting the card with a global penalty, like has_global_penalty:napd_mwl_1_1.
• illustrator_id: Type: array
  • illustrator_id for an illustrator for the printing.
• is_banned: Type: array
  • restriction_id specifying the card as banned, like is_banned:standard_ban_list_22_08.
• is_restricted: Type: array
  • restriction_id specifying the card as banned, like is_restricted:standard_mwl_3_4_b.
• printings_released_by: Type: array
  • All organizations that have released printings for a card.
• restriction_id, b: Type: array
  • restriction_id specifying the card for any reason, like: restriction_id:eternal_points_list_22_09
• snapshot: Type: array
  • snapshot_id of a snapshot containing a card.
• universal_faction_cost: Type: array
  • Concatenation of restriction_id and a Universal Faction Cost value, joined by a hyphen, like universal_faction_cost:napd_mwl_1_2-3.
• additional_cost: Type: boolean
  • Does the card text specify an additional cost to play?
• advanceable: Type: boolean
  • Is the card advanceable?
• gains_subroutines: Type: boolean
  • Does the card text allow for adding or gaining subroutines?
• in_restriction: Type: boolean
  • Is the card specified on any Restriction list?
• interrupt: Type: boolean
  • Does the card have an interrupt ability?
• is_latest_printing: Type: boolean
  • Is this printing the latest printing for a card?
• is_unique, u: Type: boolean
  • Is the card unique?
• on_encounter_effect: Type: boolean
  • Does the card text specify an on encounter effect?
• performs_trace: Type: boolean
  • Does the card perform a trace?
• rez_effect: Type: boolean
  • Does the card have a rez effect?
• trash_ability: Type: boolean
  • Does the card provide a trash ability?
• release_date, date_release, r: Type: date
  • The earliest release date for a card or the release date for the set for a printing.
• advancement_cost, g: Type: integer
  • The advancement_cost value for an agenda. Accepts positive integers and X (case-insensitive).
• agenda_points, v: Type: integer
  • The printed number of agenda points for the agenda.
• base_link, l: Type: integer
  • The printed link value for an Identity.
• cost, o: Type: integer
  • The printed cost of a card. Accepts positive integers and X (case-insensitive).
• influence_cost, n: Type: integer
  • The influence cost or number of influence pips for the card.
• link_provided: Type: integer
  • The amount of link provided.
• memory_usage, m: Type: integer
  • The memory (MU) cost of this card.
• mu_provided: Type: integer
  • The amount of memory (MU) provided by the card.
• num_printed_subroutines: Type: integer
  • The number of printed subroutines on this card.
• minimum_deck_size, min_deck_size: Type: integer
  • The minimum deck size required by an Identity.
• num_printings: Type: integer
  • Count of unique printings for this card.
• position: Type: integer
  • The position of the printing in a card set.
• quantity, y: Type: integer
  • The number of copies of a printing in the set.
• recurring_credits_provided: Type: integer
  • The number of recurring credits provided by this card. Accepts integers or X.
• strength, p: Type: integer
  • The strength of the card. Accepts integers or X.
• trash_cost, h: Type: integer
  • The trash cost of this card.
• attribution: Type: string
  • The designer of this card text, if specified.
• card_cycle, c: Type: string
  • card_cycle_id for a printing.
• card_id: Type: string
  • card_id for a printing.
• card_set, e: Type: string
  • card_set_id for printing.
• card_type, t: Type: string
  • card_type_id of this card.
• designed_by: Type: string
  • The organization that designed the card.
• illustrator, i: Type: string
  • The printed version of the illustrator credits, with multiple illustrators separated by commas.
• faction, f: Type: string
  • faction_id of this card.
• flavor, flavour, a: Type: string
  • The flavor text for a printing.
• released_by: Type: string
  • The organization that released the printing.
• side, d: Type: string
  • side_id of the card.
• text, x: Type: string
  • The text of a card, stripped of all formatting symbols and marks.
• title, _: Type: string
  • The title of a card, stripped of all formatting symbols and marks.