---
title: "Get your account"
method: GET
path: "/account"
tags: ["Account"]
---

# Get your account

`GET /account`

## Request

- Base URL: `https://www.iminify.com/api/v1`
- URL: `https://www.iminify.com/api/v1/account`
- Auth: HTTP bearer

Your plan, what it allows and how much of today's allowance is gone. The website and the API spend the same daily counts, so an image compressed on the site shows up in `usage` here too. A limit of `null` means no daily cap. The window is a rolling 24 hours that starts with your first image or scan, not midnight, so `resets_at` is `null` until something has been used. This is also the cheapest way to check that a key works.

## Response `200`

OK.

- object
  - `data` Account, required
    - `name` string, required: The account's name.
    - `email` string, email, required: Its email address.
    - `plan` 'free' | 'pro', required: The plan the account is on.
    - `plan_ends_at` string, date-time, nullable, required: When a Pro plan ends, or `null` while it renews or on the free plan.
    - `limits` object, required: What the plan allows.
      - `images_per_day` integer, nullable, required: Images a rolling 24 hours, or `null` for no daily cap.
      - `scans_per_day` integer, nullable, required: Page scans a rolling 24 hours, or `null` for no daily cap.
      - `alt_texts_per_day` integer, nullable, required: AI alt texts a rolling 24 hours, or `null` for no daily cap.
      - `images_per_scan` integer, required: The most images one page scan compresses.
      - `max_file_size` integer, required: The largest file you can upload or have fetched, in bytes.
      - `max_megapixels` integer, required: The most pixels an image, or the image a resize would produce, may have, in millions.
      - `compressions_per_minute` integer, required: Compressions you can queue in a minute: uploads, recompresses and retries together, from the API and the website combined.
      - `scans_per_minute` integer, required: Page scans you can start in a minute, new and retried together, from the API and the website combined.
      - `requests_per_minute` integer, required: Calls to the API in a minute, of every kind.
      - `max_batch` integer, required: The most ids one batch call takes.
    - `usage` object, required: How much of the day's allowance is used. The website and the API spend the same counts.
      - `images` object, required: Images compressed.
        - `used` integer, required: How many the current window has used.
        - `remaining` integer, nullable, required: How many are left, or `null` on a plan without a daily cap.
        - `resets_at` string, date-time, nullable, required: When the window opens again, or `null` while nothing has been used. The window is a rolling 24 hours from the first use, not midnight.
      - `scans` object, required: Page scans run.
        - `used` integer, required: How many the current window has used.
        - `remaining` integer, nullable, required: How many are left, or `null` on a plan without a daily cap.
        - `resets_at` string, date-time, nullable, required: When the window opens again, or `null` while nothing has been used. The window is a rolling 24 hours from the first use, not midnight.
      - `alt_texts` object, required: AI alt texts written.
        - `used` integer, required: How many the current window has used.
        - `remaining` integer, nullable, required: How many are left, or `null` on a plan without a daily cap.
        - `resets_at` string, date-time, nullable, required: When the window opens again, or `null` while nothing has been used. The window is a rolling 24 hours from the first use, not midnight.

## Other responses

- `401`: `unauthenticated`: No key was sent, or the key does not exist (it was mistyped or deleted). Send it as `Authorization: Bearer <key>`.
- `403`: `email_not_verified`: The key belongs to an account whose email address is not verified yet. Follow the link in the verification email, then call again with the same key. `account_banned`: The account behind the key has been banned. Its keys stop working with the ban.
- `429`: `rate_limited`: One of your per-minute limits is spent: requests, compressions or page scans. The compressions and scans are counted together with the website's, so work queued there counts too. Nothing was done; wait for the number of seconds in the `Retry-After` header and send it again.

---

[API](https://skmtc.dev/iminify/apis/iminify-api.md) · [All operations](https://skmtc.dev/iminify/apis/iminify-api/llms.txt) · [OpenAPI document](https://skmtc.dev/iminify/apis/iminify-api/revisions/12dc614c2c21?raw)