Skip to content

Requests, responses and pagination

The shape of every request and answer, and how to page through lists.

Basics

  • Base address: https://rowarden.com/api/v1 (if your RoWarden has an address of its own for the API, the Developer page and the OpenAPI file show it)
  • Bodies are JSON (Content-Type: application/json), at most 64 KB.
  • IDs are strings, including Roblox user IDs, so they are safe in JavaScript. Times are ISO-8601 in UTC.
  • Every answer carries an X-Request-Id header. Quote it when you ask for help.

Answers

A single thing:

{ "data": { "id": "34", "name": "My Game" } }

A list:

{ "data": [ … ], "next_cursor": "eyJwIjoyfQ" }

Pagination

Lists take limit (1 to 100, default 25) and cursor. Pass the next_cursor of one answer as cursor of the next request, with the same other parameters, until next_cursor is null. Treat cursors as opaque text. Lists are newest first, so a record created while you page can show up twice, but none is skipped.

Changes to the API

Within v1 we only add: new endpoints, new fields in answers, new values in lists such as action or status. Your code must ignore fields it does not know. Anything that could break a program ships as v2, with notice. See the changelog.