|
2 | 2 | [![License][license-shield]](LICENSE)
|
3 | 3 | ![Project Maintenance][maintenance-shield]
|
4 | 4 |
|
5 |
| -# Instagram followers Integration for Home Assistant |
| 5 | +# Instagram followers counter Integration for Home Assistant |
| 6 | +This integration adds a sensor that retrieves the number of Instagram followers for a specified user. |
6 | 7 |
|
| 8 | +## 🛠️ Installation |
7 | 9 |
|
8 |
| -_Integration to integrate with [integration_blueprint][integration_blueprint]._ |
| 10 | +1.Add this repository to your HACS with the following button: |
9 | 11 |
|
10 |
| -**This integration will set up the following platforms.** |
| 12 | +[](https://my.home-assistant.io/redirect/hacs_repository/?owner=xamrex&repository=Hacs_Insta_follower&category=integration) |
11 | 13 |
|
12 |
| -Platform | Description |
13 |
| --- | -- |
14 |
| -`sensor` | Show how many subscribers given instagram user has. |
| 14 | +2.Install this integration with the follwing button: |
15 | 15 |
|
16 |
| -## Installation |
| 16 | +[](https://my.home-assistant.io/redirect/config_flow_start/?domain=insta_follower) |
17 | 17 |
|
18 |
| -1. Add this repository URL as a custom repository in HACS |
19 |
| -2. Restart Home Assistant |
20 |
| -3. In the HA UI go to "Settings" -> "Devices & services" click "+ ADD INTEGRATION" and search for "Insta Follower"* |
| 18 | +3.Enter Instagram Account name and Token and press Submit. |
| 19 | + |
21 | 20 |
|
22 |
| -## Configuration is done in the UI |
| 21 | +## ❓How to get token |
| 22 | +1. To get token you need to create an account on https://rapidapi.com/, |
| 23 | +2. Search for instagram scraper api https://rapidapi.com/social-api1-instagram/api/instagram-scraper-api2 and press Subscribe for Basic |
| 24 | + |
| 25 | +3. **Token** is your **x-rapidapi-key** |
| 26 | + |
23 | 27 |
|
24 |
| -<!----> |
| 28 | +## 🤷♂️ How it works? |
| 29 | +1. Every 6 hours there is an API call to get instagram followers counter. |
| 30 | +2. There is a **500** API Calls limit per month |
25 | 31 |
|
| 32 | +## 🎯 Results |
| 33 | + |
26 | 34 |
|
27 | 35 |
|
28 |
| -*** |
29 |
| - |
30 | 36 | [integration_blueprint]: https://github.com/ludeeus/integration_blueprint
|
31 | 37 | [license-shield]: https://img.shields.io/github/license/ludeeus/integration_blueprint.svg?style=for-the-badge
|
32 | 38 | [maintenance-shield]: https://img.shields.io/badge/maintainer-xamrex-blue.svg?style=for-the-badge
|
| 39 | + |
| 40 | + |
| 41 | +## 🤝 Contributing |
| 42 | + |
| 43 | +You can contribute by creating a PR, but also by testing: |
| 44 | + |
| 45 | +- Provide general feedback or report issues. |
| 46 | + |
| 47 | +## 🛟 Need help? |
| 48 | + |
| 49 | +If you have a feature request or encounter a problem, feel free to open an issue! Have a general question, need help setting up then go to the discussions. |
0 commit comments