Skip to content

Add docs for the Release Notes API #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add docs for the Release Notes API #30

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c7e10e
release-notes: Add documentation for the Release Notes API
bigbass1997 Jun 16, 2025
ac3ec14
release-notes: Fix table formatting and improve response descriptions
bigbass1997 Jun 16, 2025
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
36 changes: 36 additions & 0 deletions release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Toontown Rewritten Release Notes API

## Requests

All requests must be submitted via HTTP GET to `https://www.toontownrewritten.com/api` with one of the following endpoints.

If you are frequently making calls to this API, we would appreciate it if you set a descriptive User-Agent.

## GET `/releasenotes`

Returns an array of all `note` objects, excluding the `body` field.

| Name | Description |
|------|-------------|
| noteId | Identifier for the release note. |
| slug | Version number as a string, for example `ttr-live-v4.1.7d`. |
| date | Date and time the note was published as a string, for example `April 20, 2025 at 5:25 AM`. |

## GET `/releasenotes/{noteId}`

Uses `noteId` to retrieve the corresponding `note` object. If no note is found, an `error` object is returned instead.

### `note` Values

| Name | Description |
|------|-------------|
| noteId | Identifier for the release note. |
| slug | Version number as a string, for example `ttr-live-v4.1.7d`. |
| date | Date and time the note was published as a string, for example `April 20, 2025 at 5:25 AM`. |
| body | HTML contents of the release note as a string. |

### `error` Values

| Name | Description |
|------|-------------|
| error | `Unknown release note` |