# The index

What the API serves, as JSON. The one page to read by machine.

`GET https://api.dietbloxycola.com/v1` (cached 3600 s)

## Request

cURL:

```bash
curl https://api.dietbloxycola.com/v1
```
JavaScript:

```js
const res = await fetch("https://api.dietbloxycola.com/v1");
const index = await res.json();
```
Python:

```python
import requests

index = requests.get("https://api.dietbloxycola.com/v1", timeout=10).json()
```
Luau:

```lua
-- HttpService must be on in the game's settings.
local HttpService = game:GetService("HttpService")

local body = HttpService:GetAsync("https://api.dietbloxycola.com/v1")
local index = HttpService:JSONDecode(body)
```

## Response

200 OK:

```json
{
  "name": "Diet Bloxy Cola public API",
  "endpoints": [
    {
      "method": "GET",
      "path": "/v1",
      "description": "This index."
    },
    {
      "method": "GET",
      "path": "/v1/live",
      "description": "Players online, visits and favorites across the studio, right now."
    },
    {
      "method": "GET",
      "path": "/v1/games",
      "description": "Every public game with its live counts and votes."
    },
    {
      "method": "GET",
      "path": "/v1/games/{universeId}",
      "description": "One game by universe id."
    },
    {
      "method": "GET",
      "path": "/v1/limits",
      "description": "Every Roblox platform limit the studio's games run against, with the date it was read."
    },
    {
      "method": "GET",
      "path": "/v1/limits/{id}",
      "description": "One platform limit by id."
    },
    {
      "method": "GET",
      "path": "/v1/account",
      "description": "The account behind the key: plan, status, and the limits each product allows it."
    },
    {
      "method": "GET",
      "path": "/v1/account/keys",
      "description": "The account's keys, never their secrets."
    },
    {
      "method": "GET",
      "path": "/v1/account/usage",
      "description": "Requests and errors per product and route, by hour."
    },
    {
      "method": "GET",
      "path": "/v1/account/export",
      "description": "Everything held about the account, as one JSON document."
    },
    {
      "method": "DELETE",
      "path": "/v1/account",
      "description": "Asks for the account's deletion: keys die now, the rows go after the grace."
    }
  ],
  "docs": "https://api.dietbloxycola.com"
}
```

`endpoints` lists every path with its method and a one-line description; `docs` points here. New endpoints appear in this list the day they ship.