Me

View as Markdown
### Return basic profile data for the authenticated user. **Available to:** All authenticated users **Environments:** Live <!-- NoLiveOnlyEndpoints trait stubs onMe with WrongEnvironmentError.live() on Demo --> **[Rate Limit](/api/authentication#request-rate-limits-and-time-penalties):** 10 requests per hour, 30-second back-off, counts failed requests only Returns a summary of the calling user — the user identified by the access token on the request. Use it to confirm which user a token belongs to and to surface account context right after authentication. The response includes the user's `userId`, `name`, `fullName`, and `email`; whether the email is verified (`emailVerified`) and whether the account is a trial (`isTrial`); the `organizationName` and `currentAccountPlan`; and the user's current market-data subscriptions (`currentMDSubs`), `currentBalance`, and active plugins (`activePlugins`). This endpoint operates against Live. On Demo it returns an error indicating the request must be sent to the Live server. **Common Failure Scenarios** - The access token is missing, invalid, or expired (returns `HTTP 401`). - The request is sent to a Demo server instead of Live. **Error Messages** | `errorText` | Trigger | |-------------|---------| | Non-empty `errorText` | The request failed; the field describes the reason. |

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

OAuthMeResponse
errorTextstring<=8192 characters

Non-empty if the request failed

userIdlong
namestring<=64 characters
fullNamestring<=8192 characters
emailstring<=8192 characters
emailVerifiedboolean
isTrialboolean
organizationNamestring<=64 characters
currentAccountPlanstring<=64 characters
currentMDSubslist of strings
currentBalancedouble
activePluginslist of strings