alexislours / acnhapi Goto Github PK

View Code? Open in Web Editor NEW

224.0 12.0 70.0 359.2 MB

Data in JSON format from https://acnhapi.com

License: MIT License

animal-crossing api animal-crossing-new-horizons

acnhapi's Introduction

ACNH API

Updated for 1.8.0 (Mario Update)

Introduction:

ACNH API is a free RESTful API for furniture, critters, fossils, art, music and villagers from Animal Crossing: New Horizons.

This started for me as a little side project for me but ended up getting much attraction than I ever thought it would get (~3 000 000 requests per day).

The API is free and without authentification to make it easy for anyone to start developing on a subject they like.

If any of the information on the website is wrong or outdated, you can either contact me on Discord (Alexis#8717) or make a pull request on this repository.

Buy me a coffee or donate directly through PayPal and help contribute toward the server costs to keep this service free!

Changelog:

See CHANGELOG.MD.

Usage:

All the JSON data from this API is under CC BY 4.0 license, the images and music assets are the sole property of Nintendo.

The data can be obtained as an object array instead of a nested JSON by doing requests on https://acnhapi.com/v1a/ instead of https://acnhapi.com/v1/.

The documentation for the API can be found here.

No authentification is required to make requests to any of the endpoints which can be accessed over HTTP or HTTPS.

Projects using this data:

Critterpedia Plus
AC Helper (app)
AC Helper (source)
AC: Community (Japanese, Korean)
ACNH Travel Guide (Translation Sheet Data & ACNH API)
Nook Plaza (Translation Sheet Data & Weather Sheet)

Other projects that can help you build your app:

ACNH Item Sheet
ACNH Translation Sheet (also maintained by me).
ACNH Weather Sheet (also datamined and maintained by me).
ACNH Wedding Items Price Sheet (also datamined and maintained by me).
Google Sheets to JSON (converts the item spreadsheet to JSON format).
Translations Sheet to JSON (converts the translation spreadsheet to JSON format).

Special thanks:

For keeping the project free and available to all:

Disclaimer:

ACNH API is a fan made API/Website and claims no ownership of any intellectual property associated with Nintendo or Animal Crossing. All assets found on the site and the repository are the sole property of Nintendo and are only used for non-commercial and educational purpose.

Contact: [email protected]

acnhapi's People

Contributors

Stargazers

Watchers

acnhapi's Issues

Use ISO 8601 date format for villagers birthday

To help avoid confusion with date formats, I recommend either switching the birthday field to using the ISO 8601 date format YYYY-MM-DD, or creating a new field like birthday-iso8601

While I don't believe birthday year is part of the data, perhaps it would a fun side project to determine birth year based on the release date of the game the villager first appears in. In the absence of a birthday year, you can use XXXX

For example, Annalisa's birthday would be XXXX-02-06 to help recognize that it's February 6th, not June 2nd (without needing to parse the birthday-string field).

Looking at https://animalcrossing.fandom.com/wiki/Annalisa, it appears Annalisa was a new character in New Leaf, which has an original release date of November 8th, 2012 (in Japan), which would make her birth year 2012, and her full birthday 2012-02-06.

image_uri for some fossils don't work

There are some fossils of which the image_uri does not work.

To be specific:

Inconsistency with fish shadow sizes

There seems to be an inconsistency with fish shadow sizes.
I'm assuming there are 6 size differences but "Medium (4)" and "Large (4)" appear in the list.

Example
Soft shelled turtle is "Medium (4)"
Koi is "Large (4)"

Is there a difference?

Spider is missing a location in bugs.json

The spider has an empty string for location in the availability object. It behaves the same as the Bagworm so I believe it should be "Shaking trees".

Question: Do you have any reference to a list of items required for a craftable item

Hi,

I've been working with this API with great pleasure, and have another question. I noticed that there isn't an 'ingredient list' for craftable items. Do you know of any way to include this? Or do you perhaps have another resource i could utilize to fetch that data?

Kind Regards!

SSL certificate expired

Hey, thank you for creating such a wonderful API!

The API's SSL certificate expired and was wondering when it will be renewed?

Thank you!

Use more standard language tags for item names

Currently, names use what seem to be a propietary standard (name-EUen, name-USen, etc.).

It'd be worth considering changing them into a more standard format, for example: 'name-en-US' or 'name-en-GB'.

This would make it easier to work with most language libraries that conform with BCP47. In HTML, a non-conforming attribute results in 'invalid' being used instead.

Of course, this can be solved on an app level but it'd be ideal if we could get it directly from the API.

This change will be breaking unless we maintain both versions of the language tag.

missing sanrio villagers

the api is missing the sanrio villagers

Images are spaced around inconsistently (for fish anyways)

Hi,

First of all, thanks for making this API publicly available!

I have a problem with the spacing around the images of the animal.
Is it at all possible to either:

Trim the images so the spacing isn't an issue when sizing the image
As an alternative, at least centering the animal properly. The crucian carp for example isn't centered, so centering in a layout is impossible.

Any help or advice would be greatly appreciated!

Villager Color / Style preferences?

I'm not seeing this data in villagers.json. Is it somewhere else?

Certificate has expired

Hi!

The API is not working for HTTPS because the certificate on the page has expired (see screenshot).

Is this still maintained?

I notice that the last commit was almost a year ago...

Is this project still being maintained? or is it simply considered complete?

Search Parameters Question

I am new to this API and was curious if there are query parameters for searching (ex: Bugs where price is 160 (/bugs?price=160). Is this something that I'm not seeing in the docs or not implemented? I definitely think this would be beneficial so the responses would only contain certain items you want.

Certificates have expired

Hi, I thought I'd let you know that the SSL certificates have expired which means users of the https endpoint are possibly seeing issues.

Names property as country code

Isn't it better to use ISO 3166 country codes for name properties?
I'm using an earlier revision and villagers Spanish name were "name-es" there. I found it better this way, because it's official ISO 3166 country code for Spain.
https://en.wikipedia.org/wiki/ISO_3166-1

Greets
Alex

Any plans for an update for 2.0?

Villager ImageUri error on id:1

https://github.com/alexislours/ACNHAPI/blob/master/v1a/villagers.json#L28 should be https://acnhapi.com/v1/images/villagers/1