Created docs for everything
This commit is contained in:
parent
8d977cea01
commit
925d4eb91b
|
@ -0,0 +1,191 @@
|
||||||
|
# **class** `scrython.bulk_data.BulkData()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`BulkData().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
object: The Scryfall endpoint object.
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|Exception|Raised if Scryfall sends an error object.|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> data = scrython.bulk_data.BulkData()
|
||||||
|
>>> data.bulk_compressed_size()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `bulk_compressed_size()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The size of the file in bytes
|
||||||
|
|
||||||
|
Args:
|
||||||
|
num (int): The index of the object in the `data` key
|
||||||
|
human_readable (bool, optional): Defaults to False. Converts the bytes into a human readable format
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer: Returns integer by default.
|
||||||
|
string: If human_readable is True, returns a string.
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `bulk_content_encoding()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The encoding of the file
|
||||||
|
|
||||||
|
Args:
|
||||||
|
num (int): The index of the object in the `data` key
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string: The encoding of the file
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `bulk_content_type()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The MIME type of the file
|
||||||
|
|
||||||
|
Args:
|
||||||
|
num (int): The index of the object in the `data` key
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string: The MIME type
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `bulk_description()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A description of the object
|
||||||
|
|
||||||
|
Args:
|
||||||
|
num (int): The index of the object in the `data` key
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string: The description of the data item
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `bulk_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The unique ID of the bulk item
|
||||||
|
|
||||||
|
Args:
|
||||||
|
num (int): The index of the object in the `data` key
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string: The Scryfall id of the object
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `bulk_name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The name of the type of bulk data object
|
||||||
|
|
||||||
|
Args:
|
||||||
|
num (int): The index of the object in the `data` key
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string: The name of the data item
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `bulk_object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object the specified index is
|
||||||
|
|
||||||
|
Args:
|
||||||
|
num (int): The index of the object in the `data` key
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string: The type of object
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `bulk_permalink_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The URL that hosts the bulk file
|
||||||
|
|
||||||
|
Args:
|
||||||
|
num (int): The index of the object in the `data` key
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string: A URI to download the compressed data
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `bulk_type()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The type of bulk data
|
||||||
|
|
||||||
|
Args:
|
||||||
|
num (int): The index of the object in the `data` key
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string: The type of the data item
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `bulk_updated_at()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The time the item was last updated
|
||||||
|
|
||||||
|
Args:
|
||||||
|
num (int): The index of the object in the `data` key
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string: Timestamp
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types of types returned by the endpoints
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list: List of all types
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `has_more()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if there is more than one page of results
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean: True if there are more results
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is.
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string: The type of object
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,662 @@
|
||||||
|
# **class** `scrython.cards.ArenaId()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`ArenaId().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|id|string|The Arena Id of the card.|
|
||||||
|
|format|string, optional|Defaults to \'json\'. Returns data in the specified method.|
|
||||||
|
|face|string, optional|Defaults to empty string. If you\'re using the `image` format, this will specify if you want the front or back face.|
|
||||||
|
|version|string, optional|Defaults to empty string. If you\'re using the `image` format, this will specify if you want the small, normal, large, etc version of the image.|
|
||||||
|
|pretty|string, optional|Defaults to empty string. Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|Exception|If the \'id\' parameter is not provided.|
|
||||||
|
|Exception|If the object returned is an error.|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> card = scrython.cards.ArenaId(id="66975")
|
||||||
|
>>> card.name()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `all_parts()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This this card is closely related to other cards, this property will be an list with it
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `arena_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The Arena ID of the card, if any
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
int: The Arena ID of the card, if any
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `artist()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The artist of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `border_color()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The color of the card border
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `card_faces()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If it exists, all parts found on a card's face will be found as an object from this list
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `cmc()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A float of the converted mana cost of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
float: The cmc of the card
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `collector_number()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The collector number of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `color_identity()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of strings with all colors found on the card itself
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `color_indicator()`
|
||||||
|
|
||||||
|
```
|
||||||
|
An list of all colors found in this card's color indicator
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `colors()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of strings with all colors found in the mana cost
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `colorshifted()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is colorshifted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `currency()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns currency from modes `usd`, `eur`, and `tix`
|
||||||
|
|
||||||
|
Args:
|
||||||
|
mode (string): The currency to get
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
KeyError: If the mode parameter does not match a known key
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
float: The currency as a float
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `digital()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is the digital version
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `edhrec_rank()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The rank of the card on edhrec.com
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
int: The rank of the card on edhrec.co
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `flavor_text()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The flavor text of the card, if any
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `foil()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this printing exists in a foil version
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `frame()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The year of the card frame
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `full_art()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is considered full art
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `futureshifted()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is futureshifted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `hand_modifier()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This cards hand modifier value, assuming it's a Vanguard card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `highres_image()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Determine if a card has a highres scan available
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A unique ID for the returned card object
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `illustration_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The related id of the card art
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `image_uris()`
|
||||||
|
|
||||||
|
```
|
||||||
|
All image uris of the card in various qualities
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `lang()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The language of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `layout()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The image layout of the card. (normal, transform, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `legalities()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A dictionary of all formats and their legality
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `life_modifier()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This is the cards life modifier value, assuming it's a Vanguard card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `loyalty()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This card's loyalty. Some loyalties may be X rather than a number
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mana_cost()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full mana cost using shorthanded mana symbols
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mtgo_foil_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The corresponding MTGO foil ID of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer: The Magic Online foil id of the card
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mtgo_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The official MTGO id of the of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer: The Magic Online id of the card
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `multiverse_ids()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The official Gatherer multiverse ids of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The oracle name of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `nonfoil()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this printing does not exist in foil
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `oracle_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A unique ID for this card's oracle text
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `oracle_text()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The official oracle text of a card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `oversized()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this printing is an oversized card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `power()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The power of the creature, if applicable
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `printed_name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If the card is in a non-English language, this will be the name as it appears on the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `printed_text()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If the card is in a non-English language, this will be the rules text as it appears on the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `printed_type_line()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If the card is in a non-English language, this will be the type line as it appears on the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `prints_search_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A link to where you can begin paginating all re/prints for this card on Scryfall’s API
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `purchase_uris()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A dictionary of links to purchase the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `rarity()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The rarity of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `related_uris()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A dictionary of related websites for this card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `reprint()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card has been reprinted before
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `reserved()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is on the reserved list
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `rulings_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API uri for the rulings of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `scryfall_set_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full link to the set on Scryfall
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `scryfall_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full Scryfall page of the card
|
||||||
|
As if it was a URL from the site.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_code()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The 3 letter code for the set of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full name for the set of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_search_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Same output as set_uri
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API uri for the full set list of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `story_spotlight()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this card is featured in the story
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `timeshifted()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is timeshifted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `toughness()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The toughness of the creature, if applicable
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `type_line()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full type line of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The Scryfall API uri for the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `watermark()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The associated watermark of the card, if any
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,65 @@
|
||||||
|
# **class** `scrython.cards.Autocomplete()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Autocomplete().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|q|string|The query of the autocompletion.|
|
||||||
|
|format|string, optional|Defaults to \'json\'. Returns data in the specified method.|
|
||||||
|
|face|string, optional|Defaults to empty string. If you\'re using the `image` format, this will specify if you want the front or back face.|
|
||||||
|
|version|string, optional|Defaults to empty string. If you\'re using the `image` format, this will specify if you want the small, normal, large, etc version of the image.|
|
||||||
|
|pretty|string, optional|Defaults to empty string. Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|Exception|If the \'q\' parameter is not provided.|
|
||||||
|
|Exception|If the object returned is an error.|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> auto = scrython.cards.Autocomplete(q="Thal")
|
||||||
|
>>> auto.total_items()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The list of potential autocompletes
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list: A list of possible corrections
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is.
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string: The type of object
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
How many items are returned in `data`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
int: The number of items in the `data` key
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,659 @@
|
||||||
|
# **class** `scrython.cards.Collector()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Collector().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|lang|string, optional|Defaults to \'en\'. A 2-|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|Exception|If the \'code\' parameter is not provided.|
|
||||||
|
|Exception|If the \'collector_number\' parameter is not provided.|
|
||||||
|
|Exception|If the object returned is an error.|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> card = scrython.cards.Collector(code="exo", collector_number="96")
|
||||||
|
>>> card.id()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `all_parts()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This this card is closely related to other cards, this property will be an list with it
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `arena_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The Arena ID of the card, if any
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
int: The Arena ID of the card, if any
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `artist()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The artist of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `border_color()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The color of the card border
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `card_faces()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If it exists, all parts found on a card's face will be found as an object from this list
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `cmc()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A float of the converted mana cost of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
float: The cmc of the card
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `collector_number()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The collector number of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `color_identity()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of strings with all colors found on the card itself
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `color_indicator()`
|
||||||
|
|
||||||
|
```
|
||||||
|
An list of all colors found in this card's color indicator
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `colors()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of strings with all colors found in the mana cost
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `colorshifted()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is colorshifted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `currency()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns currency from modes `usd`, `eur`, and `tix`
|
||||||
|
|
||||||
|
Args:
|
||||||
|
mode (string): The currency to get
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
KeyError: If the mode parameter does not match a known key
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
float: The currency as a float
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `digital()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is the digital version
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `edhrec_rank()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The rank of the card on edhrec.com
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
int: The rank of the card on edhrec.co
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `flavor_text()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The flavor text of the card, if any
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `foil()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this printing exists in a foil version
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `frame()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The year of the card frame
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `full_art()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is considered full art
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `futureshifted()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is futureshifted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `hand_modifier()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This cards hand modifier value, assuming it's a Vanguard card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `highres_image()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Determine if a card has a highres scan available
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A unique ID for the returned card object
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `illustration_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The related id of the card art
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `image_uris()`
|
||||||
|
|
||||||
|
```
|
||||||
|
All image uris of the card in various qualities
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `lang()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The language of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `layout()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The image layout of the card. (normal, transform, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `legalities()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A dictionary of all formats and their legality
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `life_modifier()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This is the cards life modifier value, assuming it's a Vanguard card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `loyalty()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This card's loyalty. Some loyalties may be X rather than a number
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mana_cost()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full mana cost using shorthanded mana symbols
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mtgo_foil_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The corresponding MTGO foil ID of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer: The Magic Online foil id of the card
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mtgo_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The official MTGO id of the of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer: The Magic Online id of the card
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `multiverse_ids()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The official Gatherer multiverse ids of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The oracle name of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `nonfoil()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this printing does not exist in foil
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `oracle_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A unique ID for this card's oracle text
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `oracle_text()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The official oracle text of a card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `oversized()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this printing is an oversized card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `power()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The power of the creature, if applicable
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `printed_name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If the card is in a non-English language, this will be the name as it appears on the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `printed_text()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If the card is in a non-English language, this will be the rules text as it appears on the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `printed_type_line()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If the card is in a non-English language, this will be the type line as it appears on the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `prints_search_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A link to where you can begin paginating all re/prints for this card on Scryfall’s API
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `purchase_uris()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A dictionary of links to purchase the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `rarity()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The rarity of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `related_uris()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A dictionary of related websites for this card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `reprint()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card has been reprinted before
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `reserved()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is on the reserved list
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `rulings_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API uri for the rulings of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `scryfall_set_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full link to the set on Scryfall
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `scryfall_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full Scryfall page of the card
|
||||||
|
As if it was a URL from the site.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_code()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The 3 letter code for the set of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full name for the set of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_search_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Same output as set_uri
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API uri for the full set list of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `story_spotlight()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this card is featured in the story
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `timeshifted()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is timeshifted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `toughness()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The toughness of the creature, if applicable
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `type_line()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full type line of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The Scryfall API uri for the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `watermark()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The associated watermark of the card, if any
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,85 @@
|
||||||
|
# **class** `scrython.cards.Id()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Id().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|id|string|The id of the card you want rulings for.|
|
||||||
|
|format|string, optional|Returns data in the specified method. Defaults to JSON.|
|
||||||
|
|face|string, optional|If you\'re using the `image` format, this will specify if you want the front or back face.|
|
||||||
|
|version|string, optional|If you\'re using the `image` format, this will specify if you want the small, normal, large, etc version of the image.|
|
||||||
|
|pretty|string, optional|Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> rule = scrython.rulings.Id(id="5976c352
|
||||||
|
>>> rule.data_length()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The data returned from the query
|
||||||
|
|
||||||
|
Acceptable keys:
|
||||||
|
object (string): The type of object for a given ruling.
|
||||||
|
source (string): The source of the ruling.
|
||||||
|
published_at (string): The date when the ruling was published.
|
||||||
|
comment (string): The effective ruling.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
index (integer, optional): Defaults to None. Access a specific index.
|
||||||
|
key (string, optional): Defaults to None. Returns the value of the given key. Requires the `index` argument.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List: The full list of data.
|
||||||
|
Dictionary: If given an index
|
||||||
|
String: If given an index and key.
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `data_length()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The length of the `data` list.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `has_more()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if there is more than one page of results
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean: True if there are more results
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,85 @@
|
||||||
|
# **class** `scrython.cards.Mtgo()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Mtgo().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|id|string|The mtgo id of the card you want rulings for.|
|
||||||
|
|format|string, optional|Returns data in the specified method. Defaults to JSON.|
|
||||||
|
|face|string, optional|If you\'re using the `image` format, this will specify if you want the front or back face.|
|
||||||
|
|version|string, optional|If you\'re using the `image` format, this will specify if you want the small, normal, large, etc version of the image.|
|
||||||
|
|pretty|string, optional|Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> rule = scrython.rulings.Mtgo(id="9611")
|
||||||
|
>>> rule.data_length()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The data returned from the query
|
||||||
|
|
||||||
|
Acceptable keys:
|
||||||
|
object (string): The type of object for a given ruling.
|
||||||
|
source (string): The source of the ruling.
|
||||||
|
published_at (string): The date when the ruling was published.
|
||||||
|
comment (string): The effective ruling.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
index (integer, optional): Defaults to None. Access a specific index.
|
||||||
|
key (string, optional): Defaults to None. Returns the value of the given key. Requires the `index` argument.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List: The full list of data.
|
||||||
|
Dictionary: If given an index
|
||||||
|
String: If given an index and key.
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `data_length()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The length of the `data` list.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `has_more()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if there is more than one page of results
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean: True if there are more results
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,85 @@
|
||||||
|
# **class** `scrython.cards.Multiverse()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Multiverse().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|id|string|The multiverse id of the card you want rulings for.|
|
||||||
|
|format|string, optional|Returns data in the specified method. Defaults to JSON.|
|
||||||
|
|face|string, optional|If you\'re using the `image` format, this will specify if you want the front or back face.|
|
||||||
|
|version|string, optional|If you\'re using the `image` format, this will specify if you want the small, normal, large, etc version of the image.|
|
||||||
|
|pretty|string, optional|Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> rule = scrython.rulings.Id(id="4301")
|
||||||
|
>>> rule.data_length()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The data returned from the query
|
||||||
|
|
||||||
|
Acceptable keys:
|
||||||
|
object (string): The type of object for a given ruling.
|
||||||
|
source (string): The source of the ruling.
|
||||||
|
published_at (string): The date when the ruling was published.
|
||||||
|
comment (string): The effective ruling.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
index (integer, optional): Defaults to None. Access a specific index.
|
||||||
|
key (string, optional): Defaults to None. Returns the value of the given key. Requires the `index` argument.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List: The full list of data.
|
||||||
|
Dictionary: If given an index
|
||||||
|
String: If given an index and key.
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `data_length()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The length of the `data` list.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `has_more()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if there is more than one page of results
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean: True if there are more results
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,664 @@
|
||||||
|
# **class** `scrython.cards.Named()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Named().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|fuzzy|string|Uses the fuzzy parameter for the card name.|
|
||||||
|
|exact|string|Uses the exact parameter for the card name.|
|
||||||
|
|set|string, optional|Defaults to empty string. Returns the set of the card if specified. Requires the 3 letter set code.|
|
||||||
|
|format|string, optional|Defaults to \'json\'. Returns data in the specified method.|
|
||||||
|
|face|string, optional|Defaults to empty string. If you\'re using the `image` format, this will specify if you want the front or back face.|
|
||||||
|
|version|string, optional|Defaults to empty string. If you\'re using the `image` format, this will specify if you want the small, normal, large, etc version of the image.|
|
||||||
|
|pretty|string, optional|Defaults to empty string. Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|Exception|If the \'fuzzy\' or \'exact\' parameter is not provided.|
|
||||||
|
|Exception|If the object returned is an error.|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> card = scrython.cards.Named(exact="Black Lotus")
|
||||||
|
>>> card.colors()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `all_parts()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This this card is closely related to other cards, this property will be an list with it
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `arena_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The Arena ID of the card, if any
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
int: The Arena ID of the card, if any
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `artist()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The artist of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `border_color()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The color of the card border
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `card_faces()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If it exists, all parts found on a card's face will be found as an object from this list
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `cmc()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A float of the converted mana cost of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
float: The cmc of the card
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `collector_number()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The collector number of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `color_identity()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of strings with all colors found on the card itself
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `color_indicator()`
|
||||||
|
|
||||||
|
```
|
||||||
|
An list of all colors found in this card's color indicator
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `colors()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of strings with all colors found in the mana cost
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `colorshifted()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is colorshifted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `currency()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns currency from modes `usd`, `eur`, and `tix`
|
||||||
|
|
||||||
|
Args:
|
||||||
|
mode (string): The currency to get
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
KeyError: If the mode parameter does not match a known key
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
float: The currency as a float
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `digital()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is the digital version
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `edhrec_rank()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The rank of the card on edhrec.com
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
int: The rank of the card on edhrec.co
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `flavor_text()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The flavor text of the card, if any
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `foil()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this printing exists in a foil version
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `frame()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The year of the card frame
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `full_art()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is considered full art
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `futureshifted()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is futureshifted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `hand_modifier()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This cards hand modifier value, assuming it's a Vanguard card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `highres_image()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Determine if a card has a highres scan available
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A unique ID for the returned card object
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `illustration_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The related id of the card art
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `image_uris()`
|
||||||
|
|
||||||
|
```
|
||||||
|
All image uris of the card in various qualities
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `lang()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The language of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `layout()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The image layout of the card. (normal, transform, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `legalities()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A dictionary of all formats and their legality
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `life_modifier()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This is the cards life modifier value, assuming it's a Vanguard card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `loyalty()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This card's loyalty. Some loyalties may be X rather than a number
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mana_cost()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full mana cost using shorthanded mana symbols
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mtgo_foil_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The corresponding MTGO foil ID of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer: The Magic Online foil id of the card
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mtgo_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The official MTGO id of the of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer: The Magic Online id of the card
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `multiverse_ids()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The official Gatherer multiverse ids of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The oracle name of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `nonfoil()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this printing does not exist in foil
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `oracle_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A unique ID for this card's oracle text
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `oracle_text()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The official oracle text of a card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `oversized()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this printing is an oversized card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `power()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The power of the creature, if applicable
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `printed_name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If the card is in a non-English language, this will be the name as it appears on the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `printed_text()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If the card is in a non-English language, this will be the rules text as it appears on the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `printed_type_line()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If the card is in a non-English language, this will be the type line as it appears on the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `prints_search_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A link to where you can begin paginating all re/prints for this card on Scryfall’s API
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `purchase_uris()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A dictionary of links to purchase the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `rarity()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The rarity of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `related_uris()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A dictionary of related websites for this card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `reprint()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card has been reprinted before
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `reserved()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is on the reserved list
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `rulings_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API uri for the rulings of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `scryfall_set_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full link to the set on Scryfall
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `scryfall_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full Scryfall page of the card
|
||||||
|
As if it was a URL from the site.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_code()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The 3 letter code for the set of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full name for the set of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_search_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Same output as set_uri
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API uri for the full set list of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `story_spotlight()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this card is featured in the story
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `timeshifted()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is timeshifted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `toughness()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The toughness of the creature, if applicable
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `type_line()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full type line of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The Scryfall API uri for the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `watermark()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The associated watermark of the card, if any
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,660 @@
|
||||||
|
# **class** `scrython.cards.Random()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Random().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|format|string, optional|Defaults to 'json'. Returns data in the specified method.|
|
||||||
|
|face|string, optional|Defaults to empty string. If you're using the `image` format, this will specify if you want the front or back face.|
|
||||||
|
|version|string, optional|Defaults to empty string. If you're using the `image` format, this will specify if you want the small, normal, large, etc version of the image.|
|
||||||
|
|pretty|string, optional|Defaults to empty string. Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|Exception|If the object returned is an error.|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> card = scrython.cards.Random()
|
||||||
|
>>> card.purchase_uris() "
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `all_parts()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This this card is closely related to other cards, this property will be an list with it
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `arena_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The Arena ID of the card, if any
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
int: The Arena ID of the card, if any
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `artist()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The artist of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `border_color()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The color of the card border
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `card_faces()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If it exists, all parts found on a card's face will be found as an object from this list
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `cmc()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A float of the converted mana cost of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
float: The cmc of the card
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `collector_number()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The collector number of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `color_identity()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of strings with all colors found on the card itself
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `color_indicator()`
|
||||||
|
|
||||||
|
```
|
||||||
|
An list of all colors found in this card's color indicator
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `colors()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of strings with all colors found in the mana cost
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `colorshifted()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is colorshifted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `currency()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns currency from modes `usd`, `eur`, and `tix`
|
||||||
|
|
||||||
|
Args:
|
||||||
|
mode (string): The currency to get
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
KeyError: If the mode parameter does not match a known key
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
float: The currency as a float
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `digital()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is the digital version
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `edhrec_rank()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The rank of the card on edhrec.com
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
int: The rank of the card on edhrec.co
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `flavor_text()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The flavor text of the card, if any
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `foil()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this printing exists in a foil version
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `frame()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The year of the card frame
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `full_art()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is considered full art
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `futureshifted()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is futureshifted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `hand_modifier()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This cards hand modifier value, assuming it's a Vanguard card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `highres_image()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Determine if a card has a highres scan available
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A unique ID for the returned card object
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `illustration_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The related id of the card art
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `image_uris()`
|
||||||
|
|
||||||
|
```
|
||||||
|
All image uris of the card in various qualities
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `lang()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The language of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `layout()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The image layout of the card. (normal, transform, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `legalities()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A dictionary of all formats and their legality
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `life_modifier()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This is the cards life modifier value, assuming it's a Vanguard card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `loyalty()`
|
||||||
|
|
||||||
|
```
|
||||||
|
This card's loyalty. Some loyalties may be X rather than a number
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mana_cost()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full mana cost using shorthanded mana symbols
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mtgo_foil_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The corresponding MTGO foil ID of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer: The Magic Online foil id of the card
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mtgo_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The official MTGO id of the of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer: The Magic Online id of the card
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `multiverse_ids()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The official Gatherer multiverse ids of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The oracle name of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `nonfoil()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this printing does not exist in foil
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `oracle_id()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A unique ID for this card's oracle text
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `oracle_text()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The official oracle text of a card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `oversized()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this printing is an oversized card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `power()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The power of the creature, if applicable
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `printed_name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If the card is in a non-English language, this will be the name as it appears on the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `printed_text()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If the card is in a non-English language, this will be the rules text as it appears on the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `printed_type_line()`
|
||||||
|
|
||||||
|
```
|
||||||
|
If the card is in a non-English language, this will be the type line as it appears on the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `prints_search_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A link to where you can begin paginating all re/prints for this card on Scryfall’s API
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `purchase_uris()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A dictionary of links to purchase the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `rarity()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The rarity of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `related_uris()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A dictionary of related websites for this card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
dict
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `reprint()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card has been reprinted before
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `reserved()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is on the reserved list
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `rulings_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API uri for the rulings of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `scryfall_set_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full link to the set on Scryfall
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `scryfall_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full Scryfall page of the card
|
||||||
|
As if it was a URL from the site.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_code()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The 3 letter code for the set of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full name for the set of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_search_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Same output as set_uri
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API uri for the full set list of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `story_spotlight()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this card is featured in the story
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `timeshifted()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns True if the card is timeshifted
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `toughness()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The toughness of the creature, if applicable
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `type_line()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full type line of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The Scryfall API uri for the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `watermark()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The associated watermark of the card, if any
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,110 @@
|
||||||
|
# **class** `scrython.cards.Search()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Search().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|q|string|The query to search. This will be updated in the future.|
|
||||||
|
|order|string, optional|Defaults to \'none\' The order you\'d like the data returned.|
|
||||||
|
|unique|string, optional|Defaults to \'none\' A way to filter similar cards.|
|
||||||
|
|include_extras|boolean, optional|Defaults to \'false\' Includes cards that are normally omitted from search results, like Un-|
|
||||||
|
|include_multilingual|boolean, optional|Defaults to \'false\' Includes cards that are in the language specified.|
|
||||||
|
|page|integer, optional|Defaults to \'1\' The page number you\'d like to search, if any.|
|
||||||
|
|format|string, optional|Defaults to \'json\'. Returns data in the specified method.|
|
||||||
|
|face|string, optional|Defaults to empty string. If you\'re using the `image` format, this will specify if you want the front or back face.|
|
||||||
|
|version|string, optional|Defaults to empty string. If you\'re using the `image` format, this will specify if you want the small, normal, large, etc version of the image.|
|
||||||
|
|pretty|string, optional|Defaults to empty string. Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|Exception|If the \'q\' parameter is not provided.|
|
||||||
|
|Exception|If the object returned is an error.|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> search = scrython.cards.Search(q="++e:A25", order="spoiled")
|
||||||
|
>>> search.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The data returned from the query
|
||||||
|
|
||||||
|
You may reference any keys that could be accessed in a card object.
|
||||||
|
There are far too many to list here, but you may find a list if applicable
|
||||||
|
keys in the documentation.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
index (integer, optional): Defaults to None. Access a specific index.
|
||||||
|
key (string, optional): Defaults to None. Returns the value of the given key. Requires the `index` argument.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List: The full list of data.
|
||||||
|
Dictionary: If given an index.
|
||||||
|
String: If given an index and key.
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `data_length()`
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer: The length of data returned
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `has_more()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Determines if there are more pages of results.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean: True if there is more than 1 page of results
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `next_page()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI to the next page of the query
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string: A URI to the next page of the query
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is.
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string: The type of object
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_cards()`
|
||||||
|
|
||||||
|
```
|
||||||
|
How many cards are returned from the query
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer: The number of cards returned
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,68 @@
|
||||||
|
# **class** `scrython.catalog.ArtifactTypes()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`ArtifactTypes().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.ArtifactTypes()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,68 @@
|
||||||
|
# **class** `scrython.catalog.ArtistNames()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`ArtistNames().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.CardNames()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,68 @@
|
||||||
|
# **class** `scrython.catalog.CardNames()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`CardNames().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.CardNames()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,68 @@
|
||||||
|
# **class** `scrython.catalog.CreatureTypes()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`CreatureTypes().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.CreatureTypes()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,68 @@
|
||||||
|
# **class** `scrython.catalog.EnchantmentTypes()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`EnchantmentTypes().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.EnchantmentTypes()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,68 @@
|
||||||
|
# **class** `scrython.catalog.LandTypes()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`LandTypes().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.LandTypes()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,68 @@
|
||||||
|
# **class** `scrython.catalog.Loyalties()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Loyalties().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.Loyalties()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,68 @@
|
||||||
|
# **class** `scrython.catalog.PlaneswalkerTypes()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`PlaneswalkerTypes().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.PlaneswalkerTypes()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,68 @@
|
||||||
|
# **class** `scrython.catalog.Powers()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Powers().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.Powers()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,68 @@
|
||||||
|
# **class** `scrython.catalog.SpellTypes()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`SpellTypes().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.SpellTypes()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,68 @@
|
||||||
|
# **class** `scrython.catalog.Toughnesses()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Toughnesses().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.Toughnesses()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,68 @@
|
||||||
|
# **class** `scrython.catalog.Watermarks()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Watermarks().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.Watermarks()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,68 @@
|
||||||
|
# **class** `scrython.catalog.WordBank()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`WordBank().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> catalog = scrython.catalog.WordBank()
|
||||||
|
>>> catalog.data()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all types returned by the endpoint
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `total_values()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of items in `data()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The API URI for the endpoint you've called.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,171 @@
|
||||||
|
# **class** `scrython.rulings.Code()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Code().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|code|string|The 3 letter code of the set.|
|
||||||
|
|format|string, optional|Returns data in the specified method. Defaults to JSON.|
|
||||||
|
|pretty|string, optional|Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> set = scrython.sets.Code(code="por")
|
||||||
|
>>> set.name()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `block()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full name of the block a set was in
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `block_code()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The the letter code for the block the set was in
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `card_count()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of cards in the set
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `code()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The three letter set code of the set
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `digital()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this set is only featured on MTGO
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `foil_only()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this set only has foils
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `icon_svg_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A URI to the SVG of the set symbol
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mtgo_code()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The mtgo equivalent of `code()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full name of the set
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `parent_set_code()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The set code for the parent set
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `released_at()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The date the set was launched
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `search_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The scryfall API url for the search
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_type()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The type of the set (expansion, commander, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,85 @@
|
||||||
|
# **class** `scrython.rulings.Id()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Id().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|id|string|The id of the card you want rulings for.|
|
||||||
|
|format|string, optional|Returns data in the specified method. Defaults to JSON.|
|
||||||
|
|face|string, optional|If you\'re using the `image` format, this will specify if you want the front or back face.|
|
||||||
|
|version|string, optional|If you\'re using the `image` format, this will specify if you want the small, normal, large, etc version of the image.|
|
||||||
|
|pretty|string, optional|Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> rule = scrython.rulings.Id(id="5976c352
|
||||||
|
>>> rule.data_length()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The data returned from the query
|
||||||
|
|
||||||
|
Acceptable keys:
|
||||||
|
object (string): The type of object for a given ruling.
|
||||||
|
source (string): The source of the ruling.
|
||||||
|
published_at (string): The date when the ruling was published.
|
||||||
|
comment (string): The effective ruling.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
index (integer, optional): Defaults to None. Access a specific index.
|
||||||
|
key (string, optional): Defaults to None. Returns the value of the given key. Requires the `index` argument.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List: The full list of data.
|
||||||
|
Dictionary: If given an index
|
||||||
|
String: If given an index and key.
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `data_length()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The length of the `data` list.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `has_more()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if there is more than one page of results
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean: True if there are more results
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,85 @@
|
||||||
|
# **class** `scrython.rulings.Mtgo()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Mtgo().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|id|string|The mtgo id of the card you want rulings for.|
|
||||||
|
|format|string, optional|Returns data in the specified method. Defaults to JSON.|
|
||||||
|
|face|string, optional|If you\'re using the `image` format, this will specify if you want the front or back face.|
|
||||||
|
|version|string, optional|If you\'re using the `image` format, this will specify if you want the small, normal, large, etc version of the image.|
|
||||||
|
|pretty|string, optional|Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> rule = scrython.rulings.Mtgo(id="9611")
|
||||||
|
>>> rule.data_length()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The data returned from the query
|
||||||
|
|
||||||
|
Acceptable keys:
|
||||||
|
object (string): The type of object for a given ruling.
|
||||||
|
source (string): The source of the ruling.
|
||||||
|
published_at (string): The date when the ruling was published.
|
||||||
|
comment (string): The effective ruling.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
index (integer, optional): Defaults to None. Access a specific index.
|
||||||
|
key (string, optional): Defaults to None. Returns the value of the given key. Requires the `index` argument.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List: The full list of data.
|
||||||
|
Dictionary: If given an index
|
||||||
|
String: If given an index and key.
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `data_length()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The length of the `data` list.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `has_more()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if there is more than one page of results
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean: True if there are more results
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,85 @@
|
||||||
|
# **class** `scrython.rulings.Multiverse()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Multiverse().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|id|string|The multiverse id of the card you want rulings for.|
|
||||||
|
|format|string, optional|Returns data in the specified method. Defaults to JSON.|
|
||||||
|
|face|string, optional|If you\'re using the `image` format, this will specify if you want the front or back face.|
|
||||||
|
|version|string, optional|If you\'re using the `image` format, this will specify if you want the small, normal, large, etc version of the image.|
|
||||||
|
|pretty|string, optional|Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> rule = scrython.rulings.Id(id="4301")
|
||||||
|
>>> rule.data_length()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The data returned from the query
|
||||||
|
|
||||||
|
Acceptable keys:
|
||||||
|
object (string): The type of object for a given ruling.
|
||||||
|
source (string): The source of the ruling.
|
||||||
|
published_at (string): The date when the ruling was published.
|
||||||
|
comment (string): The effective ruling.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
index (integer, optional): Defaults to None. Access a specific index.
|
||||||
|
key (string, optional): Defaults to None. Returns the value of the given key. Requires the `index` argument.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List: The full list of data.
|
||||||
|
Dictionary: If given an index
|
||||||
|
String: If given an index and key.
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `data_length()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The length of the `data` list.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `has_more()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if there is more than one page of results
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean: True if there are more results
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,171 @@
|
||||||
|
# **class** `scrython.sets.Code()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Code().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|code|string|The 3 letter code of the set.|
|
||||||
|
|format|string, optional|Returns data in the specified method. Defaults to JSON.|
|
||||||
|
|pretty|string, optional|Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> set = scrython.sets.Code(code="por")
|
||||||
|
>>> set.name()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `block()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full name of the block a set was in
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `block_code()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The the letter code for the block the set was in
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `card_count()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The number of cards in the set
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `code()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The three letter set code of the set
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `digital()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this set is only featured on MTGO
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `foil_only()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if this set only has foils
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `icon_svg_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A URI to the SVG of the set symbol
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mtgo_code()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The mtgo equivalent of `code()`
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `name()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The full name of the set
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `parent_set_code()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The set code for the parent set
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `released_at()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The date the set was launched
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `search_uri()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The scryfall API url for the search
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `set_type()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The type of the set (expansion, commander, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,92 @@
|
||||||
|
# **class** `scrython.sets.Sets()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Sets().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|format|string, optional|Returns data in the specified method. Defaults to JSON.|
|
||||||
|
|pretty|string, optional|Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> set = scrython.sets.Sets()
|
||||||
|
>>> set.data(3, "name")
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The data returned from the query
|
||||||
|
|
||||||
|
Acceptable keys:
|
||||||
|
object (string): The set object.
|
||||||
|
code (string): The three letter set code of the set.
|
||||||
|
mtgo_code (string): The mtgo equivalent of `code()`.
|
||||||
|
name (string): The full name of the set.
|
||||||
|
set_type (string): The type of the set (expansion, commander, etc)
|
||||||
|
released_at (string): The date the set was launched.
|
||||||
|
block_code (string): The the letter code for the block the set was in.
|
||||||
|
block (string): The full name of the block a set was in.
|
||||||
|
parent_set_code (string): The set code for the parent set.
|
||||||
|
card_count (integer): The number of cards in the set.
|
||||||
|
digital (boolean): True if this set is only featured on MTGO.
|
||||||
|
foil_only (boolean): True if this set only has foils.
|
||||||
|
icon_svg_uri (string): A URI to the SVG of the set symbol.
|
||||||
|
search_uri (string): The scryfall API url for the search.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
index (integer, optional): Defaults to None. Access a specific index.
|
||||||
|
key (string, optional): Defaults to None. Returns the value of the given key. Requires the `index` argument.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List: The full list of data.
|
||||||
|
Dictionary: If given an index
|
||||||
|
String: If given an index and key.
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `data_length()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The length of the data returned
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `has_more()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if there are more pages available
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,101 @@
|
||||||
|
# **class** `scrython.symbology.ParseMana()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`ParseMana().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|cost|string|The given mana cost you want.|
|
||||||
|
|format|string, optional|Returns data in the specified method. Defaults to JSON.|
|
||||||
|
|pretty|string, optional|Returns a prettier version of the json object. Note that this may break functionality with Scrython.|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> mana = scrython.symbology.ParseMana(cost="xcug")
|
||||||
|
>>> mana.colors()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `cmc()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The converted mana cost of the card
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
float
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `colorless()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if the mana cost is colorless
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `colors()`
|
||||||
|
|
||||||
|
```
|
||||||
|
A list of all colors in the mana cost
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
list
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `mana_cost()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The formatted mana cost
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `monocolored()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if the mana cost is mono colored
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `multicolored()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if the mana cost is a multicolored cost
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
|
@ -0,0 +1,85 @@
|
||||||
|
# **class** `scrython.symbology.Symbology()`
|
||||||
|
|
||||||
|
These docs will likely not be as detailed as the official Scryfall Documentation, and you should reference that for more information.
|
||||||
|
|
||||||
|
>In the event that a key isn't found or has been changed, you can access the full JSON output with the `scryfallJson` variable (`Symbology().scryfallJson`).
|
||||||
|
|
||||||
|
## Args
|
||||||
|
|
||||||
|
|arg|type|description|
|
||||||
|
|:---:|:---:|:---:|
|
||||||
|
|
||||||
|
## Returns
|
||||||
|
N/A
|
||||||
|
|
||||||
|
## Raises
|
||||||
|
|
||||||
|
|exception type|reason|
|
||||||
|
|:---:|:---:|
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
```python
|
||||||
|
>>> symbol = scrython.symbology.Symbology()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
---
|
||||||
|
### `data()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The data returned from the query
|
||||||
|
|
||||||
|
Acceptable keys:
|
||||||
|
symbol (string): The plaintext symbol, usually written with curly braces
|
||||||
|
loose_variant (string): The alternate version of the symbol, without curly braces
|
||||||
|
transposable (boolean): True if it's possibly to write the symbol backwards
|
||||||
|
represents_mana (boolean): True if this is a mana symbol
|
||||||
|
cmc (float): The total converted mana cost of the symbol
|
||||||
|
appears_in_mana_costs (boolean): True if the symbol appears on the mana cost of any card
|
||||||
|
funny (boolean): True if the symbol is featured on any funny cards
|
||||||
|
colors (array): An array of all colors in the given symbol
|
||||||
|
english (string): An english sentence describing the mana cost
|
||||||
|
gatherer_alternate (array): An array of Gatherer like costs
|
||||||
|
|
||||||
|
Args:
|
||||||
|
index (integer, optional): Defaults to None. Access a specific index.
|
||||||
|
key (string, optional): Defaults to None. Returns the value of the given key. Requires the `index` argument.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List: The full list of data.
|
||||||
|
Dictionary: If given an index
|
||||||
|
String: If given an index and key.
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `data_length()`
|
||||||
|
|
||||||
|
```
|
||||||
|
The length of the data returned
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
integer
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `has_more()`
|
||||||
|
|
||||||
|
```
|
||||||
|
True if there are more pages to the object
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
boolean
|
||||||
|
|
||||||
|
```
|
||||||
|
---
|
||||||
|
### `object()`
|
||||||
|
|
||||||
|
```
|
||||||
|
Returns the type of object it is
|
||||||
|
(card, error, etc)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
string
|
||||||
|
|
||||||
|
```
|
Loading…
Reference in New Issue