API reference · Terminal
Read your cards
GET /api/v1/terminal/cardsUp to 6 of your cards, or every card in one folder, read again now, each with its rows. 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
- ids list
- Up to 6 cards’ IDs, separated by commas.
- folder string
- A folder’s name or ID, for every card in it.
Example
curl "https://roterminal.co/api/v1/terminal/cards?folder=Rivals" \ -H "Authorization: Bearer $ROTERMINAL_API_KEY" import RoTerminal from 'roterminal' const rt = new RoTerminal ({ apiKey: process.env.ROTERMINAL_API_KEY }) const { data } = await rt.terminal. cards ({ folder: 'Rivals' }) from roterminal import RoTerminal rt = RoTerminal () # reads ROTERMINAL_API_KEY data = rt.terminal. cards (folder= "Rivals" )[ "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.
- shown list of object
- The cards, read again now, each with its rows. 16 fields
- card string
- tile string
- data string
- title string
- kind string
- folder string
- now string
- about string
- change string or number
- move number
- updated string
- range string
- shows object or list of strings
- 7 fields
- points integer
- spike string
- lines list
- before object
- events list
- against string
- rows list
- recipe object
- 2 fields
- series object
- sql string
- drawn object
- 24 fields
- kind string
- title string
- x string
- y list
- env boolean
- before string
- formats object
- labels object
- record string
- items list
- label string
- value string
- limit integer
- headline object
- change string
- live boolean
- spark string
- place boolean
- note string
- What the answer means, in a sentence, when there’s something to say.
- events string
- now boolean
- top object
- of string
- among integer
- template object
- 3 fields
- template string
- fill object
- stretch integer
- note string
- What the answer means, in a sentence, when there’s something to say.
- datasets list of object
- Rows to chart or keep, whole: each with its id , title , columns and rows . 4 fields
- id string
- Its ID in this answer.
- title string
- What it holds.
- columns list of strings
- Its columns’ names.
- rows list of lists
- Its rows, each a list in the order of columns .