---
title: "Get the balance-over-time series"
method: GET
path: "/credits/usage/balance_timeseries/"
tags: ["credits"]
---

# Get the balance-over-time series

`GET /credits/usage/balance_timeseries/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/credits/usage/balance_timeseries/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Get the balance series for the usage overview chart.

## Query parameters

- `start_time` string, date-time, required: Range start (ISO 8601)
- `end_time` string, date-time, required: Range end (ISO 8601)
- `interval` 'hour' | 'day'
- `timezone` string: IANA timezone for buckets

## Response `200`

Successful Response

- CreditBalanceTimeseriesResponseSchema: The balance-over-time series for the usage overview chart.
  - `buckets` CreditBalancePointSchema[], required: Zero-gap series; the last known balance carries through empty buckets.
    - `balance` number, required: In decimal credits.
    - `bucket_start` string, date-time, required
  - `clamped_start` string, date-time, nullable, required: Set when the requested start predated the detail boundary and the series was clamped.
  - `interval` string, required: Bucket size as served: hour or day.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)