Skip to content

firstof9/ha-gasbuddy

Repository files navigation

GasBuddy

GitHub Release GitHub Activity License

hacs Project Maintenance BuyMeCoffee

Discord Community Forum

Component to integrate with GasBuddy fuel price tracker.

This component will set up the following platforms.

Platform Description
sensor Show info from an GasBuddy listed station.

Installation via HACS (recommended)

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

  1. Follow the link here
  2. Use the custom repo link https://github.com/firstof9/ha-gasbuddy
  3. Select the category type integration
  4. Then once it's there (still in HACS) click the INSTALL button
  5. Restart Home Assistant
  6. Once restarted, in the HA UI go to Configuration (the ⚙️ in the lower left) -> Devices and Services click + Add Integration and search for GasBuddy

Manual (non-HACS)

Instructions
You probably do not want to do this! Use the HACS method above unless you know what you are doing and have a good reason as to why you are installing manually
  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called gasbuddy.
  4. Download all the files from the custom_components/gasbuddy/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. Once restarted, in the HA UI go to Configuration (the ⚙️ in the lower left) -> Devices and Services click + Add Integration and search for GasBuddy

Remedying Connection/timeout issues with FlareSolverr (Optional)

Since May 2025, GasBuddy implemented Cloudflare which may lead to blocking of requests to GasBuddy, and cause timeout and log errors. This would lead to the occasional missed data update to obtain the lastest gas prices, along with log errrors.

To circumvent this, FlareSolverr can be used to bypass Cloudflare protection. FlareSolverr can be installed as a standalone docker container on your network here or as an addon in Home Assistant here. Once your FlareSolverr instance is up and running, you can re-configure your existing GasBuddy entries by clicking the 3 dots of EACH gas station entry, and entering your FlareSolverr URL, ie. http://ip:port/v1

image

Future changes to your FlareSolverr instance can be edited the same way.

Configuration is done in the UI

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines


TODO

  • Add tests

About

Component to integrate with GasBuddy fuel price tracker.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  

Contributors 8

Languages