ProtonVPN-server-load

Script to print out all servers under the desired maximum load, sorted by load from highest to lowest.

Uses the ProtonVPN API https://vpn-api.proton.me/vpn/logicals

Script was cloned from https://github.com/akazukin5151/ProtonVPN-server-load

Note: Currently script is only able to get Tier 2 (premium) servers. I am trying to find the API for Tiers 0 & 1.
Note: Currently num_results is not implemented. It will take minimal work to get it working.

Github notice:

My github account https://github.com/mooleshacat/ is flagged and I can't do anything with my organization https://github.com/catspeed-cc/ either. This is affecting my ability to create forks and update code on github. I am still able to work on my Gitea, but github will not allow me to do anything until my account is unflagged. I am in contact with GitHub regarding this issue, but they have not yet responded 48 hours later. Unfortunately it may take a month for a response.

I suspect this is either

• automated system made a false positive (others had this issue)
• malicious, false account report made to shut my github account down (perhaps someone has a grudge)

Features:

• Fetch Tier 2 servers from ProtonAPI
• Command line arguments (coming soon)
• API response caching (coming soon)
• Generate gluetun servers.json file (coming soon)
• Generate wg/ovpn configuration files (coming soon)
• Outputs server name, hostname, country, state/province, city, load, tier, entry/exit ip, lat/long, pubkey, features

Requirements:

• Python version 3.5+ (Debian 12 comes with 3.11.2)
  • python3-requests (apt package) or requests (pip package)
  • python3-pycountry (apt package) or pycountry (pip package)

Installation:

Installation via APT (recommended):

• install packages apt install python3 python3-full python3-requests python3-pycountry
• check python version >= 3.5 python3 --version
• clone this repository git clone https://gitea.catspeed.cc/catspeed-cc/ProtonVPN-server-load
• change to repository directory cd ProtonVPN-server-load
• run script python3 vpn_servers_list.py

Installation via virtualenv:

• install packages apt install python3 python3-full
• clone this repository git clone https://gitea.catspeed.cc/catspeed-cc/ProtonVPN-server-load
• change to repository directory cd ProtonVPN-server-load
• create virtual environment virtualenv venv
• activate virtual environment source venv/bin/activate
• install dependencies pip install -r requirements.txt
• run script python3 vpn_servers_list.py
• deactivate virtual environment deactivate

Note: when using virtual environment it must be activated before running script

Usage:

in bash: you will need to modify vpn_servers_list.py to get desired servers, then run the command:

python3 vpn_servers_list.py
>>> Server[33]: US-NJ#9 Hostname: node-us-31.protonvpn.net City: Secaucus Load: 40% Tier: 2 secure_core: True netshield: True port_forward: True
>>> Server[34]: US-NJ#10 Hostname: node-us-31.protonvpn.net City: Secaucus Load: 40% Tier: 2 secure_core: True netshield: True port_forward: True
>>> Server[664]: US-CA#197 Hostname: node-us-168.protonvpn.net City: Los Angeles Load: 40% Tier: 2 streaming: True port_forward: True
>>> Server[1263]: US-CA#321 Hostname: node-us-212.protonvpn.net City: Los Angeles Load: 40% Tier: 2 streaming: True port_forward: True

OR

in python:

import vpn_servers as vpns

print("US-CA# servers:")
vpns.find_a_server(country_code = "US", state_code = "CA", max_load = 40, num_results = 5)
>>> US-CA# servers:
>>> Server[1276]: US-CA#310 Hostname: node-us-211.protonvpn.net City: Los Angeles Load: 34% Tier: 2 streaming: True port_forward: True
>>> Server[1275]: US-CA#309 Hostname: node-us-211.protonvpn.net City: Los Angeles Load: 33% Tier: 2 streaming: True port_forward: True
>>> Server[1278]: US-CA#312 Hostname: node-us-211.protonvpn.net City: Los Angeles Load: 33% Tier: 2 streaming: True port_forward: True
>>> Server[1279]: US-CA#313 Hostname: node-us-211.protonvpn.net City: Los Angeles Load: 33% Tier: 2 streaming: True port_forward: True

print("US-xx# servers:")
vpns.find_a_server(country_code = "US", state_code = "", max_load = 40, num_results = 5)
>>> US-xx# servers:
>>> Server[1369]: US-UT#51 Hostname: node-us-226.protonvpn.net City: Salt Lake City Load: 33% Tier: 2 secure_core: True netshield: True port_forward: True
>>> Server[525]: US-UT#37 Hostname: node-us-158.protonvpn.net City: Salt Lake City Load: 15% Tier: 2 streaming: True
>>> Server[526]: US-UT#39 Hostname: node-us-158.protonvpn.net City: Salt Lake City Load: 13% Tier: 2 streaming: True
>>> Server[527]: US-UT#40 Hostname: node-us-158.protonvpn.net City: Salt Lake City Load: 11% Tier: 2 streaming: True

print("CA# servers:")
vpns.find_a_server(country_code = "CA", state_code = "", max_load = 40, num_results = 5)
>>> CA# servers:
>>> Server[3119]: CA#488 Hostname: node-ca-33.protonvpn.net City: Vancouver Load: 40% Tier: 2 secure_core: True netshield: True streaming: True
>>> Server[3121]: CA#490 Hostname: node-ca-33.protonvpn.net City: Vancouver Load: 40% Tier: 2 secure_core: True netshield: True streaming: True
>>> Server[3122]: CA#491 Hostname: node-ca-33.protonvpn.net City: Vancouver Load: 40% Tier: 2 secure_core: True netshield: True streaming: True
>>> Server[3127]: CA#496 Hostname: node-ca-33.protonvpn.net City: Vancouver Load: 40% Tier: 2 secure_core: True netshield: True streaming: True

Country codes:

You can get the country codes from:

• https://en.wikipedia.org/wiki/ISO_3166-1

You can get state/province codes from:

• https://en.wikipedia.org/wiki/ISO_3166-2:US
• https://en.wikipedia.org/wiki/ISO_3166-2:CA
• you can change the country code on the end of the URL to get others

Troubleshooting:

• If you get too many results, lower max_load.
• If you get too few or zero results, increase max_load
• If there are still issues, ensure that you are using the correct two letter country_code (or state_code)
• Check you can access the API and it is not blocked https://vpn-api.proton.me/vpn/logicals
• If nothing above works, please post a ticket https://gitea.catspeed.cc/catspeed-cc/ProtonVPN-server-load/issues