Skip to content

Best practices

Identify yourself

When making automated requests to our APIs, please use an appropriate User-Agent that tells us what your application is, and ideally how to contact you in case of any issues.

  • Good

    • my-cool-third-party-project.example.com version 1.23.45
    • Hiscore Analyser (@JagexLykos on Discord)

  • Bad

    • Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:158.0) Gecko/20100101 Firefox/158.0
    • curl/8.7.1
    • Python-urllib/3.14

Avoid scraping HTML pages

Serving HTML pages uses more of our resources, and is also more complex for you to handle as a developer. If you can't get the information you need through an API, then please let us know.

Be a good citizen

Some of our systems use rate limits and/or throttling to ensure that everybody is able to access them fairly. Please respect these and don't try to bypass them.

Cache where possible

If multiple users of your application request the same piece of information, then you should cache it on your end, rather than making multiple identical requests to our APIs in quick succession.

Don't be a stranger

If you have questions, requests or any other feedback, then reach out to us through the dedicated Platform API section in the RuneScape Plugin Discord.