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";
Copy

Or

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

Handling the SessionID

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

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();
Copy

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");
Copy

Or

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

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 });
Copy

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 });
Copy

View the official docs for more information on the api.