返回中文文档
流年流月 API

流年流月 API

POST/api/v1/chinese/bazi/flow

该接口用于预测分析,计算年度(大运)和月度流年流月柱,并返回每个时间段与本命盘的作用关系和激活神煞。

中文响应与兼容性约定

使用 lang: "zh-CN"(POST 请求体)或?lang=zh-CN(GET 查询参数)请求简体中文响应。zh-Hanszhzh_hans 也会归一化为同一书写语言。

面向用户的名称、说明、星期、五行、生肖、十神和错误消息会本地化。为避免破坏现有客户端, JSON 字段名、对象映射键、稳定 ID、错误代码、枚举值、模式值、ISO 时间戳、时区、库名、版本号和拼音保持不变。 客户端应依据字段名与稳定代码处理逻辑,不要依据翻译后的显示文本建立判断。

例如 ten_god_distribution 内的Direct Wealth 等映射键属于兼容性标识,仍使用英文;页面标题、说明、描述和独立显示值会返回中文。

完整 URL

https://api.freeastroapi.com/api/v1/chinese/bazi/flow

调用范围限制

为保证性能,年份范围限制为每次请求 1 年。多年度预测请连续发起请求。

响应模式

summary:最快响应。不包含解读文本,仅返回最少元数据。

standard:返回包含解读和说明的完整细节。

debug:包含计算审计日志,用于排查问题。

字段选择

include 省略时默认返回 interactionsstars

传入 ["interactions"]["stars"] 时,它会作为白名单使用。

推荐格式是字符串数组。为了向后兼容,也仍然接受 "interactions,stars" 这类逗号分隔字符串。

字典响应模式

dictionary_response: true 会把作用关系和神煞返回为整数 ID,并在根字段 x_dict 中提供映射。

最佳实践:在应用加载时请求一次 /dictionary 接口并缓存它,然后在后续 flow 请求中使用 dictionary_response: false(默认值),并在客户端解析 ID。

请求参数

字段
year
类型
integer
必填
说明
出生年份,必须大于等于 1。
字段
month
类型
integer
必填
说明
出生月份,范围 1-12。
字段
day
类型
integer
必填
说明
出生日期,范围 1-31。
字段
hour
类型
integer
必填
说明
出生小时,范围 0-23;默认 12。
字段
minute
类型
integer
必填
说明
出生分钟,范围 0-59;默认 0。
字段
city
类型
string | null
必填
说明
用于坐标解析的城市名称。必须提供可解析的 city,或同时提供 lat 和 lng。
字段
lat
类型
number | null
必填
说明
纬度,范围 -90 至 90;省略 city 时须与 lng 一起提供。
字段
lng
类型
number | null
必填
说明
经度,范围 -180 至 180;省略 city 时须与 lat 一起提供。
字段
tz_str
类型
string | null
必填
说明
IANA 时区名称或 AUTO;默认 AUTO。
字段
sex
类型
"M" | "F"
必填
说明
接受 M 或 F;默认 M。
字段
time_standard
类型
string
必填
说明
接受 civil、true_solar 或 true_solar_absolute;默认 civil,并会改变本命参考盘。
字段
target_year
类型
integer
必填
说明
预测年份,必须大于等于 1;省略时使用请求发生时的 UTC 当前年份。
字段
target_year_end
类型
integer | null
必填
说明
如提供,必须与 target_year 相同;省略时运行期采用 target_year。
字段
include_pinyin
类型
boolean
必填
说明
是否返回拼音字段;默认 true。
字段
mode
类型
string
必填
说明
接受 summary、standard 或 debug;默认 summary。
字段
include
类型
string[] | string | null
必填
说明
interactions 和/或 stars 的白名单;接受数组或逗号分隔字符串,省略时返回两者。
字段
exclude
类型
string[] | string | null
必填
说明
可排除 interactions 和/或 stars;接受数组或逗号分隔字符串。
字段
dictionary_response
类型
boolean
必填
说明
是否返回紧凑整数 ID 和 x_dict;默认 false。
字段
lang
类型
string
必填
说明
响应语言;默认 en。使用 zh-CN 返回简体中文。

调用示例

curl -X POST "https://api.freeastroapi.com/api/v1/chinese/bazi/flow" \
 -H "Content-Type: application/json" \
 -H "x-api-key: YOUR_API_KEY" \
 -d '{
    "year": 1990,
    "month": 5,
    "day": 15,
    "hour": 10,
    "minute": 30,
    "lat": 28.6139,
    "lng": 77.2090,
    "sex": "M",
    "time_standard": "civil",
    "tz_str": "Asia/Kolkata",
    "target_year": 2024,
    "target_year_end": 2024,
    "include_pinyin": true,
    "mode": "standard",
    "include": ["interactions", "stars"],
    "exclude": [],
    "dictionary_response": true,
    "lang": "zh-CN"
}'

响应数据

{
  "target_year": 2024,
  "target_year_end": 2024,
  "years": [
    {
      "year": 2024,
      "gan_zhi": "甲辰",
      "gan": "甲",
      "zhi": "辰",
      "gan_pinyin": "jiǎ",
      "zhi_pinyin": "chén",
      "ten_god": "正财",
      "interactions": [1005, 2021],
      "stars": [4005],
      "months": [
        {
          "index": 1,
          "name": "2024年2月",
          "gan_zhi": "丙寅",
          "gan": "丙",
          "zhi": "寅",
          "ten_god": "比肩",
          "interactions": [1012],
          "stars": [4001, 4005]
        }
      ]
    }
  ],
  "x_dict": {
    "1005": {
      "type": "天干合",
      "name": "甲己合",
      "stems": ["甲", "己"],
      "transform_to": "土"
    },
    "2021": {
      "type": "地支六冲",
      "name": "寅申冲",
      "branches": ["寅", "申"]
    }
  }
}

相关接口