• API 功能

    • 支持结构化出生信息输入,并兼容现有 userinfo 自然语言调用;
    • 先完成公历、农历与四柱排盘,再基于固定排盘基础生成文化解读;
    • 明确返回标准化输入、历法换算、年柱、月柱、日柱和时柱,便于业务系统核对与展示;
    • 支持同步、异步任务和 SSE 流式三种响应方式;
    • 覆盖五行、大运、学业与事业、关系、财务和健康等文化解读维度;
    • 结果用于传统文化研究与娱乐参考,不作为现实决策依据。
    • 全接口通过 HTTPS 提供服务;
    • 全面兼容 Apple ATS;
    • 全国多节点 CDN 部署;
    • 接口调用状态与状态监控
  • API 文档

    接口地址: https://api.gugudata.com/ai/bazi-fortune-teller?appkey={{appkey}}&streaming={{streaming}}&responseMode={{responseMode}}

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

    请求方式: POST

    请求协议: HTTPS

    请求示例: https://api.gugudata.com/ai/bazi-fortune-teller?appkey=YOUR_APPKEY&streaming={{streaming}}&responseMode={{responseMode}}

    数据预览: https://www.gugudata.com/preview/bazi-fortune-teller

    接口测试:  https://api.gugudata.com/ai/bazi-fortune-teller/demo

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

    请求参数(POST 请求参数以 application/x-www-form-urlencoded 格式、文件流以 formdata 格式传递,具体可参见下方示例代码)

    参数名 参数类型 是否必须 默认值 备注
    appkey string YOUR_APPKEY 付费后获取的 APPKEY。文档示例默认通过 Query 参数 appkey 传递;历史 Form 或 JSON body 中的 appkey 仍兼容。
    userinfo string N/A 旧版自然语言兼容参数。必须同时写明性别、历法、出生日期和出生时间,例如:我是男性,我的公历出生日期是2016年11月23日,出生时间是18:00。与结构化参数同时提供时,以 gender、calendarType、birthDate、birthTime 等结构化参数为准。
    gender string N/A 结构化调用时必填。性别,支持:男、女、male、female。
    calendarType string 公历 结构化调用时必填。birthDate 使用的历法,支持:公历、农历、solar、gregorian、lunar。
    birthDate string N/A 结构化调用时必填。出生日期,严格使用 YYYY-MM-DD 格式,支持范围为 1901-01-01 至 2100-12-31;calendarType=农历时填写农历年月日。
    birthTime string N/A 结构化调用时必填。出生时间,推荐使用 HH:mm 24 小时制,例如 18:00。支持丑时至亥时等传统时辰输入,并按该时辰的中间时刻标准化;子时跨越两个公历日期,必须改用 HH:mm 明确具体时间。
    birthPlace string N/A 出生地点,用于文化解读背景。当前排盘统一按 Asia/Shanghai 时区和输入的北京时间计算,不根据经度进行真太阳时校正。
    isLeapMonth boolean false 仅 calendarType=农历时有效。出生月份是否为闰月;公历输入必须为 false。
    streaming boolean false 是否使用 SSE 流式响应。false 返回完整 JSON;true 先发送 type=content 的文本片段,最后发送 type=done,其中 result 为包含确定性排盘基础的完整结果。
    responseMode string sync 响应模式,支持 sync、task。sync 在当前请求中返回结果;task 先返回 operationId,再调用任务状态查询接口轮询。responseMode=task 不能与 streaming=true 同时使用。

    返回参数

    参数名 参数类型 备注
    DataStatus.RequestParameter string 本次请求采用的标准化参数摘要,不包含完整 APPKEY。
    DataStatus.StatusCode integer 业务状态码。100 表示成功;101 表示参数错误;102 表示请求频率受限;104 表示 APPKEY 无效或未购买本接口。
    DataStatus.StatusDescription string 业务状态说明;参数错误时会指出缺少或格式不正确的字段。
    DataStatus.ResponseDateTime string 接口响应生成时间。
    DataStatus.DataTotalCount integer 当前返回的业务结果数量;同步成功时通常为 1。
    Data.排盘基础 object 由历法组件计算并固定返回的排盘依据,包含标准化输入、历法换算、四柱和八字。文化解读以此字段为准。
    Data.排盘基础.输入信息 object 标准化后的性别、历法、出生日期、出生时间、出生地点、闰月标识及时间标准化说明。
    Data.排盘基础.历法换算.公历时间 string 排盘实际采用的公历时间,格式为 YYYY-MM-DD HH:mm:ss;农历输入会先换算为此时间。
    Data.排盘基础.历法换算.农历日期 string 排盘实际对应的农历日期。
    Data.排盘基础.历法换算.时区 string 排盘使用的时区,固定为 Asia/Shanghai。
    Data.排盘基础.历法换算.日界规则 string 日期换日规则。23:00 至 23:59 仍属于输入的公历日期,次日 00:00 后进入下一日。
    Data.排盘基础.四柱 object 确定性计算得到的年柱、月柱、日柱、时柱。
    Data.八字 string 按年柱、月柱、日柱、时柱顺序拼接的八字结果,与 Data.排盘基础.四柱保持一致。
    Data.五行 object 基于排盘基础生成的五行属性、强弱及喜忌文化解读,具体子字段可能随命盘内容变化。
    Data.命宫 string 命宫相关文化解读。
    Data.身宫 string 身宫相关文化解读。
    Data.大运 array 分阶段的大运文化解读。每项通常包含起始年份、终止年份、干支或阶段主题,具体字段以实际返回为准。
    Data.运势分析 object 学业与事业、关系、财务、健康、体貌特征及关键阶段等维度的文化解读。
    Data.综合评价 string 基于排盘基础生成的综合文化解读。
    Data.免责声明 string 结果使用边界说明,仅供传统文化研究与娱乐参考。
    Data.operationId string 仅 responseMode=task 时返回,作为后续任务状态查询的唯一标识。
    Data.status string 仅任务模式返回,可能值为 PENDING、RUNNING、SUCCEEDED、FAILED、EXPIRED。
    Data.pollingUrl string 仅任务模式返回,用于轮询任务状态的相对路径。
    Data.expiresAt string 仅任务模式返回,任务结果的过期时间。
    Data.result object 任务状态为 SUCCEEDED 时返回的完整业务结果,字段结构与同步模式的 Data 相同。
    Data.error object 任务状态为 FAILED 时返回的业务侧失败信息。
    SSE.done.result object 仅 streaming=true 时,在最后一个 type=done 消息中返回的完整且已校验结果。
  • 鉴权方式

    接口支持以下 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 参数错误 出生信息缺失、日期时间格式错误、历法值无效、农历闰月设置错误,或 task 与 streaming 参数冲突。
    102 请求频率受限 当前请求频率超过 APPKEY 的 QPS 限制。
    104 APPKEY 错误 APPKEY 无效、已过期或未购买本接口。
  • 请求示例代码

    curl --location --request POST 'https://api.gugudata.com/ai/bazi-fortune-teller?appkey=YOUR_APPKEY&streaming={{streaming}}&responseMode={{responseMode}}' \
    --header 'Content-Type: application/x-www-form-urlencoded' \
    --data-urlencode 'userinfo=N/A' \
    --data-urlencode 'gender=N/A' \
    --data-urlencode 'calendarType=公历' \
    --data-urlencode 'birthDate=N/A' \
    --data-urlencode 'birthTime=N/A' \
    --data-urlencode 'birthPlace=N/A' \
    --data-urlencode 'isLeapMonth=false'
    #include <curl/curl.h>
    
    int main(void) {
      CURL *curl = curl_easy_init();
      if (curl) {
        curl_easy_setopt(curl, CURLOPT_URL, "https://api.gugudata.com/ai/bazi-fortune-teller?appkey=YOUR_APPKEY&streaming={{streaming}}&responseMode={{responseMode}}");
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Content-Type: application/x-www-form-urlencoded");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "userinfo=N%2fA&gender=N%2fA&calendarType=%e5%85%ac%e5%8e%86&birthDate=N%2fA&birthTime=N%2fA&birthPlace=N%2fA&isLeapMonth=false");
        CURLcode res = curl_easy_perform(curl);
        (void)res;
        curl_slist_free_all(headers);
        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.Post, "https://api.gugudata.com/ai/bazi-fortune-teller?appkey=YOUR_APPKEY&streaming={{streaming}}&responseMode={{responseMode}}");
    request.Content = new FormUrlEncodedContent(new Dictionary<string, string>
    {
        { "userinfo", "N/A" },
        { "gender", "N/A" },
        { "calendarType", "公历" },
        { "birthDate", "N/A" },
        { "birthTime", "N/A" },
        { "birthPlace", "N/A" },
        { "isLeapMonth", "false" }
    });
    var response = client.SendAsync(request).Result;
    Console.WriteLine(response.Content.ReadAsStringAsync().Result);
    
    package main
    
    import (
      "strings"
      "fmt"
      "io"
      "net/http"
    )
    
    func main() {
      url := "https://api.gugudata.com/ai/bazi-fortune-teller?appkey=YOUR_APPKEY&streaming={{streaming}}&responseMode={{responseMode}}"
      payload := strings.NewReader("userinfo=N%2fA&gender=N%2fA&calendarType=%e5%85%ac%e5%8e%86&birthDate=N%2fA&birthTime=N%2fA&birthPlace=N%2fA&isLeapMonth=false")
      req, err := http.NewRequest("POST", url, payload)
      if err != nil {
        fmt.Println(err)
        return
      }
      req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
      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();
    MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
    RequestBody body = RequestBody.create(mediaType, "userinfo=N%2fA&gender=N%2fA&calendarType=%e5%85%ac%e5%8e%86&birthDate=N%2fA&birthTime=N%2fA&birthPlace=N%2fA&isLeapMonth=false");
    Request request = new Request.Builder()
      .url("https://api.gugudata.com/ai/bazi-fortune-teller?appkey=YOUR_APPKEY&streaming={{streaming}}&responseMode={{responseMode}}")
      .method("POST", body)
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
    
    $.ajax({
      url: "https://api.gugudata.com/ai/bazi-fortune-teller?appkey=YOUR_APPKEY&streaming={{streaming}}&responseMode={{responseMode}}",
      method: "POST",
      data: { "userinfo": "N/A", "gender": "N/A", "calendarType": "公历", "birthDate": "N/A", "birthTime": "N/A", "birthPlace": "N/A", "isLeapMonth": "false" },
    }).done(function (response) {
      console.log(response);
    });
    
    const https = require("node:https");
    const url = "https://api.gugudata.com/ai/bazi-fortune-teller?appkey=YOUR_APPKEY&streaming={{streaming}}&responseMode={{responseMode}}";
    const { URLSearchParams } = require("node:url");
    const body = new URLSearchParams({ "userinfo": "N/A", "gender": "N/A", "calendarType": "公历", "birthDate": "N/A", "birthTime": "N/A", "birthPlace": "N/A", "isLeapMonth": "false" }).toString();
    
    const request = https.request(url, {
      method: "POST",
      headers: {
        "Content-Type": "application/x-www-form-urlencoded",
        "Content-Length": Buffer.byteLength(body)
      }
    }, handleResponse);
    request.on("error", console.error);
    request.write(body);
    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/ai/bazi-fortune-teller?appkey=YOUR_APPKEY&streaming={{streaming}}&responseMode={{responseMode}}"]];
    [request setHTTPMethod:@"POST"];
    NSString *body = @"userinfo=N%2fA&gender=N%2fA&calendarType=%e5%85%ac%e5%8e%86&birthDate=N%2fA&birthTime=N%2fA&birthPlace=N%2fA&isLeapMonth=false";
    [request setValue:@"application/x-www-form-urlencoded" forHTTPHeaderField:@"Content-Type"];
    [request setHTTPBody:[body dataUsingEncoding:NSUTF8StringEncoding]];
    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/ai/bazi-fortune-teller?appkey=YOUR_APPKEY&streaming={{streaming}}&responseMode={{responseMode}}",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_FOLLOWLOCATION => true,
      CURLOPT_CUSTOMREQUEST => "POST",
      CURLOPT_POSTFIELDS => "userinfo=N%2fA&gender=N%2fA&calendarType=%e5%85%ac%e5%8e%86&birthDate=N%2fA&birthTime=N%2fA&birthPlace=N%2fA&isLeapMonth=false",
      CURLOPT_HTTPHEADER => array(
        "Content-Type: application/x-www-form-urlencoded",
      ),
    ));
    $response = curl_exec($curl);
    curl_close($curl);
    echo $response;
    
    import requests
    
    url = "https://api.gugudata.com/ai/bazi-fortune-teller?appkey=YOUR_APPKEY&streaming={{streaming}}&responseMode={{responseMode}}"
    payload = { "userinfo": "N/A", "gender": "N/A", "calendarType": "公历", "birthDate": "N/A", "birthTime": "N/A", "birthPlace": "N/A", "isLeapMonth": "false" }
    response = requests.post(url, data=payload)
    print(response.text)
    
    require "uri"
    require "net/http"
    
    url = URI("https://api.gugudata.com/ai/bazi-fortune-teller?appkey=YOUR_APPKEY&streaming={{streaming}}&responseMode={{responseMode}}")
    https = Net::HTTP.new(url.host, url.port)
    https.use_ssl = true
    request = Net::HTTP::Post.new(url)
    request["Content-Type"] = "application/x-www-form-urlencoded"
    request.body = "userinfo=N%2fA&gender=N%2fA&calendarType=%e5%85%ac%e5%8e%86&birthDate=N%2fA&birthTime=N%2fA&birthPlace=N%2fA&isLeapMonth=false"
    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/ai/bazi-fortune-teller?appkey=YOUR_APPKEY&streaming={{streaming}}&responseMode={{responseMode}}")!, timeoutInterval: .infinity)
    request.httpMethod = "POST"
    request.addValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type")
    request.httpBody = "userinfo=N%2fA&gender=N%2fA&calendarType=%e5%85%ac%e5%8e%86&birthDate=N%2fA&birthTime=N%2fA&birthPlace=N%2fA&isLeapMonth=false".data(using: .utf8)
    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 接入、智能工作流和生产级数据应用,让数据能力稳定进入现有流程、内部平台和核心业务系统。

    了解工程服务