From ecc1253cf40cc635682b02b61d56439906ca3dd1 Mon Sep 17 00:00:00 2001 From: Dragoon Aethis Date: Sun, 12 Jun 2022 14:34:03 +0200 Subject: [PATCH] Created API Keys (markdown) --- API-Keys.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 API-Keys.md diff --git a/API-Keys.md b/API-Keys.md new file mode 100644 index 0000000..ff8d7d3 --- /dev/null +++ b/API-Keys.md @@ -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`.