Factoriodex

Factoriodex is a streamlined API delivering essential data on Factorio items, enemies, and research, powered by Node.js and MongoDB for developers and gamers.


Live Site · Report Bug · Request Feature

Disclaimer

Factoriodex is not affiliated with or endorsed by Factorio or its creators.

About The Project

Factoriodex is a curated API by Eric Lighthall, offering detailed Factorio data on items, enemies, and research. It is crafted with Node.js and MongoDB is hosted using Railway. Accompanying the API is a static site documenting its use, built with vanilla HTML and CSS for clarity and ease of access.

Built With

• 
• 
• 
• 
• 
• 

Getting Started

Factoriodex can be found on https://factoriodex-production.up.railway.app.

Factoriodex fully supports CORS so no API keys are needed. You can start using factoriodex right away on your own projects!

Usage

The base URL for the API can be accessed with https://factoriodex-production.up.railway.app/. To make a valid request, you need to append an endpoint to the base URL and include query parameters as needed.

The following endpoints are accessible

GET https://factoriodex-production.up.railway.app/api/enemies

GET https://factoriodex-production.up.railway.app/api/items

GET https://factoriodex-production.up.railway.app/api/research

Example Request

// Javascript
fetch('/api/items?name=armor&type=combat')
 .then(response => response.json())
 .then(data => console.log(data))
 .catch(error => console.error(error));

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".

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

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

@EricLighthall - [email protected] - ericlighthall.com

https://github.com/Eric-Lighthall/factoriodex

back to top