ColorfulClouds · JSON Structure

Caiyun Weather Envelope Base Structure

Common envelope fields returned by every Caiyun Weather endpoint.

Type: object Properties: 9 Required: 3
WeatherForecastingAir QualityPrecipitationHyperlocalGeospatialChina

EnvelopeBase is a JSON Structure definition published by ColorfulClouds, describing 9 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

status api_version api_status lang unit tzshift timezone server_time location

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/colorfulclouds/refs/heads/main/json-structure/caiyun-weather-envelope-base-structure.json",
  "name": "EnvelopeBase",
  "description": "Common envelope fields returned by every Caiyun Weather endpoint.",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "example": "ok"
    },
    "api_version": {
      "type": "string",
      "example": "v2.6"
    },
    "api_status": {
      "type": "string",
      "example": "active"
    },
    "lang": {
      "type": "string",
      "example": "en_US"
    },
    "unit": {
      "type": "string",
      "example": "metric:v2"
    },
    "tzshift": {
      "type": "int32",
      "description": "Time zone shift in seconds from UTC.",
      "example": 28800
    },
    "timezone": {
      "type": "string",
      "example": "Asia/Shanghai"
    },
    "server_time": {
      "type": "int32",
      "description": "Server time as Unix epoch seconds.",
      "example": 1748563200
    },
    "location": {
      "type": "array",
      "items": {
        "type": "float"
      },
      "minItems": 2,
      "maxItems": 2,
      "description": "Resolved (lat,lng) the response was generated for."
    }
  },
  "required": [
    "status",
    "api_version",
    "api_status"
  ]
}