> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# Get usage statistics

GET https://api.runtype.com/v1/usage-limits

Get usage statistics for the authenticated user. Returns V3 execution stats with backward-compatible token-style fields. Token usage is tracked via Analytics Engine.

Reference: https://docs.runtype.com/api-reference/runtype-api/usage-limits/get-usage-statistics

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Response

### 200

Usage statistics

- `usage` (UsageResponseUsage, required)

## Errors

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 403 Forbidden Error

Insufficient permissions

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 500 Internal Server Error

Internal server error

- `code` (string, required) — Stable error code: `INTERNAL_ERROR` unless the route documents its own.
- `error` (string, required)
- `details` (list of InternalErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.
- `message` (string, optional) — Plain-language guidance: retry, then contact support with the `requestId`.
- `requestId` (string, optional) — The `X-Runtype-Request-ID` of the failed request, for support.

### 503 Service Unavailable Error

Database temporarily unavailable; nothing was read or written. Retry after the `Retry-After` interval (seconds).

- `code` (enum, required) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
  - Allowed values: `DATABASE_UNAVAILABLE`
- `error` (string, required)
- `details` (list of DatabaseUnavailableErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.
- `requestId` (string, optional) — The `X-Runtype-Request-ID` of the failed request, for support.

## Types

### UsageResponseUsage

- `atSpendLimit` (boolean, required)
- `isNearLimit` (boolean, required)
- `isOverLimit` (boolean, required)
- `isUnlimited` (boolean, required)
- `month` (string, required)
- `percentUsed` (double, required)
- `platformTokenLimit` (double, required, nullable)
- `platformTokensUsed` (double, required)
- `remaining` (double, required, nullable)
- `spendLimit` (double, required, nullable)
- `spendLimitEnabled` (boolean, required)
- `userId` (string, required)
- `daily` (UsageResponseUsageDaily, optional)
- `monthly` (UsageResponseUsageMonthly, optional)

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### InternalErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### DatabaseUnavailableErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### UsageResponseUsageDaily

- `atSpendLimit` (boolean, required)
- `date` (string, required)
- `executionCapReason` (enum, required)
  - Allowed values: `no_card_ceiling`
- `executionLimit` (double, required)
- `executionsUsed` (double, required)
- `inSlowMode` (boolean, required)
- `isAtLimit` (boolean, required)
- `isNearLimit` (boolean, required)
- `isOverage` (boolean, required)
- `isUnlimited` (boolean, required)
- `overageCount` (double, required)
- `percentUsed` (double, required)
- `periodType` (string, required)
- `remaining` (double, required, nullable)
- `resetsAt` (string, required)
- `spendLimit` (double, required, nullable)
- `spendLimitEnabled` (boolean, required)
- `tier` (string, required)

### UsageResponseUsageMonthly

- `atSpendLimit` (boolean, required)
- `date` (string, required)
- `executionCapReason` (enum, required)
  - Allowed values: `no_card_ceiling`
- `executionLimit` (double, required)
- `executionsUsed` (double, required)
- `inSlowMode` (boolean, required)
- `isAtLimit` (boolean, required)
- `isNearLimit` (boolean, required)
- `isOverage` (boolean, required)
- `isUnlimited` (boolean, required)
- `overageCount` (double, required)
- `percentUsed` (double, required)
- `periodType` (string, required)
- `remaining` (double, required, nullable)
- `resetsAt` (string, required)
- `spendLimit` (double, required, nullable)
- `spendLimitEnabled` (boolean, required)
- `tier` (string, required)

## Examples

**Response**

```json
{
  "usage": {
    "atSpendLimit": true,
    "isNearLimit": true,
    "isOverLimit": true,
    "isUnlimited": true,
    "month": "string",
    "percentUsed": 1.1,
    "platformTokenLimit": 1.1,
    "platformTokensUsed": 1.1,
    "remaining": 1.1,
    "spendLimit": 1.1,
    "spendLimitEnabled": true,
    "userId": "string",
    "daily": {
      "atSpendLimit": true,
      "date": "string",
      "executionCapReason": "no_card_ceiling",
      "executionLimit": 1.1,
      "executionsUsed": 1.1,
      "inSlowMode": true,
      "isAtLimit": true,
      "isNearLimit": true,
      "isOverage": true,
      "isUnlimited": true,
      "overageCount": 1.1,
      "percentUsed": 1.1,
      "periodType": "string",
      "remaining": 1.1,
      "resetsAt": "string",
      "spendLimit": 1.1,
      "spendLimitEnabled": true,
      "tier": "string"
    },
    "monthly": {
      "atSpendLimit": true,
      "date": "string",
      "executionCapReason": "no_card_ceiling",
      "executionLimit": 1.1,
      "executionsUsed": 1.1,
      "inSlowMode": true,
      "isAtLimit": true,
      "isNearLimit": true,
      "isOverage": true,
      "isUnlimited": true,
      "overageCount": 1.1,
      "percentUsed": 1.1,
      "periodType": "string",
      "remaining": 1.1,
      "resetsAt": "string",
      "spendLimit": 1.1,
      "spendLimitEnabled": true,
      "tier": "string"
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.runtype.com/v1/usage-limits"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.runtype.com/v1/usage-limits';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/usage-limits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/usage-limits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.runtype.com/v1/usage-limits")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.runtype.com/v1/usage-limits', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/usage-limits");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/usage-limits")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```