Public API

Introducing Predecessor's Public API!

As previously announced, V.0.6 brings with it the launch of the Predecessor Public API.

WHAT IS THE PUBLIC API?

The Public API (Application Programming Interface) is a tool that allows community members, programmers and developers to access certain pieces of raw data from the Predecessor back end, which can then be used or outputted into community applications such as websites, leaderboards and more. The API is designed to facilitate community projects and fan-features that should enhance both Predecessor and the wider community.

PUBLIC API DEVELOPMENT

As previously mentioned, the Public API has been developed in collaboration with (and made possible by the support of) a handful of community developers. 

With the Public API now live, these partners now have live access to the Public API. 

We’d like to take this opportunity to showcase what they have been working on, which might inspire your own Predecessor Public API-based projects! 

Predecessor Pro
Builds, Guides, Items, Heroes
https://predecessor.pro

Omeda City
A powerful reference tool for Predecessor items, builds and stats!
https://omeda.city/ 

We hope these community websites and tools will serve as inspiration for others who are interested in using the API to create new and innovative features for the Predecessor community.

Thank you for your continued support, and we look forward to seeing all of the amazing applications that will be built using the Public API.

HOW TO USE THE PUBLIC API?

Welcome to the first version of our Public API. We aim to keep adding new features to the public API over time.

ACCESS

We’re currently trialling a “completely open” access model, meaning for now we’re not imposing any restrictions. We ask you not to hammer our endpoints constantly - if people do abuse these endpoints we will bring in rate limiting and/or necessitate API keys.

CURRENT ENDPOINTS

The following data points are now available to pull.


Get Matches By Epoch
You pass in a unix epoch to the endpoint which will then return ten matches/ For pagination take the endTime of the last match and use that as the new epoch to call the endpoint with.

Example: https://backend.production.omeda-aws.com/api/public/get-matches-since/1679574572/


Get Match By Identifier
Example: https://backend.production.omeda-aws.com/api/public/get-match/d2569e5482fa45e19db88752c072d9a4/

FUTURE ENDPOINTS

Some endpoints didn’t quite make the cut for this initial release. Here’s some additional endpoints that’ll be available in the future.


Get Matches By Player Identifier
Partially implemented - currently only returns ten matches.
Example: https://backend.production.omeda-aws.com/api/public/get-matches-by-player/player_id/


Item Mapping
Not implemented, but will return the ItemID -> ItemName mapping
Example: https://backend.production.omeda-aws.com/api/public/item-mapping/


Item Information
Not implemented, but will return information about items.
Example: https://backend.production.omeda-aws.com/api/public/item-information/


Hero Information
Not implemented, but will return information about heroes based on their codenames.
Example: https://backend.production.omeda-aws.com/api/public/hero/crunch

FEEDBACK & HELP

Got any questions? Running into issues? Let us know!

Join the Predecessor Discord and leave a message in the #Public-API forum channel.