API Reference¶

The following page outlines the API of amiibo.py

Version Info¶

To get the version of library use:

amiibo.py.__version__¶
A string representation of the library version

Client¶

class amiibo.Client[source]¶

Represent a Amiibo Client to perform requests with API

get_amiibo(**kwargs) → dict[source]¶

Return the information about a single amiibo with given arguments

Available arguments:: head, tail, name, type

If head and tail is given other params would be ignored and request as id=head+tail

For more information see: https://amiiboapi.com/docs/#amiibo

get_amiibos() → dict[source]¶: Return a list of amiibos available in the API

get_character(character: str) → dict[source]¶

Get all the amiibo based on it’s character as a list

Parameters: character (str) – the character to get the data

get_character_by_key(key: str) → dict[source]¶

Get the character by it’s key

Parameters: key (str) – The key that we use to get the data

get_character_by_name(name: str) → dict[source]¶

Get the character by it’s key

Parameters: name (str) – The name that we use to get the data

get_characters() → dict[source]¶: Get all the character available in the API as a list.

get_gameseries(gameseries: str) → dict[source]¶

Get all the amiibo based on it’s game series as a list.

Parameters: gameseries (str) – The gameseries to request.

get_gameseries_by_key(key: str) → dict[source]¶

It just return the game series that the key belongs to, since 1 key only belongs to 1 game series

Parameters: key (str) – The key that we need to get the data

get_gameseries_keys(name: str) → dict[source]¶

It return a list of keys available for the game series

Parameters: name (str) – The gameseries name which we need to fetch the data.

get_gameserieses() → dict[source]¶: Retrieve game series information, not all data return a list

get_series(amiiboSeries: str) → dict[source]¶

Get all the amiibo based on it’s series as a list.

Parameters: amiiboSeries (str) – The series to get the data

get_series_by_key(key: str) → dict[source]¶

Get the amiibo series by it’s key

Parameters: key (str) – The key that we need to get the data

get_series_by_name(name: str) → dict[source]¶

Get the amiibo series by it’s name

Parameters: name (str) – The name that we need to get the data

get_serieses() → dict[source]¶: Get all the amiibo’s series available in the API as a list.

get_type(amiibo_type: str) → dict[source]¶

Get all the amiibo based on it’s type as a list.

Parameters: amiibo_type (str) – The amiibo type. Eg. 0x02, yarn

get_type_by_id(type_id: str) → dict[source]¶

Get type by it’s id

Parameters: type_id (str) – The type id to get the data

get_type_by_name(name: str) → dict[source]¶

Get type by it’s name

Parameters: name (str) – The name to get the data

get_types() → dict[source]¶: Get all the amiibo’s type available in the API as a list

last_updated() → dict[source]¶: Get the timestamp where the amiibo API was last updated.

AsyncClient¶

class amiibo.AsyncClient[source]¶

Represent a Amiibo Client to perform requests with API

async get_amiibo(**kwargs) → dict[source]¶

Return the information about a single amiibo with given arguments

Available arguments:: head, tail, name, type

If head and tail is given other params would be ignored and request as id=head+tail

For more information see: https://amiiboapi.com/docs/#amiibo

async get_amiibos() → dict[source]¶: Return a list of amiibos available in the API

async get_character(character: str) → dict[source]¶

Get all the amiibo based on it’s character as a list

Parameters: character (str) – the character to get the data

async get_character_by_key(key: str) → dict[source]¶

Get the character by it’s key

Parameters: key (str) – The key that we use to get the data

async get_character_by_name(name: str) → dict[source]¶

Get the character by it’s key

Parameters: name (str) – The name that we use to get the data

async get_characters() → dict[source]¶: Get all the character available in the API as a list.

async get_gameseries(gameseries: str) → dict[source]¶

Get all the amiibo based on it’s game series as a list.

Parameters: gameseries (str) – The gameseries to request.

async get_gameseries_by_key(key: str) → dict[source]¶

It just return the game series that the key belongs to, since 1 key only belongs to 1 game series

Parameters: key (str) – The key that we need to get the data

async get_gameseries_keys(name: str) → dict[source]¶

It return a list of keys available for the game series

Parameters: name (str) – The gameseries name which we need to fetch the data.

async get_gameserieses() → dict[source]¶: Retrieve game series information, not all data return a list

async get_series(amiiboSeries: str) → dict[source]¶

Get all the amiibo based on it’s series as a list.

Parameters: amiiboSeries (str) – The series to get the data

async get_series_by_key(key: str) → dict[source]¶

Get the amiibo series by it’s key

Parameters: key (str) – The key that we need to get the data

async get_series_by_name(name: str) → dict[source]¶

Get the amiibo series by it’s name

Parameters: name (str) – The name that we need to get the data

async get_serieses() → dict[source]¶: Get all the amiibo’s series available in the API as a list.

async get_type(amiibo_type: str) → dict[source]¶

Get all the amiibo based on it’s type as a list.

Parameters: amiibo_type (str) – The amiibo type. Eg. 0x02, yarn

async get_type_by_id(type_id: str) → dict[source]¶

Get type by it’s id

Parameters: type_id (str) – The type id to get the data

async get_type_by_name(name: str) → dict[source]¶

Get type by it’s name

Parameters: name (str) – The name to get the data

async get_types() → dict[source]¶: Get all the amiibo’s type available in the API as a list

async last_updated() → dict[source]¶: Get the timestamp where the amiibo API was last updated.