{"id":18032713,"url":"https://github.com/sanderdlm/rue","last_synced_at":"2025-03-27T05:31:16.618Z","repository":{"id":134051160,"uuid":"75329550","full_name":"sanderdlm/rue","owner":"sanderdlm","description":"PHP library for all of Runescape's web services","archived":false,"fork":false,"pushed_at":"2022-03-04T08:48:58.000Z","size":29,"stargazers_count":10,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-20T15:34:25.889Z","etag":null,"topics":["api","character","php","rue","runescape","skills"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sanderdlm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-01T20:22:13.000Z","updated_at":"2024-09-04T16:54:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"e95ce70b-0ab2-4398-8abf-82f08e9c9e01","html_url":"https://github.com/sanderdlm/rue","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanderdlm%2Frue","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanderdlm%2Frue/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanderdlm%2Frue/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanderdlm%2Frue/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sanderdlm","download_url":"https://codeload.github.com/sanderdlm/rue/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245791450,"owners_count":20672665,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","character","php","rue","runescape","skills"],"created_at":"2024-10-30T10:15:35.203Z","updated_at":"2025-03-27T05:31:16.612Z","avatar_url":"https://github.com/sanderdlm.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"2022 edit: There is a newer library called [Flo](https://github.com/dreadnip/flo/blob/master/src/Flo.php) that uses Symfony HttpClient, which should be more stable than this one. I don't think I ported all of the features though, but you should still use it over this old piece of junk.\r\n\r\n# Rue\r\nRue is a PHP library that attempts to be an easy-to-use wrapper for all of the possible Runescape web service endpoints. It aims to combine the older API, the new Runemetrics URLs and a few other endpoints that can be found on runescape.com. \r\n\r\nThe class also has a multi_curl wrapper built in. This makes it easy to take single player functions, like grabbing a player's experience in a certain skill, and apply them to an entire clan. A situation where this might come in handy is automating a clan's skilling competition.\r\n\r\nRue can also simulate web logins to runescape.com and use the generated session token as a cookie to get more data from certain endpoints. By doing this you can get data like player online status and current world.\r\n\r\n#### License\r\nMIT\r\n\r\n#### Version\r\n1.0.0\r\n\r\nfor PHP 5.4+\r\n\r\n## How to Use\r\n\r\nTo get access to the basic functionality, simply include and initialize the class.\r\n\r\n```php\r\nrequire_once 'rue.php';\r\n$r = new \\Rue\\rs_api();\r\n```\r\nThat's it.\r\n\r\n## Options\r\n\r\nIf you want to use data like player online status and current world, make a new account **AND** create a character on that account. Once the character exists, enter it's details like this.\r\n\r\n```php\r\nrequire_once 'rue.php';\r\n\r\n$r = new \\Rue\\rs_api();\r\n\r\n//Setting a pug or alt account allows the class to generate session tokens. \r\n$r-\u003eset_pug(\"pugemail@gmail.com\", \"pugpassword\", \"pugname\");\r\n```\r\n## Examples\r\n\r\nHere are a few basic examples. I've also included them as PHP files in the repo.\r\n```php\r\n//Get the last 20 activity logs for a player\r\n$player_activity = $r-\u003eget_player_activity(\"Zezima\");\r\n\r\n//Get a player's skill levels and experience\r\n$player_skills = $r-\u003eget_player_skills(\"Omid\");\r\n\r\n//Get a list of all clan members, with rank and clan exp per member\r\n$list = $r-\u003eget_clan_list(\"Wrack City\");\r\n\r\n//Get the last 20 activity logs for everyone in an entire clan\r\n$clan_list = $r-\u003eget_clan_list_light(\"Efficiency Experts\");\r\n$demo = $r-\u003eget_multi_activity($clan_list);\r\n\r\n//Get a list of all the online members of your clan\r\n$clan_list = $r-\u003eget_clan_list_light(\"Wrack City\");\r\n$demo = $r-\u003eget_multi_details($clan_list, true);\r\n```\r\nAll the functions are documented inside the class, so you can take a look there if there is any confusion.\r\n\r\n### To do\r\n\r\n* Add the Bestiary links\r\n* Add more of the old API links like Ironman rankings and HCIM rankings\r\n* idk??\r\n\r\n### Issues/suggestions\r\nIf you have any, please let me know.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanderdlm%2Frue","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsanderdlm%2Frue","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanderdlm%2Frue/lists"}