AmiiboAPI Documentation

Information

AmiiboAPI is primarily used for educational purposes.

  • This is a reading-only API. Only HTTP GET method is allowed by this API.
  • No authentication is required to use this API. All resources are allowed to access.
  • If you are going to be calling this API regularly. We recommend that you use caching on your system.

Terms & Conditions

By using our API, you hereby accepted the following terms and conditions

This API has no affiliation with Nintendo or any other companies that own the rights to it.

Other reports collected by the respective companies that own the rights are not our responsibility.

User agrees that the use of this API is entirely at user’s own risks.

You will require your end users to comply with (and not knowingly enable them to violate) applicable law, regulation, and the Terms.

You will comply with all applicable law, regulation, and third party rights (including without limitation laws regarding the import or export of data or software, privacy, and local laws). You will not use the APIs to encourage or promote illegal activity or violation of third party rights.

These Terms and Conditions are subject to change without notice, from time to time in our sole discretion.

Amiibo

It returns information of all amiibos or specific amiibo as a list.

GET /api/amiibo/

Return a list of amiibo available in the API.

GET /api/amiibo/?name=value

Return the amiibo information base on it's name.

GET /api/amiibo/?id=value

Return the amiibo information base on it's id.

GET /api/amiibo/?name=value&type=value

Multiple filter is also possible.

E.g.
Head only: /api/amiibo/?head=01010000
Tail only: /api/amiibo/?tail=000e0002
Head + Tail: /api/amiibo/?id=01010000000e0002
{
    "amiibo": [
        {
            "amiiboSeries": "Legend Of Zelda",
            "character": "Zelda",
            "gameSeries": "The Legend of Zelda",
            "head": "01010000",
            "image": "https://raw.githubusercontent.com/N3evin/AmiiboAPI/master/images/icon_01010000-03520902.png",
            "name": "Toon Zelda - The Wind Waker",
            "release": {
                "au": "2016-12-03",
                "eu": "2016-12-02",
                "jp": "2016-12-01",
                "na": "2016-12-02"
            },
            "tail": "03520902",
            "type": "Figure"
        },
        {
            "amiiboSeries": "Super Smash Bros.",
            "character": "Zelda",
            "gameSeries": "The Legend of Zelda",
            "head": "01010000",
            "image": "https://raw.githubusercontent.com/N3evin/AmiiboAPI/master/images/icon_01010000-000e0002.png",
            "name": "Zelda",
            "release": {
                "au": "2014-12-12",
                "eu": "2014-12-19",
                "jp": "2014-12-06",
                "na": "2014-12-14"
            },
            "tail": "000e0002",
            "type": "Figure"
        },
        {
            "amiiboSeries": "Legend Of Zelda",
            "character": "Zelda",
            "gameSeries": "The Legend of Zelda",
            "head": "01010000",
            "image": "https://raw.githubusercontent.com/N3evin/AmiiboAPI/master/images/icon_01010000-03560902.png",
            "name": "Zelda",
            "release": {
                "au": "2017-03-03",
                "eu": "2017-03-03",
                "jp": "2017-03-03",
                "na": "2017-03-03"
            },
            "tail": "03560902",
            "type": "Figure"
        }
    ]
}
    

Amiibo


Name Description Data Type
amiiboSeries The series the amiibo belongs to. string
character The character of the amiibo, multiple character have different amiibo design. string
gameSeries The game series of the amiibo. string
head The 1st 8 value of the hexadecimal to recognize the amiibo.
Note: 0-7 value in the hexadecimal
string
image The image link of the amiibo. string
name The name of the amiibo. string
release The release date for North America, Japan, Europe and Australia
Date Format: yyyy-mm-dd
Warning: If date is not available, it will return as null
Note: If date is not available, it will return as null json
tail The next 8 value of the hexadecimal to recognize the amiibo.
Note: 8-15 value in the hexadecimal
string
type The type it belongs to. Example: card, figure and yarn string

Amiibo Type

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

GET /api/amiibo/?type=value

Note: value could be anything in the type database. E.g. /api/amiibo/?type=0x02 or /api/amiibo/?type=yarn

{
    "amiibo": [
        {
            "amiiboSeries": "Yoshi's Woolly World",
            "character": "Yoshi",
            "gameSeries": "Super Mario",
            "head": "00030102",
            "image": "https://raw.githubusercontent.com/N3evin/AmiiboAPI/master/images/icon_00030102-00410302.png",
            "name": "Green Yarn Yoshi",
            "release": {
                "au": "2015-06-25",
                "eu": "2015-06-26",
                "jp": "2015-07-16",
                "na": "2015-10-16"
            },
            "tail": "00410302",
            "type": "Yarn"
        },
    ...
]
}
    

Amiibo Type


Name Description Data Type
amiiboSeries The series the amiibo belongs to. string
character The character of the amiibo, multiple character have different amiibo design. string
gameSeries The game series of the amiibo. string
head The 1st 8 value of the hexadecimal to recognize the amiibo.
Note: 0-7 value in the hexadecimal
string
image The image link of the amiibo. string
name The name of the amiibo. string
release The release date for North America, Japan, Europe and Australia
Date Format: yyyy-mm-dd
Warning: If date is not available, it will return as null
Note: If date is not available, it will return as null json
tail The next 8 value of the hexadecimal to recognize the amiibo.
Note: 8-15 value in the hexadecimal
string
type The type it belongs to. Example: card, figure and yarn string

Amiibo Game Series

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

GET /api/amiibo/?gameseries=value

Note: value could be anything in the gameseries database. E.g. /api/amiibo/?gameseries=0x22c or /api/amiibo/?gameseries=Chibi Robo

{
    "amiibo": [
        {
            "amiiboSeries": "Chibi-Robo!",
            "character": "Chibi-Robo",
            "gameSeries": "Chibi Robo",
            "head": "22c00000",
            "image": "https://raw.githubusercontent.com/N3evin/AmiiboAPI/master/images/icon_22c00000-003a0202.png",
            "name": "Chibi Robo",
            "release": {
                "au": "2015-11-07",
                "eu": "2015-11-06",
                "jp": "2015-10-08",
                "na": "2015-10-09"
            },
            "tail": "003a0202",
            "type": "Figure"
        }
    ]
}
    

Amiibo Game Series


Name Description Data Type
amiiboSeries The series the amiibo belongs to. string
character The character of the amiibo, multiple character have different amiibo design. string
gameSeries The game series of the amiibo. string
head The 1st 8 value of the hexadecimal to recognize the amiibo.
Note: 0-7 value in the hexadecimal
string
image The image link of the amiibo. string
name The name of the amiibo. string
release The release date for North America, Japan, Europe and Australia
Date Format: yyyy-mm-dd
Warning: If date is not available, it will return as null
Note: If date is not available, it will return as null json
tail The next 8 value of the hexadecimal to recognize the amiibo.
Note: 8-15 value in the hexadecimal
string
type The type it belongs to. Example: card, figure and yarn string

Amiibo Series

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

GET /api/amiibo/?amiiboSeries=value

Note: value could be anything in the series database. E.g. /api/amiibo/?amiiboSeries=0x10 or /api/amiibo/?amiiboSeries=BoxBoy!

{
    "amiibo": [
        {
            "amiiboSeries": "BoxBoy!",
            "character": "Qbby",
            "gameSeries": "BoxBoy!",
            "head": "1f400000",
            "image": "https://raw.githubusercontent.com/N3evin/AmiiboAPI/master/images/icon_1f400000-035e1002.png",
            "name": "Qbby",
            "release": {
                "au": null,
                "eu": null,
                "jp": "2017-02-02",
                "na": null
            },
            "tail": "035e1002",
            "type": "Figure"
        }
    ]
}
    

Amiibo Series


Name Description Data Type
amiiboSeries The series the amiibo belongs to. string
character The character of the amiibo, multiple character have different amiibo design. string
gameSeries The game series of the amiibo. string
head The 1st 8 value of the hexadecimal to recognize the amiibo.
Note: 0-7 value in the hexadecimal
string
image The image link of the amiibo. string
name The name of the amiibo. string
release The release date for North America, Japan, Europe and Australia
Date Format: yyyy-mm-dd
Warning: If date is not available, it will return as null
Warning: If date is not available, it will return as null json
tail The next 8 value of the hexadecimal to recognize the amiibo.
Note: 8-15 value in the hexadecimal
string
type The type it belongs to. Example: card, figure and yarn string

Amiibo Character

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

GET /api/amiibo/?character=value

Note: value could be anything in the character database. E.g. /api/amiibo/?character=0x1996 or /api/amiibo/?character=Mewtwo

{
    "amiibo": [
        {
            "amiiboSeries": "Super Smash Bros.",
            "character": "Mewtwo",
            "gameSeries": "Pokemon",
            "head": "19960000",
            "image": "https://raw.githubusercontent.com/N3evin/AmiiboAPI/master/images/icon_19960000-023d0002.png",
            "name": "Mewtwo",
            "release": {
                "au": "2015-10-24",
                "eu": "2015-10-23",
                "jp": "2015-10-29",
                "na": "2015-11-13"
            },
            "tail": "023d0002",
            "type": "Figure"
        }
    ]
}
    

Amiibo Character

Name Description Data Type
amiiboSeries The series the amiibo belongs to. string
character The character of the amiibo, multiple character have different amiibo design. string
gameSeries The game series of the amiibo. string
head The 1st 8 value of the hexadecimal to recognize the amiibo.
Note: 0-7 value in the hexadecimal
string
image The image link of the amiibo. string
name The name of the amiibo. string
release The release date for North America, Japan, Europe and Australia
Date Format: yyyy-mm-dd
Warning: If date is not available, it will return as null
Warning: If date is not available, it will return as null json
tail The next 8 value of the hexadecimal to recognize the amiibo.
Note: 8-15 value in the hexadecimal
string
type The type it belongs to. Example: card, figure and yarn string

Type

Get all the amiibo's type available in the database as a list.

GET /api/type

{
    "amiibo": [
        {
            "key": "0x00",
            "name": "Figure"
        },
        {
            "key": "0x01",
            "name": "Card"
        },
        {
            "key": "0x02",
            "name": "Yarn"
        }
    ]
}
    

GET /api/type?key=value

Get type by it's id

E.g. /api/type?key=0x01

{
    "amiibo": {
        "key": "0x01",
        "name": "Card"
    }
}
    

GET /api/type?name=value

Get type by it's name

E.g. /api/type?name=card

{
    "amiibo": [
        {
            "key": "0x01",
            "name": "Card"
        }
    ]
}
    

Type

Name Description Data Type
key The key of the character. string
name Character name of the amiibo string

Game Series

Retrieve game series information. Warning: Not all data return a list, do read about it.

GET /api/gameseries

Get all the amiibo's game series available in the database as a list.

{
    "amiibo": [
        {
            "key": "0x000",
            "name": "Super Mario"
        },
        {
            "key": "0x008",
            "name": "Yoshi's Woolly World"
        },
        ...
    ]
}
    

Game Series

Name Description Data Type
key The key of the character. string
name Character name of the amiibo string

GET /api/gameseries?key=value

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

E.g. /api/gameseries?key=0x320

{
    "amiibo": {
        "key": "0x320",
        "name": "Sonic"
    }
}
    

GET /api/gameseries?name=value

It return a list of keys available for the game series.

E.g. /api/gameseries?name=pokemon

{
    "amiibo": [
        {
            "key": "0x1a4",
            "name": "Pokemon"
        },
        {
            "key": "0x190",
            "name": "Pokemon"
        },
        ...
    ]
}
    

Series

Get all the amiibo's series available in the database as a list.

GET /api/amiiboseries

{
    "amiibo": [
        {
            "key": "0x06",
            "name": "8-bit Mario"
        },
        {
            "key": "0x05",
            "name": "Animal Crossing"
        },
        ...
    ]
}
    

GET /api/amiiboseries?key=value

Get the amiibo series by it's key

E.g./api/amiiboseries?key=0x07

{
    "amiibo": {
        "key": "0x07",
        "name": "Skylanders"
    }
}
    

GET /api/amiiboseries?name=value

Get the amiibo series by it's name

E.g./api/amiiboseries?name=Skylanders

{
    "amiibo": [
        {
            "key": "0x07",
            "name": "Skylanders"
        }
    ]
}
    

Series

Name Description Data Type
key The key of the character. string
name Character name of the amiibo string

Character

Get all the character available in the database as a list.

GET /api/character

{
    "amiibo": [
        {
            "key": "0x0233",
            "name": "Admiral"
        },
        {
            "key": "0x04e2",
            "name": "Agent S"
        },
        ...
    ]
}
    

GET /api/character?key=value

Get the character by it's key

E.g. /api/character?key=0x1996

{
    "amiibo": {
        "key": "0x1996",
        "name": "Mewtwo"
    }
}
    

GET /api/character?name=value

Get the character by it's name

E.g. /api/character?name=mewtwo

{
    "amiibo": [
        {
            "key": "0x1996",
            "name": "Mewtwo"
        }
    ]
}
    

Character

Name Description Data Type
key The key of the character. string
name Character name of the amiibo string