OSRS Hiscore tool

Requirements

• Python 3.12.x or greater Download here (3.11.x might be fine but not sure, change setup file if you run 3.11.x)
• Certain py packages, run the command at Get started.

Get started

pip install -r requirements.txt .
pip install -r requirements.txt -e . # editable mode if u plan on modifying package
# or
python -m pip install -r requirements.txt .
python -m pip install -r requirements.txt -e . # editable mode if u plan on modifying package

Main Features

• Filter usernames based on skills/bossing achievements and save that resultset to a file.
• Analyse a highscore category by creating some statistics like mean, median, min, max, quartiles and population/sample data.
• Fetch hiscore category pages and save the player names to a file.

Misc Features

• Fetch an individual's stats from OSRS hiscores.
• Fetch maximum page of a hiscore category.
• Check if proxies are valid.

Note

Use apostrophes (single quotes) or double quotes (depending on what shell u use) when you have an argument value that contains a space. Look at Filter Codeblock for an example.

Usage

filter_category.py

Scrape hiscore pages while filtering accounts based on category information (combat, skill levels, boss kc, etc.), filtered player data gets saved to an output file.

py .\scripts\filter_category.py --out-file output.txt --filter 'ranged=50,attack<50'
py .\scripts\filter_category.py --out-file output.txt --filter 'ranged>50 , attack>=50'
py .\scripts\filter_category.py --out-file output.txt --filter 'ranged<=50, attack=50' 

Argument	Required	Description
--out-file	Yes	Path to the output file
--in-file	No	Path to the input file, reads from highscores if this argument is missing
--proxy-file	No	Path to the proxy file
--rank-start	No	Rank number that it should start filtering at (default: 1)
--account-type	No	Account type it should look at (default: 'regular')
--hs-type	No	Hiscore category it should pull from (default: 'overall')
--filter	Yes	Custom filter on what the accounts should have
--num-workers	No	Number of concurrent scraping threads (default: 15)

analyse_category.py

Aggregate hiscore data; saves total count, total kc/xp, first rank, and last rank, aggregated data gets saved to an output file.

py .\scripts\analyse_category.py --out-file output.txt --hs-type zuk --account-type hc

Argument	Required	Description
--out-file	Yes	Path to the output file
--proxy-file	No	Path to the proxy file
--hs-type	Yes	Hiscore category it should pull from
--account-type	Yes	Account type it should pull from

fetch_pages.py

Scrape hiscore category pages, scraped names and scores gets saved to an output file.

py .\scripts\fetch_pages.py --out-file output.txt --account-type pure --hs-type zuk

Argument	Required	Description
--out-file	Yes	Path to the output file
--proxy-file	No	Path to the proxy file
--account-type	No	Account type it should pull from (default: 'regular')
--hs-type	No	Hiscore category it should pull from (default: 'overall')
--rank-start	No	Hiscore rank number it should start at (default: 1)
--rank-end	No	Hiscore rank number it should end at (default: end of category)
--num-workers	No	Number of concurrent scraping threads (default: 15)

fetch_user.py

Account hiscore lookup script, result gets printed on console.

py .\scripts\fetch_user.py --name Cow1337Killer

Argument	Required	Description
--name	Yes	Name you want to lookup
--account-type	No	Account type it should pull from (default: 'regular')
--hs-type	No	Filter on specific hiscore category

fetch_max_page.py

Find the max page and rank of a category, result gets printed on console.

py .\scripts\fetch_max_page.py --account-type hc --hs-type zuk

Argument	Required	Description
--account-type	Yes	Account type it should scout
--hs-type	Yes	Highscore Category it should scout

check_proxies.py

Proxy checker script, valid ones are written away and formatted as http://user:password@ip:port.

py .\scripts\check_proxies.py --proxy-file proxy_file.txt

Argument	Required	Description
--proxy-file	Yes	Path to the proxy file

Logging

Several log messages and progressbar is used to report progress.