API for developers · TrueBoost

Servers

List servers

GET/servers

Servers by live online, highest first. Suspicious servers and ones hidden by the administration are left out.

Parameters

qstringquery

Part of the name or address

regionenumquery · world

world, cis, europe, america, latam, asia

min_playersintegerquery · 0

At least this many live players

limitintegerquery · 50

Up to 500

offsetintegerquery · 0

Offset for the next page

Send the key in the X-Api-Key header. The limit is 60 requests a minute per key; above it the answer is 429. Times are UTC in ISO 8601.

curl -H "X-Api-Key: $TB_KEY" \
  "https://trueboost.emris-host.ru/api/v1/servers?q=Public&limit=2"

const res = await fetch(
  "https://trueboost.emris-host.ru/api/v1/servers?q=Public&limit=2",
  { headers: { "X-Api-Key": process.env.TB_KEY } },
);
const data = await res.json();

import os, requests

r = requests.get(
    "https://trueboost.emris-host.ru/api/v1/servers?q=Public&limit=2",
    headers={"X-Api-Key": os.environ["TB_KEY"]},
)
data = r.json()

The response appears here

Press Send.

Servers

Get server

GET/servers/{address}

Server card: online, map, suspicion flags, plugin, services on monitors and connects by day.

Parameters

addressstringpath

Server ip:port

daysintegerquery · 14

Days of connects, 1–60

Send the key in the X-Api-Key header. The limit is 60 requests a minute per key; above it the answer is 429. Times are UTC in ISO 8601.

curl -H "X-Api-Key: $TB_KEY" \
  "https://trueboost.emris-host.ru/api/v1/servers/46.174.50.220:27015"

const res = await fetch(
  "https://trueboost.emris-host.ru/api/v1/servers/46.174.50.220:27015",
  { headers: { "X-Api-Key": process.env.TB_KEY } },
);
const data = await res.json();

import os, requests

r = requests.get(
    "https://trueboost.emris-host.ru/api/v1/servers/46.174.50.220:27015",
    headers={"X-Api-Key": os.environ["TB_KEY"]},
)
data = r.json()

The response appears here

Press Send.

Servers

Online history

GET/servers/{address}/history

Up to 48 hours every poll, beyond that hourly averages.

Parameters

addressstringpath

Server ip:port

hoursintegerquery · 24

Period length, 1–720

offset_hoursintegerquery · 0

Shift the window back: hours gives the previous period

Send the key in the X-Api-Key header. The limit is 60 requests a minute per key; above it the answer is 429. Times are UTC in ISO 8601.

curl -H "X-Api-Key: $TB_KEY" \
  "https://trueboost.emris-host.ru/api/v1/servers/46.174.50.220:27015/history?hours=6"

const res = await fetch(
  "https://trueboost.emris-host.ru/api/v1/servers/46.174.50.220:27015/history?hours=6",
  { headers: { "X-Api-Key": process.env.TB_KEY } },
);
const data = await res.json();

import os, requests

r = requests.get(
    "https://trueboost.emris-host.ru/api/v1/servers/46.174.50.220:27015/history?hours=6",
    headers={"X-Api-Key": os.environ["TB_KEY"]},
)
data = r.json()

The response appears here

Press Send.

Servers

Weekly heatmap

GET/servers/{address}/heatmap

Average live online by weekday and Moscow hour.

Parameters

addressstringpath

Server ip:port

daysintegerquery · 28

Days to average over

Send the key in the X-Api-Key header. The limit is 60 requests a minute per key; above it the answer is 429. Times are UTC in ISO 8601.

curl -H "X-Api-Key: $TB_KEY" \
  "https://trueboost.emris-host.ru/api/v1/servers/46.174.50.220:27015/heatmap"

const res = await fetch(
  "https://trueboost.emris-host.ru/api/v1/servers/46.174.50.220:27015/heatmap",
  { headers: { "X-Api-Key": process.env.TB_KEY } },
);
const data = await res.json();

import os, requests

r = requests.get(
    "https://trueboost.emris-host.ru/api/v1/servers/46.174.50.220:27015/heatmap",
    headers={"X-Api-Key": os.environ["TB_KEY"]},
)
data = r.json()

The response appears here

Press Send.

Plugin data

Players from the plugin

GET/servers/{address}/players

For servers running the TrueBoost plugin: players, new and returning by day, retention of new players and clients. Without the plugin: has_plugin: false.

Parameters

addressstringpath

Server ip:port

daysintegerquery · 14

Days, 1–60

Send the key in the X-Api-Key header. The limit is 60 requests a minute per key; above it the answer is 429. Times are UTC in ISO 8601.

curl -H "X-Api-Key: $TB_KEY" \
  "https://trueboost.emris-host.ru/api/v1/servers/46.174.50.220:27015/players"

const res = await fetch(
  "https://trueboost.emris-host.ru/api/v1/servers/46.174.50.220:27015/players",
  { headers: { "X-Api-Key": process.env.TB_KEY } },
);
const data = await res.json();

import os, requests

r = requests.get(
    "https://trueboost.emris-host.ru/api/v1/servers/46.174.50.220:27015/players",
    headers={"X-Api-Key": os.environ["TB_KEY"]},
)
data = r.json()

The response appears here

Press Send.

Monitors

Monitor ranking

GET/monitors/ranking

Median connects a day by service, claimed effect and the TrueBoost score.

Parameters

min_service_daysintegerquery · 3

Fewer observations go to the end

Send the key in the X-Api-Key header. The limit is 60 requests a minute per key; above it the answer is 429. Times are UTC in ISO 8601.

curl -H "X-Api-Key: $TB_KEY" \
  "https://trueboost.emris-host.ru/api/v1/monitors/ranking"

const res = await fetch(
  "https://trueboost.emris-host.ru/api/v1/monitors/ranking",
  { headers: { "X-Api-Key": process.env.TB_KEY } },
);
const data = await res.json();

import os, requests

r = requests.get(
    "https://trueboost.emris-host.ru/api/v1/monitors/ranking",
    headers={"X-Api-Key": os.environ["TB_KEY"]},
)
data = r.json()

The response appears here

Press Send.

Monitors

Get monitor

GET/monitors/{slug}

One monitor: site, cycle, weight.

Parameters

slugstringpath

The monitor's short name

Send the key in the X-Api-Key header. The limit is 60 requests a minute per key; above it the answer is 429. Times are UTC in ISO 8601.

curl -H "X-Api-Key: $TB_KEY" \
  "https://trueboost.emris-host.ru/api/v1/monitors/ms-boost"

const res = await fetch(
  "https://trueboost.emris-host.ru/api/v1/monitors/ms-boost",
  { headers: { "X-Api-Key": process.env.TB_KEY } },
);
const data = await res.json();

import os, requests

r = requests.get(
    "https://trueboost.emris-host.ru/api/v1/monitors/ms-boost",
    headers={"X-Api-Key": os.environ["TB_KEY"]},
)
data = r.json()

The response appears here

Press Send.

Monitors

Servers on a monitor

GET/monitors/{slug}/servers

Servers with active services on the monitor and their latest connects.

Parameters

slugstringpath

The monitor's short name

Send the key in the X-Api-Key header. The limit is 60 requests a minute per key; above it the answer is 429. Times are UTC in ISO 8601.

curl -H "X-Api-Key: $TB_KEY" \
  "https://trueboost.emris-host.ru/api/v1/monitors/ms-boost/servers"

const res = await fetch(
  "https://trueboost.emris-host.ru/api/v1/monitors/ms-boost/servers",
  { headers: { "X-Api-Key": process.env.TB_KEY } },
);
const data = await res.json();

import os, requests

r = requests.get(
    "https://trueboost.emris-host.ru/api/v1/monitors/ms-boost/servers",
    headers={"X-Api-Key": os.environ["TB_KEY"]},
)
data = r.json()

The response appears here

Press Send.