Skip to content

Product & API

This is the product-facing entry point for Stat'sTheGame. Start here when you want to understand what the platform exposes, use the handwritten HTTP API, submit event data, inspect derived statistics or work with dataset outputs.

Product capabilities

Goal Start here Detailed reference
Understand the API surface API overview OpenAPI specification
Browse public cricket records Public read API Sport domain definition
Submit accepted event data Direct event submissions Submission field mapping
Upload season/back-catalogue data Batch ingestion receipt API Season-upload contract
Understand derived fixture statistics Fixture statistic calculations Event-to-statistic mapping
Understand participant aggregates Participant aggregate calculations Event model
Export data or retrieve releases Dataset exports Batch submission packages
Use consumer API controls Consumer API keys, limits and quotas API versioning
Inspect weather integration Weather API Security overview
Trace accepted data and revisions Provenance and audit API Database architecture guide

Public API path

For a new API consumer, the recommended order is:

  1. API overview for conventions and the implemented route surface.
  2. OpenAPI specification for the authoritative request/response contract and the public API Explorer route.
  3. Public read API for filters, pagination and cricket resources.
  4. Consumer API keys, rate limits and quotas when using managed consumer access.
  5. API versioning and deprecation for compatibility expectations.

Contract-level verification is documented separately in OpenAPI contract testing.

Submission and publication path

For a submitter or reviewer, start with the workflow that matches the data source:

The API pages describe externally visible behaviour. The underlying persistence and worker design are documented under Architecture & Data.

Statistics, exports and provenance

Published totals are derived from accepted event data rather than entered as independent totals. Use Fixture statistic calculations and Participant aggregate calculations for calculation behaviour, then Dataset exports for JSON/CSV slices and versioned release artefacts.

When you need to understand why a value exists, use the Provenance and audit API, event-to-statistic mapping and event model rather than treating an aggregate as a separate source of truth.

Detailed reference

The following pages remain available as specialist reference without occupying the first level of navigation:

AI Declaration

The product/API documentation hub and progressive-disclosure structure were planned and drafted with the assistance of ChatGPT-Web[GPT-5.6 Sol].