{
 "openapi": "3.1.0",
 "info": {
  "title": "Tidy Quid planner API",
  "version": "1.0.2",
  "description": "Read-only product catalogue and free UK budget helpers from Tidy Quid. Tidy Quid makes planners and organisers only. This is arithmetic and product information, not financial, tax or legal advice. Prices are list prices in GBP as of 2026-11-21; check the store page for the live price."
 },
 "servers": [
  {
   "url": "https://tidyquid.svenco.workers.dev"
  }
 ],
 "paths": {
  "/api/products": {
   "get": {
    "operationId": "searchProducts",
    "summary": "List or search Tidy Quid planners",
    "parameters": [
     {
      "name": "country",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "category",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "q",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "max_price_gbp",
      "in": "query",
      "required": false,
      "schema": {
       "type": "number"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Products"
     }
    }
   }
  },
  "/api/recommend": {
   "get": {
    "operationId": "recommendPlanner",
    "summary": "Best planner for a country and need",
    "parameters": [
     {
      "name": "country",
      "in": "query",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "need",
      "in": "query",
      "required": true,
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Recommendation"
     }
    }
   }
  },
  "/api/budget-check": {
   "get": {
    "operationId": "ukBudgetCheck",
    "summary": "Free 50/30/20 split of UK take-home pay",
    "parameters": [
     {
      "name": "take_home",
      "in": "query",
      "required": true,
      "schema": {
       "type": "number"
      }
     },
     {
      "name": "pay_frequency",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "monthly_bills",
      "in": "query",
      "required": false,
      "schema": {
       "type": "number"
      }
     },
     {
      "name": "annual_bills",
      "in": "query",
      "required": false,
      "schema": {
       "type": "number"
      }
     },
     {
      "name": "goal",
      "in": "query",
      "required": false,
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "self_employed",
      "in": "query",
      "required": false,
      "schema": {
       "type": "boolean"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Budget split"
     }
    }
   }
  },
  "/api/uk-money-dates": {
   "get": {
    "operationId": "ukMoneyDates",
    "summary": "UK tax year, Self Assessment and ISA dates 2026/27",
    "responses": {
     "200": {
      "description": "Dates"
     }
    }
   }
  }
 }
}