Skip to content
This repository has been archived by the owner on May 28, 2021. It is now read-only.

villChurch/AnimalCrossingNewHorizonAPI

Repository files navigation

DepShield Badge GitHub issues GitHub forks Run Tests

AnimalCrossingNewHorizonAPI

A free to use Animal Crossing New Horizon API that can be found here. The API has endpoints for most in game items such as Villagers, Insects, Sea Creatures etc. There is no authentication needed for the API and no plans to add any or change it from being free to use. If you find any information to be wrong or would like additional information adding create an issue or message me on Discord (VillChurch#2599).

Usage

All data is returned as either JSON or a String and is licensed under MIT. Strings are typically used to display error messages on 404's for example if a villager can't be found. Full documentation in Swagger form can be found here and can also be found in JSON format here.

Built With

  • Spring Boot - Java framework
  • Maven - Dependency Management
  • MySQL - DB holding the information
  • Docker - Used for building the environment with database etc and deploying

Contributing

If you would like to contribute then feel free to get in touch on discord (VillChurch#2599) so we can figure out a good starting point and help you get setup.

Versioning

We use SemVer for versioning. For the released and upcomming versions, see the tags on this repository.

Authors

  • Will (VillChurch#2599) - Main API work - Will

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

  • ACNH Spreadsheet - providing most if not all of the data available
  • ACNH Spreadsheet Discord server - providing various extra resources.

Disclaimer

This API is a fan made API/Website and claims no ownership of any intellectual property associated with Nintendo or Animal Crossing.