Skip to content

gusperandio/natureatoz

Repository files navigation


Logo

Nature A to Z

Empowering users with comprehensive insights, our API serves as the ultimate guide to the wonders of nature and the environment, offering seamless access to information from A to Z.
Explore the docs »

Report Bug · Request Feature

About the Project

Welcome to the Nature and Environment API, your comprehensive dictionary-like resource providing information on all aspects of nature and the environment from A to Z.

Overview

The Nature and Environment API is designed to serve as a versatile tool for accessing a wealth of information about various elements of the natural world. Whether you're a researcher, educator, or simply curious about the environment around you, this API offers a vast repository of data conveniently organized from A to Z.

  • Comprehensive Data: From animals to plants, ecosystems to geological formations, our API covers a wide range of topics related to nature and the environment.
  • Easy Access: With straightforward endpoints and intuitive queries, accessing detailed information about specific subjects is quick and effortless.
  • Up-to-Date Content: Our database is regularly updated to ensure that you receive the latest and most accurate information available.
  • Educational Resource: Ideal for educational purposes, the API provides valuable insights into the intricacies of the natural world, making learning both engaging and accessible.

(back to top)

Built With

  • Next
  • React

(back to top)

Usage

Return the status of API ⚡

  /api/v1
Method Parameter Type Description Code
OPTIONS NULL NULL Just check STATUS API 202 ✔️

TOKEN Authorization 📋

  /api/v1/auth - /api/v1/auth?days=120
Method Parameter Type Descrição Code
GET days string Get the token with limite between 30 and 120 days 200 ✔️

Search random 📋

   /api/v1/random
Method Header Parameter Type Descrição Code
GET Bearer token - JWT NULL NULL Search a random item 200 ✔️

Search random with IMG 📋

   /api/v1/random/image
Method Header Parameter Type Descrição Code
GET Bearer token - JWT NULL NULL Search a random item with one image 200 ✔️

Search complete list about specific letter 📋

   /api/v1/dictionary/{x}
Method Header Parameter Type Descrição Code
GET Bearer token - JWT Letter string Retrieve all items based on the letter 200 ✔️

Search specific item with base on title 📋

   /api/v1/search/{title}
Method Header Parameter Type Descrição Code
GET Bearer token - JWT Title string Search the item with the name exactly or most closely similar possible 200 ✔️

For more examples, please refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/YourFeature)
  3. Commit your Changes (git commit -m 'Add some YourFeature')
  4. Push to the Branch (git push origin feature/YourFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the Apache License 2.0. See LICENSE.txt for more information. Apache License 2.0

(back to top)

Contact

Gustavo Sperandio - My Twitter - X - [email protected]

(back to top)