Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 24 additions & 15 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,15 @@ All notable changes to the specification are recorded here.
The API surface is versioned as `v1`. Changes within `v1` are **additive only**;
removing a field or changing its type would require `v2`.

## [1.13.89] - 2026-11-20

### Added
- **The changelog as an Atom feed and a JSON Feed.** `changelog.atom` (Atom 1.0) and `changelog.json` (JSON Feed 1.1) carry every entry of this changelog. Each one has the version, the date, the items of each section, a summary and the client library versions the entry names. Both are written from the same parse as `changelog.html`. The build fails when either feed breaks its format or differs from the page. An entry's id is its anchor on the page, so a rebuild never shows an old entry as new. The changelog page and the docs home link both feeds in their head, and llms.txt lists them. Nothing on the wire changed.

### Fixed
- **The changelog page shows all 115 entries.** Fifteen headings from 1.1.0 to 1.9.3 were written with an em dash. The page folded them into the 1.9.4 entry as plain text. Each is now its own entry, and the build stops on a heading it cannot read.
- **Bold and code that wrap onto a second line render in full.** Six older entries showed raw asterisks and backticks there. Two links written in angle brackets showed the brackets. Both now render as on the rest of the page.

## [1.13.88] - 2026-11-19

### Changed
Expand Down Expand Up @@ -742,7 +751,7 @@ Documentation only. No field, endpoint or wire value changed.
`synthetic: true` by design because the live book attaches at match start;
`timestamp` is our observation clock (UTC), not a venue publication time.

## [1.9.3] — 2026-09-04
## [1.9.3] - 2026-09-04

### Clarified
- **`Match.tournament_id` null cases** restated with the real causes and a
Expand All @@ -752,7 +761,7 @@ Documentation only. No field, endpoint or wire value changed.
2026 backlog was backfilled the same day (2,547 rows); ITF null rate went
from about 25% to about 2.5%. No wire change.

## [1.9.2] — 2026-09-04
## [1.9.2] - 2026-09-04

### Added (spec catch-up — every one of these has been live on the API; the document lagged)
- **`GET /matches?status=cancelled`** is now in the `status` enum, with what it
Expand All @@ -774,7 +783,7 @@ Documentation only. No field, endpoint or wire value changed.
listings, so `has_more` is the only end-of-data signal there.
Asked by a Basic customer on Discord; no wire change.

## [1.9.1] — 2026-09-02
## [1.9.1] - 2026-09-02

### Clarified
- **`Player.ranking` / `Player.ranking_points`** now say what they are: the
Expand All @@ -784,7 +793,7 @@ Documentation only. No field, endpoint or wire value changed.
record even on historical matches (`/rankings?as_of=` is the as-of surface).
Asked by a Basic customer; no wire change.

## [1.9.0] — 2026-09-02
## [1.9.0] - 2026-09-02

### Added
- **`has_analysis` and `has_market` on `Match`** — two booleans on every row of
Expand All @@ -800,7 +809,7 @@ Documentation only. No field, endpoint or wire value changed.
`/matches/{matchId}/statistics` already uses in its `200`. New `error` codes
`no_analysis`, `no_market` documented on the `Error` schema.

## [1.8.0] — 2026-09-01
## [1.8.0] - 2026-09-01

### Added
- **`GET /history/archive/matches/{archiveId}/tape`** (`getArchiveTape`) — the
Expand Down Expand Up @@ -862,7 +871,7 @@ Documentation only. No field, endpoint or wire value changed.
corpus, the null clock and the coverage floor together.
- `info.version` is now `1.8.0`.

## [1.7.2] — 2026-08-23
## [1.7.2] - 2026-08-23

### Changed
- **`status` on Match now documents the lifecycle rule.** `completed` is
Expand All @@ -877,7 +886,7 @@ Documentation only. No field, endpoint or wire value changed.
changed type — prose only.
- `info.version` is now `1.7.2`.

## [1.7.1] — 2026-08-19
## [1.7.1] - 2026-08-19

### Added
- **`event_status_updated_at` on Match.** Nullable ISO-8601 UTC (`Z`)
Expand All @@ -894,7 +903,7 @@ Documentation only. No field, endpoint or wire value changed.
### Changed
- `info.version` is now `1.7.1`.

## [1.7.0] — 2026-08-18
## [1.7.0] - 2026-08-18

### Added
- **`basis` on `GET /matches/{matchId}/points` responses.** `live` |
Expand All @@ -921,7 +930,7 @@ Documentation only. No field, endpoint or wire value changed.
### Changed
- `info.version` is now `1.7.0`.

## [1.6.0] — 2026-08-18
## [1.6.0] - 2026-08-18

### Added
- **The three-valued `draw` field on Match.** `singles` | `doubles` | null —
Expand Down Expand Up @@ -987,7 +996,7 @@ Documentation only. No field, endpoint or wire value changed.
### Changed
- `info.version` is now `1.6.0`.

## [1.5.0] — 2026-08-17
## [1.5.0] - 2026-08-17

### Added
- **The as-of Elo tape.** `GET /rankings?system=elo` (ULTRA, both modes) —
Expand Down Expand Up @@ -1053,7 +1062,7 @@ Documentation only. No field, endpoint or wire value changed.
that change.
- `info.version` is now `1.5.0`.

## [1.4.0] — 2026-08-16
## [1.4.0] - 2026-08-16

### Added
- **Live per-point events.** `GET /matches/{matchId}/points` (ULTRA) — the
Expand Down Expand Up @@ -1107,7 +1116,7 @@ Documentation only. No field, endpoint or wire value changed.
well as `?sequence=clean` (there the served order IS point order).
- `info.version` is now `1.4.0`.

## [1.3.1] — 2026-08-07
## [1.3.1] - 2026-08-07

### Added
- **`kind=rally` bulk packages documented.** The `/history/packages` `kind`
Expand All @@ -1119,7 +1128,7 @@ Documentation only. No field, endpoint or wire value changed.
`kind` accepts `tape` (default), `rankings` (ULTRA), `rally` (ULTRA)
and `archive`.

## [1.3.0] — 2026-08-07
## [1.3.0] - 2026-08-07

### Added
- **Shot-level charting.** `GET /charting/players` (ULTRA) — career
Expand Down Expand Up @@ -1168,7 +1177,7 @@ Documentation only. No field, endpoint or wire value changed.
key limit is stated.
- `info.version` is now `1.3.0`.

## [1.2.0] — 2026-08-03
## [1.2.0] - 2026-08-03

### Added
- **Results archive (1968–2022).** The history product now runs in two
Expand Down Expand Up @@ -1246,7 +1255,7 @@ Documentation only. No field, endpoint or wire value changed.
and `/h2h` on BASIC/History plans, the rankings listing on PRO, rally and
per-player as-of rankings on ULTRA).

## [1.1.0] — 2026-08-02
## [1.1.0] - 2026-08-02

### Added
- **Usage endpoint.** `GET /usage` (FREE — any tier): your own durable daily
Expand Down
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,15 @@ entry. It also fails when an entry names an operation the spec does not
define, or when the samples are stale. `python -m unittest scripts/test_build_code_samples.py`
breaks copies of both files and checks that each of those failures is caught.

## Changelog feeds

`docs/changelog.atom` (Atom 1.0) and `docs/changelog.json` (JSON Feed 1.1)
are built from `CHANGELOG.md` together with `docs/changelog.html`, so do not
edit them by hand. Write each entry heading as `## [x.y.z] - YYYY-MM-DD`.
The build stops on any other `## ` line. It also fails when a feed breaks its
format or differs from the page. `python -m unittest scripts/test_changelog_feeds.py`
runs the same checks and breaks copies of both feeds to show each check works.

## Versioning

Changes within `v1` are **additive only**: new endpoints, new optional fields.
Expand Down
2 changes: 1 addition & 1 deletion docs/auth-quota-and-health.html
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@
<header class="docs-site-header"><a class="docs-brand" href="./"><img src="logo.svg" width="28" height="28" alt="">Live Tennis API <span>Docs</span></a><nav class="docs-desktop-nav" aria-label="Documentation"><a href="./">Overview</a><a href="./reference.html">API reference</a><a href="./changelog.html">Changelog</a></nav><a class="docs-key" href="https://livetennisapi.com/subscribe/free">Get a free key <span aria-hidden="true">↗</span></a></header><details class="docs-topic-menu"><summary>Explore the documentation</summary><nav aria-label="Documentation topics"><a href="./">Overview</a><a href="./reference.html">API reference</a><a href="./changelog.html">Changelog</a><a href="./live-scores.html">Live tennis scores API</a><a href="./players-and-tournaments.html">Tennis players, tournaments and rankings API</a><a href="./tennis-odds.html">Tennis odds API — markets and price ticks</a><a href="./point-by-point-history.html">Point-by-point tennis data API</a><a href="./historical-results-archive.html">Historical tennis results API — 1968 onward</a><a href="./shot-level-rally-data.html">Shot-by-shot tennis rally and charting API</a><a href="./broadcast-graphics.html">Tennis scores for on-air graphics</a><a href="./push-feed-and-webhooks.html">Tennis WebSocket feed and webhooks</a><a href="./auth-quota-and-health.html" aria-current="page">Tennis API authentication, quota and status</a><a href="./ai-sdk.html">Live Tennis API tools for the Vercel AI SDK</a><a href="./errors-and-rate-limits.html">Errors and rate limits</a><a href="./export-formats.html">Export tennis data to CSV, JSON Lines or Parquet</a><a href="./client-libraries.html">Live Tennis API client libraries</a><a href="./sportsml.html">Tennis score mapping to IPTC SportsML</a></nav></details>
<div class="wrap">
<header>
<p class="meta">Live Tennis API &middot; docs &middot; version 1.13.88</p>
<p class="meta">Live Tennis API &middot; docs &middot; version 1.13.89</p>
<h1>Tennis API authentication, quota and status</h1>
<p><strong>How do you authenticate, and how do you see what quota is left?</strong> Send your key as <code>X-API-Key</code> on every request. <code>GET /usage</code> returns your own consumption against your plan's quota and works on every tier including FREE, so a client can check its own headroom before a burst. <code>GET /health</code> is the unauthenticated liveness probe.</p>
<p class="meta">2 endpoints on this page. Base URL
Expand Down
2 changes: 1 addition & 1 deletion docs/broadcast-graphics.html
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@
<header class="docs-site-header"><a class="docs-brand" href="./"><img src="logo.svg" width="28" height="28" alt="">Live Tennis API <span>Docs</span></a><nav class="docs-desktop-nav" aria-label="Documentation"><a href="./">Overview</a><a href="./reference.html">API reference</a><a href="./changelog.html">Changelog</a></nav><a class="docs-key" href="https://livetennisapi.com/subscribe/free">Get a free key <span aria-hidden="true">↗</span></a></header><details class="docs-topic-menu"><summary>Explore the documentation</summary><nav aria-label="Documentation topics"><a href="./">Overview</a><a href="./reference.html">API reference</a><a href="./changelog.html">Changelog</a><a href="./live-scores.html">Live tennis scores API</a><a href="./players-and-tournaments.html">Tennis players, tournaments and rankings API</a><a href="./tennis-odds.html">Tennis odds API — markets and price ticks</a><a href="./point-by-point-history.html">Point-by-point tennis data API</a><a href="./historical-results-archive.html">Historical tennis results API — 1968 onward</a><a href="./shot-level-rally-data.html">Shot-by-shot tennis rally and charting API</a><a href="./broadcast-graphics.html" aria-current="page">Tennis scores for on-air graphics</a><a href="./push-feed-and-webhooks.html">Tennis WebSocket feed and webhooks</a><a href="./auth-quota-and-health.html">Tennis API authentication, quota and status</a><a href="./ai-sdk.html">Live Tennis API tools for the Vercel AI SDK</a><a href="./errors-and-rate-limits.html">Errors and rate limits</a><a href="./export-formats.html">Export tennis data to CSV, JSON Lines or Parquet</a><a href="./client-libraries.html">Live Tennis API client libraries</a><a href="./sportsml.html">Tennis score mapping to IPTC SportsML</a></nav></details>
<div class="wrap">
<header>
<p class="meta">Live Tennis API &middot; docs &middot; version 1.13.88</p>
<p class="meta">Live Tennis API &middot; docs &middot; version 1.13.89</p>
<h1>Tennis scores for on-air graphics</h1>
<p><strong>How do you put live tennis scores into a broadcast graphics template?</strong> <code>GET /broadcast/match/{matchId}</code> returns ONE flat object for one match and <code>GET /broadcast/live</code> the same object for every live match in a single call. Both are ULTRA. A graphics template binds each field to a fixed path, so three things are contractual: the object is flat, every key is present on every read (<code>null</code>, never missing), and the score is already in display form — <code>p1_points</code> reads <code>"40"</code> or <code>"AD"</code> and <code>set_line</code> is one string. Built for 1 Hz: every response carries a strong <code>ETag</code>, so <code>If-None-Match</code> makes an unchanged state a 304 with no body. Detect a new state on <code>sequence</code>, never on <code>served_at</code>, which changes on every read.</p>
<p class="meta">2 endpoints on this page. Base URL
Expand Down
Loading