{
  "openapi": "3.0.3",
  "info": {
    "title": "Kalkulator czynszu — Zarządzanie Najmem (akcja do asystentów)",
    "version": "1.0.0",
    "description": "Uproszczona specyfikacja akcji dla kreatorów asystentów (ChatGPT Actions i podobne). Publiczne API orientacyjnej stawki czynszu najmu dla Katowic, Sosnowca, Chorzowa, Mysłowic i Siemianowic Śląskich. Bez tokenu, limit 40 żądań na minutę. Pełna specyfikacja: https://zarzadzanienajmem.pl/openapi.json",
    "contact": {
      "url": "https://zarzadzanienajmem.pl/kontakt/"
    }
  },
  "servers": [
    {
      "url": "https://zarzadzanienajmem.pl",
      "description": "Produkcja"
    }
  ],
  "paths": {
    "/api/wycena/meta": {
      "get": {
        "operationId": "wycenaMeta",
        "summary": "Dostępne wartości kontrolek kalkulatora",
        "description": "Zwraca datę danych i dla każdego miasta dostępne liczby pokoi, typy budynków, zakresy metrażu, domyślny metraż i dzielnice. Użyj przed wyceną, żeby poznać poprawne wartości pól. Pole podglad zawiera wspólny stan początkowy i gotowy wynik, bez automatycznego POST.",
        "responses": {
          "200": {
            "description": "Metadane kontrolek",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "ok": {
                      "type": "boolean"
                    },
                    "wygenerowano": {
                      "type": "string",
                      "description": "Data zbioru ofert, format RRRR-MM-DD"
                    },
                    "miasta": {
                      "type": "object",
                      "description": "Klucze to nazwy miast; wartości podają dostępne pokoje, budynki, zakresy metrażu, domyślny metraż i dzielnice."
                    },
                    "podglad": {
                      "type": "object",
                      "nullable": true,
                      "properties": {
                        "parametry": {
                          "$ref": "#/components/schemas/WycenaRequest"
                        },
                        "wynik": {
                          "$ref": "#/components/schemas/WycenaResponse"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "Dane chwilowo niedostępne",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Blad"
                }
              }
            }
          }
        }
      }
    },
    "/api/wycena": {
      "post": {
        "operationId": "wycenaCzynszu",
        "summary": "Orientacyjna stawka czynszu najmu dla mieszkania",
        "description": "Zwraca widełki miesięcznej stawki najmu w złotych (low, center, high) dla wskazanego mieszkania, liczbę porównanych ogłoszeń i datę zbioru. To ceny ofertowe, nie transakcyjne. Podawaj wynik jako orientacyjny, z widełkami i datą; przy mode = manual odeślij użytkownika do kontaktu.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WycenaRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Wynik wyceny",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WycenaResponse"
                }
              }
            }
          },
          "400": {
            "description": "Niepoprawne pole (error wskazuje nazwę pola)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Blad"
                }
              }
            }
          },
          "429": {
            "description": "Przekroczony limit żądań",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Blad"
                }
              }
            }
          },
          "503": {
            "description": "Dane chwilowo niedostępne",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Blad"
                }
              }
            }
          }
        }
      }
    },
    "/api/wycena/v2": {
      "post": {
        "operationId": "wycenaCzynszuInteraktywna",
        "summary": "Orientacyjna stawka czynszu najmu dla mieszkania",
        "description": "Zwraca widełki miesięcznej stawki najmu w złotych (low, center, high) dla wskazanego mieszkania, liczbę porównanych ogłoszeń i datę zbioru. To ceny ofertowe, nie transakcyjne. Podawaj wynik jako orientacyjny, z widełkami i datą; przy mode = manual odeślij użytkownika do kontaktu. Wersja dla kalkulatora z gotowym podglądem startowym w metadanych; POST po użyciu kontrolek. Dotychczasowe /api/wycena pozostaje zgodne.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WycenaRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Wynik wyceny",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WycenaResponse"
                }
              }
            }
          },
          "400": {
            "description": "Niepoprawne pole (error wskazuje nazwę pola)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Blad"
                }
              }
            }
          },
          "429": {
            "description": "Przekroczony limit żądań",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Blad"
                }
              }
            }
          },
          "503": {
            "description": "Dane chwilowo niedostępne",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Blad"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Blad": {
        "type": "object",
        "properties": {
          "ok": {
            "type": "boolean",
            "description": "Zawsze false przy błędzie"
          },
          "error": {
            "type": "string",
            "description": "Kod błędu, np. miasto, pokoje, budynek, std, metraz, dzielnica, rate, wycena-unavailable"
          }
        }
      },
      "WycenaRequest": {
        "type": "object",
        "required": [
          "miasto",
          "pokoje",
          "budynek",
          "metraz"
        ],
        "properties": {
          "miasto": {
            "type": "string",
            "description": "Nazwa miasta dokladnie jak w meta, np. Katowice",
            "enum": [
              "Katowice",
              "Sosnowiec",
              "Chorzów",
              "Mysłowice",
              "Siemianowice Śląskie"
            ]
          },
          "pokoje": {
            "type": "string",
            "description": "Liczba pokoi",
            "enum": [
              "1",
              "2",
              "3",
              "4+"
            ]
          },
          "budynek": {
            "type": "string",
            "description": "Typ budynku",
            "enum": [
              "blok",
              "kamienica",
              "apartamentowiec"
            ]
          },
          "std": {
            "type": "string",
            "description": "Standard mieszkania; domyslnie sredni",
            "enum": [
              "niski",
              "sredni",
              "wysoki"
            ]
          },
          "metraz": {
            "type": "number",
            "description": "Metraz mieszkania w m2, od 10 do 200"
          },
          "dzielnica": {
            "type": "string",
            "description": "Opcjonalna dzielnica z listy dla wybranego miasta; pusty string oznacza cale miasto"
          }
        }
      },
      "WycenaResponse": {
        "type": "object",
        "properties": {
          "ok": {
            "type": "boolean"
          },
          "wygenerowano": {
            "type": "string",
            "description": "Data zbioru ofert, z ktorego policzono wynik"
          },
          "mode": {
            "type": "string",
            "description": "point: probka wystarczajaca; range: szerszy rozrzut danych; manual: brak danych dla tego zestawu",
            "enum": [
              "point",
              "range",
              "manual"
            ]
          },
          "low": {
            "type": "number",
            "nullable": true,
            "description": "Dolna widełka stawki miesięcznej w zł"
          },
          "center": {
            "type": "number",
            "nullable": true,
            "description": "Środkowa stawka miesięczna w zł"
          },
          "high": {
            "type": "number",
            "nullable": true,
            "description": "Górna widełka stawki miesięcznej w zł"
          },
          "comparableCount": {
            "type": "integer",
            "description": "Liczba porównanych ogłoszeń"
          },
          "effectiveSampleSize": {
            "type": "number",
            "description": "Wielkość próby po ważeniu czasowym"
          },
          "buildingShare": {
            "type": "number",
            "description": "Udział ofert z tego samego typu budynku, od 0 do 1"
          }
        }
      }
    }
  }
}