• API 功能

    • 全国主要城市空气质量数据;
    • 多负载响应节点,毫秒级响应性能;
    • 包含主要污染物信息数据;
    • 全接口支持 HTTPS(TLS v1.0 / v1.1 / v1.2 / v1.3);
    • 全面兼容 Apple ATS;
    • 全国多节点 CDN 部署;
    • 接口极速响应,多台服务器构建 API 接口负载均衡。
    • 接口调用状态与状态监控
  • API 文档

    接口地址: https://api.gugudata.com/weather/airquality

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

    请求方式: GET

    请求协议: HTTPS

    请求示例: https://api.gugudata.com/weather/airquality?appkey=YOUR_APPKEY&city=YOUR_VALUE

    数据预览: 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 付费后获取的 APPKEY
    city string YOUR_VALUE 需要查询的城市名称,可选值为:['北京', '廊坊', '承德', '唐山', '晋城', '保定', '德阳', '秦皇岛', '天津', '朝阳', '临汾', '运城', '焦作', '成都', '锦州', '长治', '绵阳', '资阳', '葫芦岛', '长春', '广安', '石家庄', '三门峡', '兰州', '沧州', '沈阳', '衡水', '哈尔滨', '洛阳', '滨州', '眉山', '阳泉', '东营', '内江', '铜川', '晋中', '淄博', '邢台', '宜宾', '自贡', '南充', '邯郸', '潍坊', '新乡', '安阳', '忻州', '太原', '临沂', '重庆', '乐山', '张家口', '德州', '济南', '鹤壁', '聊城', '青岛', '亳州', '日照', '枣庄', '西安', '咸阳', '宿州', '宝鸡', '达州', '泰安', '商丘', '郑州', '济宁', '连云港', '南阳', '吕梁', '雅安', '阜阳', '渭南', '南昌', '周口', '许昌', '宿迁', '武汉', '开封', '泸州', '平顶山', '徐州', '驻马店', '信阳', '菏泽', '淮南', '孝感', '漯河', '朔州', '濮阳', '杭州', '呼和浩特', '银川', '湖州', '随州', '淮安', '遂宁', '襄阳', '宜昌', '淮北', '常州', '益阳', '拉萨', '泰州', '包头', '盐城', '六安', '蚌埠', '岳阳', '西宁', '九江', '镇江', '苏州', '广州', '乌鲁木齐', '贵阳', '大同', '铜陵', '新余', '荆门', '鄂州', '扬州', '常德', '无锡', '荆州', '南通', '咸宁', '长沙', '衢州', '嘉兴', '大连', '黄冈', '温州', '黄石', '绍兴', '厦门', '宜春', '合肥', '上海', '昆明', '福州', '株洲', '金华', '南京', '湘潭', '马鞍山', '丽水', '萍乡', '宣城', '芜湖', '滁州', '池州', '安庆', '佛山', '黄山', '江门', '台州', '南宁', '惠州', '宁波', '肇庆', '舟山', '中山', '东莞', '深圳', '珠海', '海口']。

    返回参数

    参数名 参数类型 备注
    DataStatus.StatusCode integer 接口返回状态码
    DataStatus.StatusDescription string 接口返回状态说明
    DataStatus.ResponseDateTime string 接口数据返回时间
    DataStatus.DataTotalCount integer 此条件下的总数据量
    Data.Province string 省份名称
    Data.City string 城市名称
    Data.AQI string 空气质量指数
    Data.Quality string 空气质量
    Data.PM25 string PM2.5 浓度
    Data.PrimaryPollutant string 首要污染物
  • 接口 HTTP 响应标准状态码

    状态码 状态码解释 备注
    200 接口正常响应 请求成功,业务状态请结合响应体中的自定义业务码判断。
    400 请求参数错误 请求参数缺失、格式错误或参数组合不合法。
    401 鉴权失败 缺少 appkey 或 appkey 无效。
    403 无权限访问 订单到期、权限不足或接口额度不可用。
    404 资源不存在 请求路径不存在。
    405 请求方法不允许 当前路径不支持该 HTTP 方法。
    415 请求内容类型不支持 上传或请求体的内容类型不符合接口要求。
    429 请求频率受限 一般建议同一个 IP 每秒请求不超过 5 次 (QPS<=5),我们不限制同一个 key 的请求总次数,但当单位时间内同一个 IP 请求次数过多,或 AI CDN 判定为恶意抓取数据、流量攻击等异常时,CDN 会返回此状态码,请适当降低请求频率。如有特殊大并发请求场景需求,可联系我们添加白名单处理。
    500 服务内部错误 服务端处理异常,请稍后重试。
    502 上游依赖错误 上游依赖服务不可用或返回异常。
  • 接口自定义状态码

    自定义状态码 自定义状态码解释 备注
    100 正常返回
    101 参数错误
    102 请求频率受限 每分钟请求不能超过 100 次
    103 账号欠费
    104 APPKEY 错误 请检查传递的 APPKEY 是否为开发者中心获取到的值
    110 接口响应错误
  • 请求示例代码
    curl --location --request GET 'https://api.gugudata.com/weather/airquality?appkey=YOUR_APPKEY&city=YOUR_VALUE'
    #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&city=YOUR_VALUE");
        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&city=YOUR_VALUE");
    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&city=YOUR_VALUE"
      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&city=YOUR_VALUE")
      .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&city=YOUR_VALUE",
      method: "GET",
    }).done(function (response) {
      console.log(response);
    });
    
    const response = await fetch("https://api.gugudata.com/weather/airquality?appkey=YOUR_APPKEY&city=YOUR_VALUE", {
      method: "GET"
    });
    console.log(await response.text());
    
    const response = await fetch("https://api.gugudata.com/weather/airquality?appkey=YOUR_APPKEY&city=YOUR_VALUE", {
      method: "GET"
    });
    console.log(await response.text());
    
    #import <Foundation/Foundation.h>
    
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://api.gugudata.com/weather/airquality?appkey=YOUR_APPKEY&city=YOUR_VALUE"]];
    [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&city=YOUR_VALUE",
      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&city=YOUR_VALUE"
    response = requests.request("GET", url)
    print(response.text)
    
    require "uri"
    require "net/http"
    
    url = URI("https://api.gugudata.com/weather/airquality?appkey=YOUR_APPKEY&city=YOUR_VALUE")
    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&city=YOUR_VALUE")!, 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: 如何保证请求时 key 的安全性?

      A: 我们建议将对 API 的请求操作放置在您的应用程序后端。这样,前端请求只与您的后端服务交互,确保了更高的安全性和易于维护的架构。

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

      A: 我们的接口支持所有能进行网络请求的开发语言,便于在各类项目中快速整合数据。

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

      A: 我们的接口后台使用与商业级项目相同的架构,保证了稳定且高效的性能。您可以通过访问测试接口了解更多性能信息。

  • 服务协议以及服务免责声明

    用户应当充分阅读 服务协议 以及 服务免责声明 ,用户购买与使用咕咕数据 API 服务亦视为接受本协议。

  • 技术支持

    • 技术支持邮箱: support@gugudata.com
    • 微信客服: 客服链接

业务相关接口推荐

汽车车型库数据
  • 提供品牌车系车型三级车型库数据
  • 汽车数据 / 车型库
  • 2999元/年限时折扣 1499元/年
查看详情 数据校验更新于 6 小时前
50% 折扣
高校评分实时分析与推荐
  • 基于多维度指标对大学进行综合评分与分析
  • 多维度评估 / 专业推荐
  • 1999元/年限时折扣 999元/年
查看详情 数据校验更新于 2 小时前
50% 折扣
稳定提供服务 10 年 历年高考一分一段数据
  • 各省份高考分数线一分一段统计数据
  • 多年历史记录 / 多纬度对比
  • 2999元/年限时折扣 1499元/年
查看详情 数据校验更新于 5 小时前
50% 折扣
稳定提供服务 10 年 历年高校招生计划数据
  • 各高校历年招生计划数据
  • 高校招生数据 / 历年计划
  • 3999元/年限时折扣 1999元/年
查看详情 数据校验更新于 5 小时前
50% 折扣