{
  "info": {
    "title": "Weather API",
    "description": "A comprehensive weather API providing city information, weather data, and translation services",
    "version": "2.0.0",
    "author": "Ashlynn Repository",
    "Channel": "https://t.me/Ashlynn_Repository",
    "Github": {
      "name": "Itz-Ashlynn",
      "url": "https://github.com/Itz-Ashlynn"
    }
  },
  "Telegram": [
    {
      "url": "https://t.me/Ashlynn_Repository",
      "description": "Official Telegram Channel of the creator of this API join for more apis and bots"
    }
  ],
  "endpoints": {
    "/geo-city": {
      "method": "GET",
      "description": "Get city information by geographic coordinates",
      "parameters": [
        {
          "name": "lat",
          "type": "number",
          "required": true,
          "description": "Latitude coordinate",
          "example": 19.076
        },
        {
          "name": "lon",
          "type": "number",
          "required": true,
          "description": "Longitude coordinate",
          "example": 72.8777
        }
      ],
      "requestExample": "/geo-city?lat=19.0760&lon=72.8777",
      "responseStructure": {
        "success": "boolean",
        "code": "number",
        "result": {
          "module": "string",
          "input": "object",
          "data": "object (API response)"
        }
      },
      "responseExample": {
        "success": true,
        "code": 200,
        "result": {
          "module": "GEO_CITY",
          "input": {
            "latitude": "19.0760",
            "longitude": "72.8777"
          },
          "data": {}
        }
      },
      "errorResponses": [
        {
          "code": 400,
          "description": "Missing required parameters",
          "example": {
            "success": false,
            "code": 400,
            "result": {
              "module": "GEO_CITY",
              "input": {},
              "error": "Latitude and longitude must be provided"
            }
          }
        }
      ]
    },
    "/search-city": {
      "method": "GET",
      "description": "Search for cities by name",
      "parameters": [
        {
          "name": "name",
          "type": "string",
          "required": true,
          "description": "City name to search for",
          "example": "delhi"
        }
      ],
      "requestExample": "/search-city?name=delhi",
      "responseStructure": {
        "success": "boolean",
        "code": "number",
        "result": {
          "module": "string",
          "input": "object",
          "data": "object (API response)"
        }
      },
      "responseExample": {
        "success": true,
        "code": 200,
        "result": {
          "module": "SEARCH_CITY",
          "input": {
            "name": "delhi"
          },
          "data": {}
        }
      },
      "errorResponses": [
        {
          "code": 400,
          "description": "Missing city name",
          "example": {
            "success": false,
            "code": 400,
            "result": {
              "module": "SEARCH_CITY",
              "input": {},
              "error": "City name must be provided"
            }
          }
        }
      ]
    },
    "/hot-cities": {
      "method": "GET",
      "description": "Get popular cities for a specific locale",
      "parameters": [
        {
          "name": "locale",
          "type": "string",
          "required": false,
          "description": "Locale code (default: en_US)",
          "example": "en_US"
        }
      ],
      "requestExample": "/hot-cities?locale=en_US",
      "responseStructure": {
        "success": "boolean",
        "code": "number",
        "result": {
          "module": "string",
          "input": "object",
          "data": "object (API response)"
        }
      },
      "responseExample": {
        "success": true,
        "code": 200,
        "result": {
          "module": "HOT_CITIES",
          "input": {
            "locale": "en_US"
          },
          "data": {}
        }
      },
      "errorResponses": [
        {
          "code": 400,
          "description": "Missing locale parameter",
          "example": {
            "success": false,
            "code": 400,
            "result": {
              "module": "HOT_CITIES",
              "input": {},
              "error": "Locale parameter must be provided"
            }
          }
        }
      ]
    },
    "/translate": {
      "method": "GET",
      "description": "Translate city data to another locale",
      "parameters": [
        {
          "name": "cityData",
          "type": "JSON string",
          "required": true,
          "description": "City data object with latitude, longitude, name, and optional properties",
          "example": {
            "latitude": "19.0760",
            "longitude": "72.8777",
            "name": "Mumbai",
            "belongings": "Maharashtra, India",
            "extra": "accu:3352496",
            "locale": "en_US"
          }
        },
        {
          "name": "targetLocale",
          "type": "string",
          "required": true,
          "description": "Target locale code for translation",
          "example": "hi_IN"
        }
      ],
      "requestExample": "/translate?cityData={\"latitude\":\"19.0760\",\"longitude\":\"72.8777\",\"name\":\"Mumbai\"}&targetLocale=hi_IN",
      "responseStructure": {
        "success": "boolean",
        "code": "number",
        "result": {
          "module": "string",
          "input": "object",
          "data": "object (API response)"
        }
      },
      "responseExample": {
        "success": true,
        "code": 200,
        "result": {
          "module": "TRANSLATE",
          "input": {
            "cityData": {
              "latitude": "19.0760",
              "longitude": "72.8777",
              "name": "Mumbai"
            },
            "targetLocale": "hi_IN"
          },
          "data": {}
        }
      },
      "errorResponses": [
        {
          "code": 400,
          "description": "Invalid city data or missing parameters",
          "example": {
            "success": false,
            "code": 400,
            "result": {
              "module": "TRANSLATE",
              "input": {},
              "error": "Complete city data and target locale must be provided"
            }
          }
        }
      ]
    },
    "/bg-weather": {
      "method": "GET",
      "description": "Get background weather information for a location",
      "parameters": [
        {
          "name": "lat",
          "type": "number",
          "required": true,
          "description": "Latitude coordinate",
          "example": 19.076
        },
        {
          "name": "lon",
          "type": "number",
          "required": true,
          "description": "Longitude coordinate",
          "example": 72.8777
        },
        {
          "name": "isLocated",
          "type": "string",
          "required": false,
          "description": "Is located flag (default: true)",
          "example": "true"
        },
        {
          "name": "locationKey",
          "type": "string",
          "required": true,
          "description": "Location key identifier",
          "example": "accu:3352466"
        }
      ],
      "requestExample": "/bg-weather?lat=19.0760&lon=72.8777&locationKey=accu:3352466",
      "responseStructure": {
        "success": "boolean",
        "code": "number",
        "result": {
          "module": "string",
          "input": "object",
          "data": "object (API response)"
        }
      },
      "responseExample": {
        "success": true,
        "code": 200,
        "result": {
          "module": "BACKGROUND_WEATHER",
          "input": {
            "latitude": "19.0760",
            "longitude": "72.8777",
            "isLocated": "true",
            "locationKey": "accu:3352466"
          },
          "data": {}
        }
      },
      "errorResponses": [
        {
          "code": 400,
          "description": "Missing required parameters",
          "example": {
            "success": false,
            "code": 400,
            "result": {
              "module": "BACKGROUND_WEATHER",
              "input": {},
              "error": "Latitude, longitude, and location key are required"
            }
          }
        }
      ]
    },
    "/all-weather": {
      "method": "GET",
      "description": "Get complete weather data including 15-day forecast",
      "parameters": [
        {
          "name": "lat",
          "type": "number",
          "required": true,
          "description": "Latitude coordinate",
          "example": 19.076
        },
        {
          "name": "lon",
          "type": "number",
          "required": true,
          "description": "Longitude coordinate",
          "example": 72.8777
        },
        {
          "name": "isLocated",
          "type": "string",
          "required": false,
          "description": "Is located flag (default: true)",
          "example": "true"
        },
        {
          "name": "locationKey",
          "type": "string",
          "required": true,
          "description": "Location key identifier",
          "example": "accu:3352466"
        }
      ],
      "requestExample": "/all-weather?lat=19.0760&lon=72.8777&locationKey=accu:3352466",
      "responseStructure": {
        "success": "boolean",
        "code": "number",
        "result": {
          "module": "string",
          "input": "object",
          "data": "object (API response)"
        }
      },
      "responseExample": {
        "success": true,
        "code": 200,
        "result": {
          "module": "ALL_WEATHER",
          "input": {
            "latitude": "19.0760",
            "longitude": "72.8777",
            "isLocated": "true",
            "locationKey": "accu:3352466"
          },
          "data": {}
        }
      },
      "errorResponses": [
        {
          "code": 400,
          "description": "Missing required parameters",
          "example": {
            "success": false,
            "code": 400,
            "result": {
              "module": "ALL_WEATHER",
              "input": {},
              "error": "Latitude, longitude, and location key are required"
            }
          }
        }
      ]
    }
  },
  "commonResponses": {
    "404": {
      "description": "Endpoint not found",
      "example": {
        "success": false,
        "code": 404,
        "result": {
          "error": "Endpoint not found"
        }
      }
    },
    "405": {
      "description": "Method not allowed",
      "example": {
        "success": false,
        "code": 405,
        "result": {
          "error": "Method not allowed"
        }
      }
    },
    "500": {
      "description": "Internal server error",
      "example": {
        "success": false,
        "code": 500,
        "result": {
          "error": "Internal server error"
        }
      }
    }
  },
  "usage": {
    "authentication": "No authentication required",
    "rateLimiting": "No rate limiting applied",
    "cors": "CORS enabled for all origins"
  },
  "examples": {
    "Complete Workflow": [
      "1. Search for a city: GET /search-city?name=mumbai",
      "2. Get city coordinates from search result",
      "3. Get weather data: GET /all-weather?lat=19.0760&lon=72.8777&locationKey=accu:3352466",
      "4. Translate city name: GET /translate?cityData={\"latitude\":\"19.0760\",\"longitude\":\"72.8777\",\"name\":\"Mumbai\"}&targetLocale=hi_IN"
    ]
  }
}