---
title: "Retrieve user status"
method: POST
path: "/user_status"
tags: ["User Status"]
---

# Retrieve user status

`POST /user_status`

## Request

- Base URL: `https://api.kraken.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.kraken.io/user_status`
- Auth: none declared

Fetches the current user status, including plan information and quota details.

## Request body

- UserStatusResponse
  - `success` boolean
  - `active` boolean
  - `plan_name` string
  - `quota_total` integer
  - `quota_used` integer
  - `quota_remaining` integer

## Response `200`

User status successfully retrieved.

- UserStatusResponse
  - `success` boolean
  - `active` boolean
  - `plan_name` string
  - `quota_total` integer
  - `quota_used` integer
  - `quota_remaining` integer

---

[API](https://skmtc.dev/kraken-io/apis/kraken-io-api-documentation.md) · [All operations](https://skmtc.dev/kraken-io/apis/kraken-io-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/kraken-io/apis/kraken-io-api-documentation/revisions/918d4599daf3?raw)