Triangle.js Tetra Channel API

This is the documentation for the subsection of Triangle.js that interacts with the public https://ch.tetr.io/api api. For the full documentation, see the main README.

Usage

Import

import { ch } from "@haelp/teto";

// only load the required channel api module
import { ch } from "@haelp/teto/ch";

Handling the SessionID

ch.setSessionID("your-session-id");
const id = ch.getSessionID();

Methods

There are 4 different types of requests that the api can make. Here is an explanation of each one:

Empty requests

These send no data to the server. Example:

const res = await ch.general.stats();

Argument only requests

These send data in the form of arugments in the request uri. Example:

// This sends a request to https://ch.tetr.io/api/users/halp
const res = await ch.users.get("halp");

const res = await ch.users.get({ user: halp });

Query param only requests

These send data in the form of query parameters. Example:

// This sends a request to https://ch.tetr.io/api/news/?limit=100
const res = await ch.news.all({ limit: 100 });

Query param and argument requests

These send data in the form of query parameters and arguments in the request uri. Example:

// This sends a request to https://ch.tetr.io/api/users/by/xp?limit=100
const res = await ch.users.leaderboard("xp", { limit: 100 });

Proxying

Because the Tetra Channel API does not have cors enabled, you need to proxy requests coming from a browser. This is an example express route that proxies requests to the ch.tetr.io server:

app.get("/api/ch-proxy/*", async (req, res) => {
  const url = req.url.replace("/api/ch-proxy", "");
  const response = await fetch(`https://ch.tetr.io/api${url}`, {
    headers: {
      "X-Session-ID": req.headers["x-session-id"]!
    }
  });
  const json = await response.json();
  res.json(json);
});

You can then set the 'host' setting on the client to your proxy:

ch.setConfig({ host: "/api/ch-proxy/" });

View the official docs for more information on the api.