Branch and stem interactions

POST

/bazi/interactions

request.sh

curl -X POST https://api.astroway.info/v1/bazi/interactions \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "date": "1990-05-15", "time": "14:30:00", "timezoneOffset": 8 }'

▸ Спробувати POST /bazi/interactions

• Production

Stem combinations, six harmonies, full and half trines, clashes, harms, punishments and self-punishments present in the chart, with the pillars involved and the element a combination produces.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

fields

string

Comma-separated dotted paths, relative to data, to keep in the response. A path is applied to every element of an array, so planets.name means the name of each planet. Paths that match nothing come back in _fields_unmatched; a list where nothing matches at all is a 400, because an empty object would be a confident wrong answer.

Example

planets.name,planets.longitude

precision

integer

<= 15

Round every non-integer number in the response to this many decimal places. Integers are left alone, because an id is not a measurement. Ecliptic longitudes ship with fourteen decimals by default; 2 is about a tenth of an arcminute.

Example

4

Request Body ^required

Media type application/json

object

date required

string

/^\d{4}-\d{2}-\d{2}$/

time

string

/^\d{2}:\d{2}(:\d{2})?$/

timezoneOffset

Ignored when timezone is sent.

number

>= -14 <= 14

timezone

IANA zone name such as Europe/Kyiv, or auto to look the zone up from latitude and longitude. The server takes the offset that zone kept at this local date and time, summer time included, and uses it in place of timezoneOffset. A clock time that happened twice takes the first occurrence; one skipped when clocks went forward takes the offset from before the change. Abbreviations such as EST are refused. Before 1970 the tz database is not reliable for every place, so send timezoneOffset when the local clock is known.

string

longitude

number

>= -180 <= 180

trueSolarTime

boolean

dayBoundary

string

Allowed values: 23:00 midnight

language

string

stageSchool

string

Allowed values: classical unified

includeFullTable

boolean

includeLuck

boolean

gender

string

Allowed values: male female

Example

{
  "date": "1990-05-15",
  "time": "14:30:00",
  "timezoneOffset": 8
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

solarYear

number

nullable

pillars

Array<object>

nullable

object

name

string

nullable

stem

string

nullable

branch

string

nullable

pillar

string

nullable

interactions

Array<object>

nullable

object

type

string

nullable

chinese

string

nullable

english

string

nullable

pillars

Array<string>

nullable

members

Array<string>

nullable

producesElement

string

nullable

schoolNote

string

nullable

notes

Array

nullable

methodology

string

nullable

source

string

nullable

disclaimer

string

nullable

Example

{
  "ok": true,
  "data": {
    "solarYear": 1990,
    "pillars": [
      {
        "name": "year",
        "stem": "Geng",
        "branch": "Wu",
        "pillar": "Geng-Wu"
      },
      {
        "name": "month",
        "stem": "Xin",
        "branch": "Si",
        "pillar": "Xin-Si"
      },
      {
        "name": "day",
        "stem": "Geng",
        "branch": "Chen",
        "pillar": "Geng-Chen"
      },
      {
        "name": "hour",
        "stem": "Gui",
        "branch": "Wei",
        "pillar": "Gui-Wei"
      }
    ],
    "interactions": [
      {
        "type": "sixHarmony",
        "chinese": "六合",
        "english": "Six Harmony",
        "pillars": [
          "year",
          "hour"
        ],
        "members": [
          "Wu",
          "Wei"
        ],
        "producesElement": "Earth",
        "schoolNote": "The Wu-Wei harmony is given as Earth here; other transmissions read it as the sun-and-moon pair and assign no element."
      }
    ],
    "notes": [],
    "methodology": "天干五合, 六合, 三合 and 半合, 六沖, 六害, 三刑 and 自刑. Most of these are arithmetic rather than tables: a six harmony is a pair of branch indices summing to one, a harm sums to seven, a clash is a distance of six. Only the punishments need a table, because they are not a relation on the indices.",
    "source": "淵海子平 (Song), public domain",
    "disclaimer": "BaZi pillars use the canonical 60-jiazi cycle, anchored at 1990-01-01 = Bing-Yin. Year and month boundaries are the exact Lichun and 節 instants from the ephemeris, stated in China Standard Time; pass time and timezoneOffset for births near a boundary. Day and hour follow the birthplace clock, with the day rolling at 23:00 local."
  }
}

400

Validation error

Media type application/json

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "Validation failed: date: Date must be YYYY-MM-DD",
    "details": [
      {
        "path": "date",
        "message": "Date must be YYYY-MM-DD"
      }
    ]
  }
}

401

Missing or invalid API key

Media type application/json

Example

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API key"
  }
}