Created API Keys (markdown)

Dragoon Aethis 2022-06-12 14:34:03 +02:00
parent 50db1fd0c5
commit ecc1253cf4

6
API-Keys.md Normal file

@ -0,0 +1,6 @@
To download games, itch-dl uses a mix of webpage scraping and calling official itch APIs - for the latter to work, a valid API key is required to authenticate requests. **Each key is roughly equivalent to full access to a single Itch account - do not share them with other people!**
- You can create or look up existing API keys [on itch.io](https://itch.io/user/settings/api-keys).
- Only `web` keys can be used by itch-dl - do not use existing `desktop` or `wharf` keys.
- You can save your key as `api_key` in the [configuration file](https://github.com/DragoonAethis/itch-dl/wiki/Configuration-Files) for easy access.
- You can also provide it with the `--api-key` argument to `itch-dl`.