WeatherAPI · Schema

BulkRequest

BulkRequest schema from WeatherAPI.com

WeatherForecastHistoryMarineAstronomyGeolocationSportsAlertsPublic APIs

Properties

Name Type Description
locations array
View JSON Schema on GitHub

JSON Schema

weatherapi-bulk-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/weatherapi/refs/heads/main/json-schema/weatherapi-bulk-request-schema.json",
  "title": "BulkRequest",
  "description": "BulkRequest schema from WeatherAPI.com",
  "type": "object",
  "properties": {
    "locations": {
      "type": "array",
      "maxItems": 50,
      "items": {
        "type": "object",
        "required": [
          "q"
        ],
        "properties": {
          "q": {
            "type": "string",
            "description": "Location query (same formats as q parameter)",
            "example": "sample value"
          },
          "custom_id": {
            "type": "string",
            "description": "Optional identifier echoed back in response",
            "example": "sample value"
          }
        }
      }
    }
  },
  "required": [
    "locations"
  ]
}