---
title: "Quota, compteur de lecture et portees de l'identite appelante"
method: GET
path: "/me/usage"
tags: ["usage"]
---

# Quota, compteur de lecture et portees de l'identite appelante

`GET /me/usage`

## Request

- Base URL: `https://jam-jam.org/api/v1`
- URL: `https://jam-jam.org/api/v1/me/usage`
- Auth: one of:
  - HTTP bearer
  - none

Ce que l'identite appelante peut faire, en un seul appel, sans avoir
a l'essayer.

- `conversion` : compteur partage avec l'export du carnet dans
  l'application (10 / semaine glissante gratuit, 500 / mois
  calendaire Premium, 3 / 24 h glissantes anonyme) ;
- `read` : compteur de LECTURE de l'API (`/me/songs*`,
  `/me/playlists*`), journalier UTC, absent pour un anonyme.
  Consulter son solde ne le consomme pas ;
- `scopes` : les portees reellement exercables. Une cle API rend les
  siennes ; un JWT d'application n'etant pas restreint, il rend la
  liste complete.

## Response `200`

Usage

- Usage
  - `ownerKind` 'anon' | 'user' | 'api', required
  - `unlimited` boolean, required
  - `conversion` QuotaBucket, required
    - `used` integer, required
    - `limit` integer, nullable, required
    - `window` 'rolling-24h' | 'iso-week' | 'calendar-month' | 'day-utc', required
    - `resetsAt` string, date-time, required
  - `carnet` QuotaBucket
    - `used` integer, required
    - `limit` integer, nullable, required
    - `window` 'rolling-24h' | 'iso-week' | 'calendar-month' | 'day-utc', required
    - `resetsAt` string, date-time, required
  - `read` QuotaBucket
    - `used` integer, required
    - `limit` integer, nullable, required
    - `window` 'rolling-24h' | 'iso-week' | 'calendar-month' | 'day-utc', required
    - `resetsAt` string, date-time, required
  - `write` QuotaBucket
    - `used` integer, required
    - `limit` integer, nullable, required
    - `window` 'rolling-24h' | 'iso-week' | 'calendar-month' | 'day-utc', required
    - `resetsAt` string, date-time, required
  - `stems` QuotaBucket
    - `used` integer, required
    - `limit` integer, nullable, required
    - `window` 'rolling-24h' | 'iso-week' | 'calendar-month' | 'day-utc', required
    - `resetsAt` string, date-time, required
  - `scopes` string[], required: Portees reellement exercables par l'identite appelante.

## Other responses

- `401`: Toute erreur de cette API, quel que soit le code HTTP, est un `application/problem+json` (RFC 9457) avec ce meme schema : `code` est la valeur stable a tester par un client (le `status` HTTP peut varier legerement selon le contexte, `code` non). `quota` est renseigne pour les erreurs liees au quota (`quota-exhausted`, `anon-quota-exhausted`, `client-quota`).
- `403`: Toute erreur de cette API, quel que soit le code HTTP, est un `application/problem+json` (RFC 9457) avec ce meme schema : `code` est la valeur stable a tester par un client (le `status` HTTP peut varier legerement selon le contexte, `code` non). `quota` est renseigne pour les erreurs liees au quota (`quota-exhausted`, `anon-quota-exhausted`, `client-quota`).

---

[API](https://skmtc.dev/jam-jam/apis/jam-jam-convert-api.md) · [All operations](https://skmtc.dev/jam-jam/apis/jam-jam-convert-api/llms.txt) · [OpenAPI document](https://skmtc.dev/jam-jam/apis/jam-jam-convert-api/revisions/64cd41a46e4e?raw)