Types of keys
This project is dependent on a number of APIs to aquire information. The APIs are mostly free but somewhat limited. Read more about that below. We now supports using either native SL api for Stockholm, but also Resrobot for the rest of the country (and Stockholm).
If you are in Stockholm I recond using SL as it has more features, however Resrobot also provides intra-regional travel.
Apply for free API keys (Resrobot)
First, visit https://www.trafiklab.se/api and create a free account.
They provide multiple APIs, the ones you want is
When you have your API keys, you’re ready to add the component to your Home Assistant either via HACS or manual.
Apply for free API keys (SL)
This project is dependent on a number of APIs to aquire information. The APIs are mostly free but somewhat limited. Read more about that below.
First, visit https://www.trafiklab.se/api and create a free account.
They provide multiple APIs, the ones you want is
Optionally you can also register for
- “SL Trafikläget 2” to get status sensors.
- “SL Reseplanerare 3.1” to use trip planning.
- “SL Platsuppslag” to lookup location ids
When you have your API keys, you’re ready to add the component to your Home Assistant either via HACS or manual.
API-call restrictions and optimizations
The Bronze level API is limited to 30 API calls per minute, 10.000 per month. With 10.000 calls per month for SL and 25.000 for ResRobot, that allows for less than one call every 4 minute but if you are using multiple sensors this is split between them and each config sensor section can contain a separate pair of api-keys.
The calls have been optimized and are beeing locally cached for the specified freshness, if multiple sensors are using the same siteid there will still only be one call. Caching is done in a file (haslcache.json) that will be automatically created in the configuration directory.
You can also specify a binary_sensor that perhaps is turned of when no-one is at home or similar to reduce the number of calls. Optimizations can be turned of if needed in very specific situation or if you have a high level API-key.