Skip to content

corenting/ED-API

Repository files navigation

🌌 ED-API

The backend API for EDCompanion.

Handle tasks like autocomplete endpoints, proxying calls to external APIs etc.

Setup

What is needed:

  • An Inara API key for the community goals endpoint
  • An FCM server key if you want tosend community goals update as FCM push messages

See config.py for all the setting setup. The app use environs to load env variables.

How to use

The project is divided in 2 parts :

  • An API with FastAPI
  • A community goal command to ping the community goals endpoint periodically and send FCM notifications when the state change

Credits

  • EDCD for the FDevIDs repository used for commodities information
  • EDSM: provides the ships pictures and the API used to fetch the data for some endpoints
  • Inara: used to fetch the data for some endpoints
  • Spansh: used to fetch the data for some endpoints

Donations

If you wish to support the app, donations are possible here.

Contact

You can contact me on the EDCD Discord server (corenting#6836).

About

An API for Elite Dangerous

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages