• API 功能

    • 支持城市名称、LocationID 和经纬度查询已覆盖国家和地区的空气质量;
    • 保留 city 参数兼容,并新增 location 与 lang 可选参数;
    • 返回 AQI、等级、颜色、首要污染物、PM2.5 和完整污染物浓度;
    • 返回一般人群与敏感人群健康建议,便于构建提醒和出行服务;
    • 返回参与结果的监测站信息,便于展示数据覆盖情况;
    • 使用 RetrievedAt 和 DataStatus 明确数据时间与新鲜度;
    • 上游短时异常时返回最近成功数据并标记 stale,避免误判为实时值;
    • 统一空气质量指数与污染物字段口径,便于跨地区展示和比较;
    • 全接口通过 HTTPS 提供服务;
    • 全面兼容 Apple ATS;
    • 全国多节点 CDN 部署;
    • 接口调用状态与状态监控
  • API 文档

    接口地址: https://api.gugudata.com/Weather/AirQuality

    返回格式: application/json; charset=utf-8

    请求方式: GET

    请求协议: HTTPS

    请求示例: https://api.gugudata.com/Weather/AirQuality?appkey=YOUR_APPKEY&location=%e5%8c%97%e4%ba%ac&lang=zh&city=%e5%8c%97%e4%ba%ac

    数据预览: https://www.gugudata.com/preview/airquality

    接口测试:  https://api.gugudata.com/Weather/AirQuality/demo

    OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

    请求参数(GET 请求方式可参见下方示例代码)

    参数名 参数类型 是否必须 默认值 备注
    appkey string YOUR_APPKEY 接口调用凭证,请在咕咕数据开发者中心获取
    location string 北京 推荐参数。支持城市名称、LocationID 或 经度,纬度;与 city 同时传递时优先生效
    city string 北京 兼容参数。城市名称;未传 location 时生效。location 与 city 至少传递一个
    lang string zh 返回语言,支持 zh 或 en,默认 zh

    返回参数

    参数名 参数类型 备注
    DataStatus.RequestParameter string 本次业务查询参数摘要,不包含 APPKEY
    DataStatus.StatusCode integer 业务状态码,100 表示成功
    DataStatus.StatusDescription string 业务状态说明
    DataStatus.ResponseDateTime string 服务端响应时间
    DataStatus.DataTotalCount integer 返回记录数量
    Data.Province string 一级行政区名称
    Data.City string 匹配到的位置名称
    Data.LocationId string 位置 LocationID
    Data.Latitude string 位置纬度
    Data.Longitude string 位置经度
    Data.Country string 国家或地区
    Data.AQI string 空气质量指数数值
    Data.AQIDisplay string 适合直接展示的 AQI 文本
    Data.AQILevel string AQI 等级
    Data.Quality string 空气质量等级描述
    Data.AQIColor object AQI 等级对应的 RGBA 颜色
    Data.AQIColor.Red integer 红色通道,范围 0 至 255
    Data.AQIColor.Green integer 绿色通道,范围 0 至 255
    Data.AQIColor.Blue integer 蓝色通道,范围 0 至 255
    Data.AQIColor.Alpha number 透明度
    Data.PM25 string PM2.5 浓度,单位见 Pollutants.Unit
    Data.PrimaryPollutant string 首要污染物显示名称
    Data.PrimaryPollutantCode string 首要污染物代码
    Data.PrimaryPollutantName string 首要污染物名称
    Data.PrimaryPollutantFullName string 首要污染物完整名称
    Data.HealthEffect string 当前空气质量可能造成的健康影响
    Data.GeneralPopulationAdvice string 一般人群健康建议
    Data.SensitivePopulationAdvice string 敏感人群健康建议
    Data.Pollutants array 主要污染物浓度及分项 AQI
    Data.Pollutants.Code string 污染物代码
    Data.Pollutants.Name string 污染物名称
    Data.Pollutants.FullName string 污染物完整名称
    Data.Pollutants.Concentration string 污染物浓度
    Data.Pollutants.Unit string 污染物浓度单位
    Data.Pollutants.AQI string 污染物分项 AQI
    Data.Pollutants.AQIDisplay string 污染物分项 AQI 展示文本
    Data.Stations array 参与当前结果的监测站列表
    Data.Stations.Id string 监测站标识
    Data.Stations.Name string 监测站名称
    Data.RetrievedAt string 本条空气质量数据的获取时间,ISO 8601 格式
    Data.DataStatus string fresh 表示新鲜数据,stale 表示上游异常时返回的最近成功数据

    响应示例

    接口数据预览
    {
      "DataStatus": {
        "RequestParameter": "location=北京&lang=zh",
        "StatusCode": 100,
        "StatusDescription": "请求成功。",
        "ResponseDateTime": "2026-08-09 18:30:00.000",
        "DataTotalCount": 1
      },
      "Data": [
        {
          "Province": "北京市",
          "City": "北京",
          "LocationId": "101010100",
          "Latitude": "39.9",
          "Longitude": "116.41",
          "Country": "中国",
          "AQI": "57",
          "AQIDisplay": "57",
          "AQILevel": "2",
          "Quality": "良",
          "AQIColor": {
            "Red": 255,
            "Green": 255,
            "Blue": 0,
            "Alpha": 1
          },
          "PM25": "26.57",
          "PrimaryPollutant": "O3",
          "PrimaryPollutantCode": "o3",
          "PrimaryPollutantName": "O3",
          "PrimaryPollutantFullName": "臭氧",
          "HealthEffect": "空气质量可接受。",
          "GeneralPopulationAdvice": "可以正常进行户外活动。",
          "SensitivePopulationAdvice": "敏感人群可适当减少长时间户外活动。",
          "Pollutants": [
            {
              "Code": "pm2p5",
              "Name": "PM2.5",
              "FullName": "细颗粒物",
              "Concentration": "26.57",
              "Unit": "μg/m³",
              "AQI": "35",
              "AQIDisplay": "35"
            }
          ],
          "Stations": [
            {
              "Id": "P001",
              "Name": "东城"
            }
          ],
          "RetrievedAt": "2026-08-09T10:30:00Z",
          "DataStatus": "fresh"
        }
      ]
    }
  • 鉴权方式

    接口支持以下 AppKey 传递方式,任选一种即可;已有请求示例、Postman 集合和历史代码仍可继续使用原来的 appkey 参数方式。

    传输载体 参数 示例 说明
    HTTP Header X-GUGUDATA-APPKEY X-GUGUDATA-APPKEY: YOUR_APPKEY 推荐方式,适合服务端接入和统一封装。
    HTTP Header X-API-Key X-API-Key: YOUR_APPKEY 通用 API Key Header,便于和常见 API 客户端集成。
    HTTP Header Authorization Authorization: Bearer YOUR_APPKEY 适合 OpenAI 兼容接口或 Bearer Token 风格客户端。
    Query 参数 appkey ?appkey=YOUR_APPKEY 兼容现有示例、Postman 集合、浏览器调试和历史代码。

    部分历史 POST 接口仍兼容表单或 JSON body 中的 appkey;新接入建议优先使用 Header 或 Query 参数。

  • 接口常见 HTTP 响应状态码

    以下为接口调用中常见的 HTTP 传输层状态码,不等同于响应体内的业务状态码;完整状态码注册表以 IANA HTTP Status Code Registry 为准。

    状态码 状态码解释 备注
    200 请求成功 HTTP 请求已成功处理;业务状态请结合响应体中的自定义业务码判断。
    201 资源已创建 创建类接口请求成功,并已生成对应资源。
    202 请求已接受 请求已被接受处理,结果可能异步完成。
    204 无响应内容 请求成功但响应体为空,适用于无需返回数据的操作。
    304 资源未变更 配合缓存或条件请求使用,表示可继续使用本地缓存。
    400 请求参数错误 请求参数缺失、格式错误或参数组合不合法。
    401 认证失败 缺少、无效或未通过认证的访问凭证(如 AppKey)。
    403 无权限访问 订单到期、权限不足或接口额度不可用。
    404 资源不存在 请求路径不存在。
    405 请求方法不允许 当前路径不支持该 HTTP 方法。
    408 请求超时 客户端请求在服务端等待时间内未完成,可稍后重试。
    409 请求冲突 请求与当前资源状态冲突,调整参数或业务状态后重试。
    413 请求内容过大 上传文件或请求体超过接口限制。
    414 请求地址过长 请求 URL 超过服务端可处理长度,建议减少查询参数或改用 POST。
    415 请求内容类型不支持 上传或请求体的内容类型不符合接口要求。
    422 请求语义错误 请求格式正确,但参数取值、语义或业务约束无法处理。
    429 请求频率受限 默认按来源 IP 限速,单 IP 最多 5 QPS,可满足常规业务调用。超出限制时接口会返回 429 请求频率受限;已购买接口订单可加购 10 QPS 扩展。
    431 请求头过大 请求头字段过大或过多,建议精简 Header 后重试。
    500 服务器内部错误 服务端处理异常,请稍后重试。
    502 网关或上游错误 网关或代理从上游服务收到异常响应。
    503 服务暂时不可用 服务维护、容量保护或依赖异常导致暂时不可用,请稍后重试。
    504 网关超时 网关等待上游服务响应超时,可稍后重试或降低请求复杂度。
  • 接口自定义业务状态码

    业务状态码 业务状态码解释 备注
    100 正常返回
    101 参数错误
    102 请求频率受限 每分钟请求不能超过 100 次
    103 账号欠费
    104 APPKEY 错误 请检查传递的 APPKEY 是否为开发者中心获取到的值
  • 请求示例代码

    curl --location --request GET 'https://api.gugudata.com/Weather/AirQuality?appkey=YOUR_APPKEY&location=%e5%8c%97%e4%ba%ac&lang=zh&city=%e5%8c%97%e4%ba%ac'
    #include <curl/curl.h>
    
    int main(void) {
      CURL *curl = curl_easy_init();
      if (curl) {
        curl_easy_setopt(curl, CURLOPT_URL, "https://api.gugudata.com/Weather/AirQuality?appkey=YOUR_APPKEY&location=%e5%8c%97%e4%ba%ac&lang=zh&city=%e5%8c%97%e4%ba%ac");
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
        curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
        CURLcode res = curl_easy_perform(curl);
        (void)res;
        curl_easy_cleanup(curl);
      }
      return 0;
    }
    
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Net.Http;
    
    var client = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Get, "https://api.gugudata.com/Weather/AirQuality?appkey=YOUR_APPKEY&location=%e5%8c%97%e4%ba%ac&lang=zh&city=%e5%8c%97%e4%ba%ac");
    var response = client.SendAsync(request).Result;
    Console.WriteLine(response.Content.ReadAsStringAsync().Result);
    
    package main
    
    import (
      "fmt"
      "io"
      "net/http"
    )
    
    func main() {
      url := "https://api.gugudata.com/Weather/AirQuality?appkey=YOUR_APPKEY&location=%e5%8c%97%e4%ba%ac&lang=zh&city=%e5%8c%97%e4%ba%ac"
      req, err := http.NewRequest("GET", url, nil)
      if err != nil {
        fmt.Println(err)
        return
      }
      res, err := http.DefaultClient.Do(req)
      if err != nil {
        fmt.Println(err)
        return
      }
      defer res.Body.Close()
      body, err := io.ReadAll(res.Body)
      if err != nil {
        fmt.Println(err)
        return
      }
      fmt.Println(string(body))
    }
    
    OkHttpClient client = new OkHttpClient().newBuilder().build();
    Request request = new Request.Builder()
      .url("https://api.gugudata.com/Weather/AirQuality?appkey=YOUR_APPKEY&location=%e5%8c%97%e4%ba%ac&lang=zh&city=%e5%8c%97%e4%ba%ac")
      .method("GET", null)
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
    
    $.ajax({
      url: "https://api.gugudata.com/Weather/AirQuality?appkey=YOUR_APPKEY&location=%e5%8c%97%e4%ba%ac&lang=zh&city=%e5%8c%97%e4%ba%ac",
      method: "GET",
    }).done(function (response) {
      console.log(response);
    });
    
    const https = require("node:https");
    
    const url = "https://api.gugudata.com/Weather/AirQuality?appkey=YOUR_APPKEY&location=%e5%8c%97%e4%ba%ac&lang=zh&city=%e5%8c%97%e4%ba%ac";
    const request = https.request(url, { method: "GET", headers: {  } }, handleResponse);
    request.on("error", console.error);
    request.end();
    
    function handleResponse(response) {
      const chunks = [];
      response.on("data", function (chunk) {
        chunks.push(chunk);
      });
      response.on("end", function () {
        console.log(Buffer.concat(chunks).toString("utf8"));
      });
    }
    
    #import <Foundation/Foundation.h>
    
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://api.gugudata.com/Weather/AirQuality?appkey=YOUR_APPKEY&location=%e5%8c%97%e4%ba%ac&lang=zh&city=%e5%8c%97%e4%ba%ac"]];
    [request setHTTPMethod:@"GET"];
    NSURLSessionDataTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:request completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
      if (error) {
        NSLog(@"%@", error);
        return;
      }
      NSLog(@"%@", [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]);
    }];
    [task resume];
    
    <?php
    $curl = curl_init();
    curl_setopt_array($curl, array(
      CURLOPT_URL => "https://api.gugudata.com/Weather/AirQuality?appkey=YOUR_APPKEY&location=%e5%8c%97%e4%ba%ac&lang=zh&city=%e5%8c%97%e4%ba%ac",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_FOLLOWLOCATION => true,
      CURLOPT_CUSTOMREQUEST => "GET",
    ));
    $response = curl_exec($curl);
    curl_close($curl);
    echo $response;
    
    import requests
    
    url = "https://api.gugudata.com/Weather/AirQuality?appkey=YOUR_APPKEY&location=%e5%8c%97%e4%ba%ac&lang=zh&city=%e5%8c%97%e4%ba%ac"
    response = requests.request("GET", url)
    print(response.text)
    
    require "uri"
    require "net/http"
    
    url = URI("https://api.gugudata.com/Weather/AirQuality?appkey=YOUR_APPKEY&location=%e5%8c%97%e4%ba%ac&lang=zh&city=%e5%8c%97%e4%ba%ac")
    https = Net::HTTP.new(url.host, url.port)
    https.use_ssl = true
    request = Net::HTTP::Get.new(url)
    response = https.request(request)
    puts response.read_body
    
    import Foundation
    
    let semaphore = DispatchSemaphore(value: 0)
    var request = URLRequest(url: URL(string: "https://api.gugudata.com/Weather/AirQuality?appkey=YOUR_APPKEY&location=%e5%8c%97%e4%ba%ac&lang=zh&city=%e5%8c%97%e4%ba%ac")!, timeoutInterval: .infinity)
    request.httpMethod = "GET"
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
      defer { semaphore.signal() }
      guard let data = data else {
        print(String(describing: error))
        return
      }
      print(String(data: data, encoding: .utf8)!)
    }
    task.resume()
    semaphore.wait()
    
  • 常见问题 Q&A

    • Q: 数据请求有缓存吗?

      A: 接口默认以实时响应为目标。对于日更、月更等具备明确更新周期的数据,会在数据周期内采用缓存与预热策略,以提升响应速度和稳定性;实时查询类接口则以接口说明中的更新频率为准。建议业务侧结合数据时效要求设置本地缓存与重试策略,避免高频重复请求。

    • Q: 如何保证请求时 AppKey 的安全性?

      A: 建议将 AppKey 保存在服务端环境中,由后端统一调用 API,再向前端或业务系统返回必要结果。不要把 AppKey 写入网页、App 客户端或公开仓库;生产环境建议按系统或业务线拆分 AppKey,并保留调用日志,便于权限控制、审计与问题排查。

    • Q: 接口可以用于哪些开发语言?

      A: 只要支持 HTTPS 请求的语言和框架均可接入,包括 Java、Python、Node.js、PHP、Go、C#、Swift、Kotlin 等。推荐由后端统一封装调用逻辑,集中处理鉴权、缓存、限流、重试和错误码映射,让 Web、App、AI Agent、内部系统和自动化任务复用同一套数据能力。

    • Q: 接口的性能可以保证吗?

      A: GuGuData API 按生产环境标准部署,持续关注接口稳定性、响应速度与可用性。实际响应时间会受接口类型、请求参数、数据源更新和网络环境影响;建议生产接入前进行联调与压测,并设置合理的超时、重试、降级和告警策略。批量处理或高并发场景可提前评估 QPS、白名单和专属容量方案。

  • 服务协议与免责声明

    购买或使用 GuGuData API 服务前,请充分阅读服务协议、免责声明与数据合规声明。相关页面均支持在浏览器中快速导出 PDF,便于内部归档、评审和合规留存。

  • 技术支持

    • 技术支持邮箱: support@gugudata.com
    • 微信客服: 客服链接
  • 专业软件开发与系统工程服务

    GuGuData 官方认证工程合作伙伴,专注企业级数据接口集成、AI 工程化与大规模数据处理。团队深度理解 GuGuData 数据接口体系,具备海量数据采集、治理、检索与高并发接口服务经验,可围绕业务场景构建 AI Agent、MCP 接入、智能工作流和生产级数据应用,让数据能力稳定进入现有流程、内部平台和核心业务系统。

    了解工程服务