Retrieve your account

Who the key belongs to, its plan, and the day’s calls: how many you’ve made, how many you have, and when they reset. It doesn’t count toward your daily calls.

Parameters

This endpoint has no parameters.

Example

curl https://roterminal.co/api/v1/me \
  -H "Authorization: Bearer $ROTERMINAL_API_KEY"

import RoTerminal from 'roterminal'

const rt = new RoTerminal({ apiKey: process.env.ROTERMINAL_API_KEY })

const { data } = await rt.me.retrieve()

from roterminal import RoTerminal

rt = RoTerminal()  # reads ROTERMINAL_API_KEY

data = rt.me.retrieve()["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.

signed_inboolean

True when the request was made with an API key (or from the site, signed in).

usernamestring or null

Your RoTerminal username.

display_namestring or null

Your name, as your profile shows it.

planstring

Your plan: No account, Free, Plus, Pro or Studio.

calls_todayinteger

Calls made today.

calls_a_dayinteger or null

Calls you get a day.

resets_atdate-time

When your calls reset: midnight New York time (ISO 8601).

keyobject or null

The API key the request was made with.

2 fields

namestring or null

Its name, as Roblox shows it.

last4string or null

Its last four characters.