Yearly Forecast

POST

/bazi/yearly

• Production

Compares target year pillar against natal day master + natal year branch. Returns element-flow relation (companion / mother / output / control / wealth) per Sheng-Ke cycle, branch clashes (六冲), and trine support (三合).

Authorizations

• ApiKeyAuth

Code Samples

cURL

curl -X POST https://api.astroway.info/v1/bazi/yearly \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "natalDate": "1990-05-15", "targetYear": 2027 }'

Node.js

const res = await fetch('https://api.astroway.info/v1/bazi/yearly', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "natalDate": "1990-05-15",
    "targetYear": 2027
  }),
});
const { ok, data, error } = await res.json();
if (!ok) throw new Error(error.message);
console.log(data);

Python

import os, requests

r = requests.post(
    'https://api.astroway.info/v1/bazi/yearly',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
    json={
      'natalDate': "1990-05-15",
      'targetYear': 2027
    },
)
result = r.json()
if not result['ok']:
    raise RuntimeError(result['error']['message'])
print(result['data'])

PHP

<?php
use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://api.astroway.info/v1/']);
$r = $client->post('bazi/yearly', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
    'json' => [
        'natalDate' => '1990-05-15',
        'targetYear' => 2027,
    ],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

Request Body ^required

object

Example

{
  "natalDate": "1990-05-15",
  "targetYear": 2027
}

Responses

200

Successful calculation

object

ok

boolean

Example

true

data

object

natalDayMaster

object

element

string

yin

boolean

targetPillar

object

pillar

string

animal

string

elementFlow

object

stem

object

element

string

relation

string

flavor

string

branch

object

branchInteractions

object

clashes

Array

trineSupport

Array

400

Validation error

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

Example

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