Scrython/Autocomplete.md

1.7 KiB

class 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

>>> auto = scrython.cards.Autocomplete(q="Thal") 
>>> auto.total_items() 

Methods


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
        

data()

The list of potential autocompletes
        
        Returns:
            list: A list of possible corrections