{
  "name": "BSS Index API",
  "version": "2.2.0",
  "description": "Public JSON API for Bee Swarm Simulator item values: per-item documents, price history, beequip rolls, categories, market movers and a lean search index. All values are JSON numbers, all image URLs are absolute, CORS is open.",
  "origin": "https://bss-index.vercel.app",
  "generated": "2026-10-26T13:15:40.699Z",
  "itemCount": 330,
  "categoryCount": 18,
  "categories": [
    {
      "slug": "misc",
      "name": "Misc",
      "nameRu": "Разное",
      "categoryRu": "Разное",
      "count": 90
    },
    {
      "slug": "beequips",
      "name": "Beequips",
      "nameRu": "Биквипы",
      "categoryRu": "Биквипы",
      "count": 41
    },
    {
      "slug": "stamps",
      "name": "Stamps",
      "nameRu": "Марки",
      "categoryRu": "Марки",
      "count": 19
    },
    {
      "slug": "tools",
      "name": "Tools",
      "nameRu": "Инструменты",
      "categoryRu": "Инструменты",
      "count": 19
    },
    {
      "slug": "mob-stickers",
      "name": "Mob Stickers",
      "nameRu": "Стикеры мобов",
      "categoryRu": "Стикеры мобов",
      "count": 18
    },
    {
      "slug": "bee-stickers",
      "name": "Bee Stickers",
      "nameRu": "Стикеры пчел",
      "categoryRu": "Стикеры пчел",
      "count": 17
    },
    {
      "slug": "gems",
      "name": "Gems",
      "nameRu": "Драгоценности",
      "categoryRu": "Драгоценности",
      "count": 16
    },
    {
      "slug": "bear-stickers",
      "name": "Bear Stickers",
      "nameRu": "Стикеры медведей",
      "categoryRu": "Стикеры медведей",
      "count": 14
    },
    {
      "slug": "art",
      "name": "Art",
      "nameRu": "Искусство",
      "categoryRu": "Искусство",
      "count": 12
    },
    {
      "slug": "cub-skins",
      "name": "Cub Skins",
      "nameRu": "Скины на каба",
      "categoryRu": "Скины на каба",
      "count": 12
    },
    {
      "slug": "hive-skins",
      "name": "Hive Skins",
      "nameRu": "Скины на улей",
      "categoryRu": "Скины на улей",
      "count": 12
    },
    {
      "slug": "star-signs",
      "name": "Star Signs",
      "nameRu": "Звездные знаки",
      "categoryRu": "Звездные знаки",
      "count": 12
    },
    {
      "slug": "beesmas-stickers",
      "name": "Beesmas Stickers",
      "nameRu": "Стикеры Пчелождества",
      "categoryRu": "Стикеры Пчелождества",
      "count": 11
    },
    {
      "slug": "leaves",
      "name": "Leaves",
      "nameRu": "Листья",
      "categoryRu": "Листья",
      "count": 11
    },
    {
      "slug": "mushrooms",
      "name": "Mushrooms",
      "nameRu": "Грибы",
      "categoryRu": "Грибы",
      "count": 10
    },
    {
      "slug": "vouchers",
      "name": "Vouchers",
      "nameRu": "Ваучеры",
      "categoryRu": "Ваучеры",
      "count": 6
    },
    {
      "slug": "flowers",
      "name": "Flowers",
      "nameRu": "Цветы",
      "categoryRu": "Цветы",
      "count": 5
    },
    {
      "slug": "nectar-icons",
      "name": "Nectar Icons",
      "nameRu": "Иконки нектара",
      "categoryRu": "Иконки нектара",
      "count": 5
    }
  ],
  "endpoints": [
    {
      "method": "GET",
      "path": "/api/v1/index.json",
      "summary": "API discovery document",
      "description": "Discovery document. Lists the API version, the origin, the item and category counts, every category, the demand/stability legends and the full endpoint catalogue. Start here.",
      "example": "https://bss-index.vercel.app/api/v1/index.json"
    },
    {
      "method": "GET",
      "path": "/api/v1/items.json",
      "summary": "All items",
      "description": "Every item of the catalogue in the compact shape, sorted by value descending. One array, no pagination needed.",
      "example": "https://bss-index.vercel.app/api/v1/items.json"
    },
    {
      "method": "GET",
      "path": "/api/v1/items/{slug}.json",
      "summary": "One item, full detail",
      "description": "Full record for a single item: the compact fields plus description, the dated price history, the beequip rolls and up to 10 related items.",
      "params": [
        {
          "name": "slug",
          "type": "string",
          "required": true,
          "description": "Item slug, e.g. \"star-cub\". See /api/v1/search-index.json for the full list."
        }
      ],
      "example": "https://bss-index.vercel.app/api/v1/items/star-cub.json"
    },
    {
      "method": "GET",
      "path": "/api/v1/items/{slug}/history.json",
      "summary": "Price history of one item",
      "description": "Price history of a single item as two parallel arrays (dates + prices) plus min/max/average and the 7d/30d changes. Only items with a recorded history have this file.",
      "params": [
        {
          "name": "slug",
          "type": "string",
          "required": true,
          "description": "Item slug, e.g. \"star-cub\"."
        }
      ],
      "example": "https://bss-index.vercel.app/api/v1/items/star-cub/history.json"
    },
    {
      "method": "GET",
      "path": "/api/v1/categories.json",
      "summary": "All categories",
      "description": "Every category with its slug, English name, Russian name, item count and value statistics (min, max, average, total).",
      "example": "https://bss-index.vercel.app/api/v1/categories.json"
    },
    {
      "method": "GET",
      "path": "/api/v1/categories/{slug}/items.json",
      "summary": "Items of one category",
      "description": "All items of one category in the same compact shape as /api/v1/items.json, sorted by value descending.",
      "params": [
        {
          "name": "slug",
          "type": "string",
          "required": true,
          "description": "Category slug, e.g. \"bee-stickers\". See /api/v1/categories.json for the full list."
        }
      ],
      "example": "https://bss-index.vercel.app/api/v1/categories/bee-stickers/items.json"
    },
    {
      "method": "GET",
      "path": "/api/v1/search",
      "summary": "Search items",
      "description": "Server-side search. Matches the name in either language, the slug, and the community slang for each category (so a Russian query finds the right group too). Returns items ranked by relevance, then by value.",
      "params": [
        {
          "name": "q",
          "type": "string",
          "description": "Search term, e.g. \"bee\", \"star cub\", \"kub\"."
        },
        {
          "name": "category",
          "type": "string",
          "description": "Filter by category slug, e.g. \"vouchers\", \"cub-skins\"."
        },
        {
          "name": "sort",
          "type": "string",
          "description": "relevance (default), value, value-asc, name, change."
        },
        {
          "name": "limit",
          "type": "integer",
          "description": "Items per page, 1-100, default 25."
        },
        {
          "name": "offset",
          "type": "integer",
          "description": "Offset for pagination, default 0."
        }
      ],
      "example": "https://bss-index.vercel.app/api/v1/search?q=bee&limit=10"
    },
    {
      "method": "GET",
      "path": "/api/v1/changes.json",
      "summary": "Market movers",
      "description": "Market movers: the 10 biggest gainers and the 10 biggest losers over the last 7 days, with their 30 day change. Items without enough history are skipped.",
      "example": "https://bss-index.vercel.app/api/v1/changes.json"
    },
    {
      "method": "GET",
      "path": "/api/v1/stats.json",
      "summary": "Market statistics",
      "description": "Market summary: item count, total/average/median/min/max value and how many items carry a price history.",
      "example": "https://bss-index.vercel.app/api/v1/stats.json"
    },
    {
      "method": "GET",
      "path": "/api/v1/search-index.json",
      "summary": "Lean search index",
      "description": "Small, lean index (slug, English and Russian names, English category, value) meant to be downloaded once and filtered client-side for instant search. No history, no colours.",
      "example": "https://bss-index.vercel.app/api/v1/search-index.json"
    },
    {
      "method": "GET",
      "path": "/api/v1/openapi.json",
      "summary": "OpenAPI 3.1 description",
      "description": "OpenAPI 3.1 description of this API. Point your API client, Swagger UI or Redoc at it.",
      "example": "https://bss-index.vercel.app/api/v1/openapi.json"
    },
    {
      "method": "GET",
      "path": "/api/v1/docs.html",
      "summary": "Human readable reference",
      "description": "Human readable API reference (this page).",
      "example": "https://bss-index.vercel.app/api/v1/docs.html"
    }
  ],
  "demandLevels": [
    {
      "value": "Low",
      "valueRu": "Низкий",
      "rank": 1,
      "description": "Low demand — sells slowly and usually below the listed value."
    },
    {
      "value": "Average",
      "valueRu": "Средний",
      "rank": 2,
      "description": "Average demand — takes a while to sell at the listed value."
    },
    {
      "value": "High",
      "valueRu": "Высокий",
      "rank": 3,
      "description": "High demand — sells quickly, often above the listed value."
    },
    {
      "value": "Hype",
      "valueRu": "Хайп",
      "rank": 4,
      "description": "Hype — everybody wants it, prices move fast and hard."
    }
  ],
  "stabilityLevels": [
    {
      "value": "Rising",
      "valueRu": "Растет",
      "rank": 1,
      "description": "The price is trending up over the recorded history."
    },
    {
      "value": "Stable",
      "valueRu": "Стабильно",
      "rank": 2,
      "description": "The price is holding steady."
    },
    {
      "value": "Falling",
      "valueRu": "Падает",
      "rank": 3,
      "description": "The price is trending down over the recorded history."
    }
  ],
  "documentation": "https://bss-index.vercel.app/api/v1/docs.html",
  "openapi": "https://bss-index.vercel.app/api/v1/openapi.json",
  "license": "MIT"
}