API reference · Terminal

List your Terminal

GET /api/v1/terminal

Your Terminal: the grid of live cards you keep, in folders. Every folder and card, each card with its ID, its title, its number now and its move. Needs an API key. Terminal and routines open with the new RoTerminal: on an account it isn’t open on yet, the answer is permission_denied .

This endpoint needs an API key. See Authentication.

Parameters

folder string: Only one folder: its name or ID.

Example

curl https://roterminal.co/api/v1/terminal \ -H "Authorization: Bearer $ROTERMINAL_API_KEY" const res = await fetch ( 'https://roterminal.co/api/v1/terminal' , { headers: { Authorization: `Bearer ${process.env.ROTERMINAL_API_KEY}` }, }) const { data } = await res. json () import os import requests res = requests. get ( "https://roterminal.co/api/v1/terminal" , headers={ "Authorization" : f "Bearer {os.environ['ROTERMINAL_API_KEY']}" }, ) data = res. json ()[ "data" ]

Response

Every response is { data, link, as_of } . The fields of data are below.

Fields

The fields in data . A field with nothing to say is left out.

folders list of object

Your folders, in order: each with its ID, name, place and how many cards. 4 fields

id string: The folder’s ID.
name string: Its name.
position integer: Its place: 1 is first.
cards integer: How many cards are in it.

cards list of object

Your cards, in order. 15 fields

id string: The card’s ID (12 characters).
position integer: Its place on Terminal, or in its folder.
folder string: The folder it’s in.
title string: Its title.
kind string: What it is: line , stat , bar and the rest.
now string: Its number now, as the card shows it.
about string: What the number is.
change string or number: Its change, in percent, or in words.
move number: Its change as a fraction, for ranking.
updated string: When it was last read.
range string: Its time frame.
ranges list of strings: The time frames it can show.
games list of strings: The games on it.
from string: Where it came from.
note string: What the answer means, in a sentence, when there’s something to say.

about string

What position and move mean.

note string

What the answer means, in a sentence, when there’s something to say.