/hirez-api-docs

:construction: Unofficial Hi-Rez Studios API documentation (and assets where possible) for Paladins, Realm Royale, and Smite.

Primary LanguagePythonMIT LicenseMIT

Unofficial Hi-Rez Studios API Developer Guide

License

🚧 It's a work in progress, still undergoing some change, documentation is in-progress.

Unofficial Hi-Rez Studios API documentation (and assets where possible) for Paladins, Realm Royale, and Smite.

Purpose 💎

Due to Hi-Rez Studios not providing a detailed documentation for their API, this Developer Guide is here to assist those attempting to make their own API wrapper for their API.

This documentation holds the Methods Documentation and Source Code Examples, and its purpose is to provide Developers with the necessary information to access and utilize the API methods.

This documentation will consume a JSON response and therefore detailed descriptions of each data field are included where possible.

Mantainance 🛠

As long as Hi-Rez Studios doesn't change its APIs this documentation won't be changed. However, resources could be updated, added or removed when needed.

The values for API Keys are removed for security purposes.

Note that the API calls are synchronous and may take a few seconds before generating a response. You will probably call the API asynchronously, but for purposes of this exercise (to quickly understand how to work with the API methods) the synchronous method was used.

Graphics 🎨

You can find any graphics here.

How to contribute :octocat:

Feel free to contribute to this project, a helping hand is always appreciated.

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).
  3. Send a pull request and bug the maintainer until it gets merged.

By contributing contents to this Wiki you shall implicitly accept that others might reuse these contents in other projects without restrictions.

Disclaimer ❌

This project, including this repository, is neither created, affiliated, authorized, maintained, associated nor endorsed by Hi-Rez Studios, or any of its subsidiaries or its affiliates.

It is an independent and unofficial project created by the community for the community.

Please refrain from contacting Hi-Rez Studios regarding any issues or support of this project, instead feel free to submit an issue.

Copyright & License 📝

This is a free, open source Open Source, and MIT friendly project. Full license can be found in the LICENSE file. The programs in the “code-samples” subdirectory are in the public domain unless specified otherwise.

Please note, however, that this license does NOT cover third-party libraries used by project, they are under their own licenses. Please refer to those libraries for details on the license they use.

All information obtained is provided by Hi-Rez Studios API and is thus their property. According to Section 11a of the API Terms of Use, you must attribute any data provided as below.

Data provided by Hi-Rez. © 2022 Hi-Rez Studios, Inc. All rights reserved.

Resources

Wrappers

  • wrapper_cpp_hirezcpp
  • wrapper_dotnet_paladins_dotnet wrapper_dotnet_realm_royale_dotnet
  • wrapper_elixir_exrez
  • wrapper_go_paladins_go wrapper_go_smite_paladins_realm_api_usage wrapper_go_go_smite_api wrapper_go_go_hirez
  • wrapper_java_paladins_wrapper wrapper_java_hi_rez_api wrapper_java_paladins_java_api wrapper_java_smite_api
  • wrapper_javascript_joshmiquel-hirez badge_wrapper_javascript_paladins_api wrapper_javascript_paladins.js wrapper_javascript_paladins_api_node.js wrapper_javascript_pe_paladins.js
  • wrapper_kotlin_hirez_sdk_kotlin wrapper_kotlin_paladins_api_kotlin
  • wrapper_php_php_api wrapper_php_paladins_api_php_wrapper wrapper_php_smite_api_php_client wrapper_php_paladins_php wrapper_php_paladinsphp
  • wrapper_python_pyrez wrapper_python_hirez_api wrapper_python_hi_rez_api
  • wrapper_r_smite_r_files
  • wrapper_ruby_paladins wrapper_ruby_smite_ruby
  • wrapper_rust_hi_rust wrapper_rust_smite_motd
  • wrapper_swift_swifty_smite_api
  • wrapper_visual_basic_smite_vb
  • wrapper_vue_realm_royale_first_vue_app
  • wrapper_x_query_smite_api

External Links