Skip to content

Add docs for the News API #31

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
bigbass1997 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add docs for the News API #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 30 additions & 0 deletions news.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Toontown Rewritten News 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 `/news`

Returns the latest `news` object.

## GET `/news/{postId}`

Uses `postId` to retrieve the corresponding `news` object. If no post is found, the text `null` is returned instead.

## GET `/news/list`

Returns an array of all `news` objects.

## `news` Values

| Name | Description |
|------|-------------|
| postId | Identifier for the news post. |
| title | Title of the news post. |
| author | Author of the news post. |
| body | HTML contents of the release note as a string. |
| date | Date and time the news post was published as a string, for example `June 15, 2025 at 12:00 PM`. |
| image | URL of the first image in the news post as a string, for example `https://cdn.toontownrewritten.com/media/news-site/img/25-06-15_pridedayteamspotlight.png`. |