Skip to content

fisocodes/onrl

Repository files navigation

ONRL

Introduction

This REST API provides structured access to National Rugby League (NRL) data, designed for developers, analysts, and enthusiasts who want to build tools, explore statistics, or integrate rugby league insights into their applications. Since the NRL does not offer a public API for data ingestion, this project fills a critical gap—offering a reliable, maintainable, and domain-aligned interface to query match results, player stats, team information, and seasonal data.

Motivation

The National Rugby League (NRL) does not currently offer a public API for data ingestion. This presents a challenge for developers, analysts, and fans who want to build tools, conduct research, or simply explore NRL data in a structured and reliable way. This project aims to fill that gap by providing a clean, maintainable, and domain-aligned REST API that makes NRL data accessible to anyone who needs it.

Whether you're building fan-facing apps, analytics dashboards, or internal tooling, this API offers a consistent and intuitive way to interact with match results, player stats, team rosters, and season schedules.

Goals

Onboarding Ease: The API is designed with contributors in mind. From concise table names to documented relationships and reusable templates, every architectural decision supports fast, confident onboarding. New developers should be able to understand the domain model and contribute meaningfully within hours, not days.

Maintainability & Extensibility: Built with separation of concerns, modular naming conventions, and clear identity anchors, the API is future-proofed for evolving league formats, rule changes, and new data sources. Whether you're adding a new stat type or refactoring a legacy endpoint, the structure supports safe, scalable growth.

By treating schema design as a communicative craft and automation as a contributor ally, this API aims to be more than just a data pipe—it’s a foundation for collaborative, transparent rugby league software development.

To dive into the project goals, visit the Goals section in the wiki.

Documentation

The project is documented in the Wiki. Please have a look if you want to dive into the specifics for the project.

Installation

Go to the specific workspace to know more about the installation process

API workspace

Usage

Go to the specific workspace to know more about the usage process

API workspace

Roadmap

Please visit the projects section to know more about the development status and future implementations.

About

Accesible National Rugby League data

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors