Symbolic stars (Shen Sha)
curl -X POST https://api.astroway.info/v1/bazi/symbolic-stars \ -H "X-Api-Key: aw_live_..." \ -H "Content-Type: application/json" \ -d '{ "date": "1990-05-15", "time": "14:30:00", "timezoneOffset": 8 }'const res = await fetch('https://api.astroway.info/v1/bazi/symbolic-stars', { method: 'POST', headers: { 'X-Api-Key': process.env.ASTROWAY_API_KEY, 'Content-Type': 'application/json', }, body: JSON.stringify({ "date": "1990-05-15", "time": "14:30:00", "timezoneOffset": 8 }),});const { ok, data, error } = await res.json();if (!ok) throw new Error(error.message);console.log(data);import os, requests
r = requests.post( 'https://api.astroway.info/v1/bazi/symbolic-stars', headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'}, json={ 'date': "1990-05-15", 'time': "14:30:00", 'timezoneOffset': 8 },)result = r.json()if not result['ok']: raise RuntimeError(result['error']['message'])print(result['data'])<?phpuse GuzzleHttp\Client;
$client = new Client(['base_uri' => 'https://api.astroway.info/v1/']);$r = $client->post('bazi/symbolic-stars', [ 'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')], 'json' => [ 'date' => '1990-05-15', 'time' => '14:30:00', 'timezoneOffset' => 8, ],]);$result = json_decode($r->getBody(), true);if (!$result['ok']) throw new \RuntimeException($result['error']['message']);print_r($result['data']);Peach Blossom, Travelling Horse, Canopy, Heavenly Nobleman, Blade and Void, computed from BOTH the year and the day reference pillar because the transmissions disagree about which one the rules read from. Where two transmissions place a star differently, both placements ship and each names the other.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”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.longitudeRound 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
4Request Body required
Section titled “Request Body required ”object
Ignored when timezone is sent.
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.
Example
{ "date": "1990-05-15", "time": "14:30:00", "timezoneOffset": 8}Responses
Section titled “ Responses ”Successful calculation
object
object
object
object
object
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" } ], "byYearPillar": [ { "key": "nobleman", "chinese": "天乙貴人", "pinyin": "Tian Yi Gui Ren", "english": "Heavenly Nobleman", "pillars": [ "hour" ], "meaning": "help arriving from outside, the patron and the timely intervention", "schoolNote": "The 三命通會 reading for 庚 (甲戊庚牛羊). 淵海子平 puts the 庚 nobleman at 午 and 寅 instead; that reading is reported separately." }, { "key": "noblemanAlt", "chinese": "天乙貴人", "pinyin": "Tian Yi Gui Ren", "english": "Heavenly Nobleman (淵海子平 reading)", "pillars": [ "year" ], "meaning": "help arriving from outside, the patron and the timely intervention", "schoolNote": "The 淵海子平 and 星平會海 reading for 庚 (庚辛逢馬虎). The 三命通會 reading is reported under `nobleman`." } ], "byDayPillar": [ { "key": "canopy", "chinese": "華蓋", "pinyin": "Hua Gai", "english": "Canopy", "pillars": [ "day" ], "meaning": "solitude and study, the scholar and the recluse" }, { "key": "nobleman", "chinese": "天乙貴人", "pinyin": "Tian Yi Gui Ren", "english": "Heavenly Nobleman", "pillars": [ "hour" ], "meaning": "help arriving from outside, the patron and the timely intervention", "schoolNote": "The 三命通會 reading for 庚 (甲戊庚牛羊). 淵海子平 puts the 庚 nobleman at 午 and 寅 instead; that reading is reported separately." }, { "key": "noblemanAlt", "chinese": "天乙貴人", "pinyin": "Tian Yi Gui Ren", "english": "Heavenly Nobleman (淵海子平 reading)", "pillars": [ "year" ], "meaning": "help arriving from outside, the patron and the timely intervention", "schoolNote": "The 淵海子平 and 星平會海 reading for 庚 (庚辛逢馬虎). The 三命通會 reading is reported under `nobleman`." } ], "referenceNote": "Star rules key off a reference pillar. The older transmission reads from the year, later practice from the day, and the two disagree often enough that picking one silently would be a school choice disguised as a result.", "notes": [], "methodology": "神煞. Only the six stars every transmission carries with the same rule are implemented: 桃花, 驛馬, 華蓋, 天乙貴人, 羊刃 and 空亡. The full register runs to hundreds of entries, most of them local to one almanac, and those are deliberately absent rather than guessed.", "source": "三命通會 (Wan Minying, Ming), 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." }}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" } ] }}Missing or invalid API key
Example
{ "ok": false, "error": { "code": "INVALID_API_KEY", "message": "Invalid API key" }}