https://github.com/dofusdude/almanax-api
Fully multilingual Almanax API for the Ankama Krosmoz.
https://github.com/dofusdude/almanax-api
almanach almanax ankama api dofus dofus-almanax krosmoz
Last synced: 6 months ago
JSON representation
Fully multilingual Almanax API for the Ankama Krosmoz.
- Host: GitHub
- URL: https://github.com/dofusdude/almanax-api
- Owner: dofusdude
- License: apache-2.0
- Created: 2021-04-24T22:46:36.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-03T19:23:16.000Z (over 1 year ago)
- Last Synced: 2024-12-03T19:37:31.325Z (over 1 year ago)
- Topics: almanach, almanax, ankama, api, dofus, dofus-almanax, krosmoz
- Language: Java
- Homepage: https://docs.dofusdu.de/#/almanax
- Size: 314 KB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# :calendar: Almanax API
[](https://github.com/dofusdude/almanax-api/actions/workflows/maven.yml)
A multilingual API for the Krosmoz Dofus Almanax with a few extras.
The main features are
- get by date :date:
- combining all info about the needed offering item :bookmark: (with higher res images)
- getting date spans up to a month
- filter a date span by bonus
- getting the next date for a specific bonus
- all time relative APIs support timezones :clock1: (default Europe/Paris)
- everything above (including language agnostic links) in english :uk:, french :fr:, italian :it:, spanish :es: and german :de:
Depends on the [Dofus API](https://docs.dofusdu.de) for the items.
## Usage
See the OpenAPI or SwaggerUI endpoint for types and examples:
- https://alm.dofusdu.de/swagger
- https://alm.dofusdu.de/openapi
## Running on your machine
```shell script
docker-compose up -d
./mvnw compile quarkus:dev
```
If that does not work (maybe because you are on Windows), download Maven for yourself and enter `mvn quarkus:dev` in the
project directory.
Note: The API is build on Quarkus. https://quarkus.io for more.
## Awesome projects using the API
- [AlmanaxApp](https://almanaxapp.netlify.app) by Lystina
- [KaellyBot](https://github.com/Kaysoro/KaellyBot) by Kaysoro
## License
Author: Christopher Sieh
This project is licensed under the Apache-2.0 License.