Introduction

• Base URL: https://api.timeworn.net

This page will help you understand how to use the JSON API.

Query

Query Parameters

/endpoint?query=value&query2=value2

/endpoint?restrict=field1,field2

Query Example

https://api.timeworn.net/api/rw/character?name=Witch

https://api.timeworn.net/api/rw/character?element=Mercury&restrict=id,name

Rate Limits

The rate limit for the API is 100 requests per minute. If you exceed this limit, you will receive a 429 Too Many Requests response.

Pagination

Requests that return multiple items will be paginated to 5 items by default. You can specify the amount using offset and limit. The limit parameter has a limit of 100 (unless stated otherwise) while offset has no limit.

All requests will return the following:

{
    data: [
        ...
    ],
    count: 9999  // Total number of data
}

Errors

The API uses the conventional HTTP response codes. In general, 2xx indicate success, 4xx indicate an error due to the information provided (e.g., a required parameter was omitted, invalid parameter value, etc.), 5xx indicate an error with the API server.