---
title: "Get the current account status and remaining API calls"
method: GET
path: "/account"
---

# Get the current account status and remaining API calls

`GET /account`

## Request

- Base URL: `https://www.valueray.com/api`
- URL: `https://www.valueray.com/api/account`
- Auth: one of:
  - none
  - HTTP bearer
- TypeScript: <https://skmtc.dev/valueray/apis/valueray-api/docs/account/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint has no query or path parameters and accepts no request body. Authenticate an API user with `Authorization: Bearer YOUR_API_TOKEN`.
Replace `YOUR_API_TOKEN` with your token. Omit the `Authorization` header for an anonymous request without session cookies.
Authentication is optional via a browser session, Sanctum or a Passport Bearer token. Anonymous requests return HTTP 200 with authenticated set to false.
This endpoint does not consume API credits and responses are private, no-store.

```sh
curl "https://www.valueray.com/api/account" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
```

## Response `200`

Account status returned successfully

- union
  - object
    - `authenticated` unknown, required
    - `user` unknown, required
    - `roles` string[], required
    - `subscription` unknown, required
    - `api_calls` unknown, required
  - object
    - `authenticated` unknown, required
    - `user` object, required
      - `id` integer, required
      - `name` string, required
    - `roles` string[], required
    - `subscription` object, nullable, required
      - `plan` string, required
    - `api_calls` object, required
      - `remaining` integer, required
      - `monthly_remaining` integer, required
      - `topup_remaining` integer, required

## Changes

- **2026-11-07** `9678afef0e1c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/valueray/apis/valueray-api/changes/account/get.md)

---

[API](https://skmtc.dev/valueray/apis/valueray-api.md) - [All operations](https://skmtc.dev/valueray/apis/valueray-api/llms.txt) - [OpenAPI document](https://skmtc.dev/valueray/apis/valueray-api/revisions/9678afef0e1c?raw)