{
  "name": "Stepzy Content API",
  "version": "1.0.0",
  "description": "A read-only, unauthenticated JSON API over everything getstepzy.com publishes: the Stepzy app's facts and release history, the documentation, the articles, and the eight walking calculators the site runs in the browser.",
  "openapi": "https://getstepzy.com/openapi.json",
  "documentation": "https://getstepzy.com/developers",
  "agentInstructions": "https://getstepzy.com/agents.md",
  "llmsTxt": "https://getstepzy.com/llms.txt",
  "authentication": "none",
  "conventions": {
    "methods": [
      "GET",
      "HEAD",
      "OPTIONS"
    ],
    "errors": "Every error is JSON: { error: { code, message, hint, status, documentation, openapi } }.",
    "cors": "Access-Control-Allow-Origin: * on every response.",
    "markdown": "Any page URL also serves Markdown via `Accept: text/markdown`, or by appending `.md`."
  },
  "endpoints": [
    {
      "method": "GET",
      "path": "/api/v1",
      "operationId": "getApiIndex",
      "summary": "This document."
    },
    {
      "method": "GET",
      "path": "/api/v1/app",
      "operationId": "getApp",
      "summary": "Stepzy's facts, platforms, pricing and rating."
    },
    {
      "method": "GET",
      "path": "/api/v1/releases",
      "operationId": "listReleases",
      "summary": "Release notes, newest first."
    },
    {
      "method": "GET",
      "path": "/api/v1/articles",
      "operationId": "listArticles",
      "summary": "Blog articles, newest first."
    },
    {
      "method": "GET",
      "path": "/api/v1/articles/{slug}",
      "operationId": "getArticle",
      "summary": "One article's metadata."
    },
    {
      "method": "GET",
      "path": "/api/v1/docs",
      "operationId": "listDocs",
      "summary": "Documentation pages, grouped by section."
    },
    {
      "method": "GET",
      "path": "/api/v1/docs/{slug}",
      "operationId": "getDoc",
      "summary": "One documentation page, full text as Markdown."
    },
    {
      "method": "GET",
      "path": "/api/v1/calculators",
      "operationId": "listCalculators",
      "summary": "The eight calculators and their parameters."
    },
    {
      "method": "GET",
      "path": "/api/v1/calculators/steps-to-calories",
      "operationId": "calculateStepsToCalories",
      "summary": "Estimate calories burned from a step count and body weight."
    },
    {
      "method": "GET",
      "path": "/api/v1/calculators/steps-to-miles",
      "operationId": "calculateStepsToMiles",
      "summary": "Convert a step count into miles and kilometres."
    },
    {
      "method": "GET",
      "path": "/api/v1/calculators/daily-step-goal",
      "operationId": "calculateDailyStepGoal",
      "summary": "Suggest a next daily step goal from a current average."
    },
    {
      "method": "GET",
      "path": "/api/v1/calculators/walking-time",
      "operationId": "calculateWalkingTime",
      "summary": "Estimate how long a step count takes to walk."
    },
    {
      "method": "GET",
      "path": "/api/v1/calculators/bmi",
      "operationId": "calculateBmi",
      "summary": "Body Mass Index and its WHO category."
    },
    {
      "method": "GET",
      "path": "/api/v1/calculators/tdee",
      "operationId": "calculateTdee",
      "summary": "Basal metabolic rate and total daily energy expenditure."
    },
    {
      "method": "GET",
      "path": "/api/v1/calculators/heart-rate-zones",
      "operationId": "calculateHeartRateZones",
      "summary": "Estimated maximum heart rate and training zones."
    },
    {
      "method": "GET",
      "path": "/api/v1/calculators/water-intake",
      "operationId": "calculateWaterIntake",
      "summary": "A baseline daily water target from body weight and exercise."
    },
    {
      "method": "GET",
      "path": "/api/v1/search",
      "operationId": "searchContent",
      "summary": "Keyword search across articles, docs and calculators."
    }
  ]
}