Resident Requests

Get One Resident

GET https://yourdomain/baseURL/residentURL/one/:name

Get data of one resident

Path Parameters

Name
Type
Description

name

string

Name of the resident

{
    "name": string,
    "town": string,
    "townranks": string,
    "nationrank": string,
    "lastonline": timestamp,
    "title": string,
    "friends":[string, string]
}

Get All Residents

GET https://yourdomain/baseURL/residentURL/all/:order?min=int

Get residents in max range defined in config.json

Path Parameters

Name
Type
Description

order

string

How you want the data ordered, it can be : name, name-desc, id, id-desc

Query Parameters

Name
Type
Description

min

integer

Minimal value of the result, for example to get the 5000st result

Last updated

Was this helpful?