Tong Shu day: officer and mansion

POST

/chinese/tong-shu

request.sh

curl -X POST https://api.astroway.info/v1/chinese/tong-shu \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "date": "2026-09-12" }'

▸ Спробувати POST /chinese/tong-shu

• Production

The almanac reading of one day: day pillar, the day officer (建除十二神) with what the register endorses and forbids, the 28 mansion with its quadrant and planet, and the animal the day clashes.

Authorizations

• ApiKeyAuth

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

Hours from UTC at the given moment, not minutes. Fractional zones are hours too: 5.5 for India, 5.75 for Nepal, -3.5 for Newfoundland. Defaults to 0, meaning UTC.

number

0 nullable >= -14 <= 14

Example

{
  "date": "2026-09-12"
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

date

string

nullable

dayPillar

object

stem

string

nullable

branch

string

nullable

pillar

string

nullable

animal

string

nullable

monthBranch

string

nullable

solarYear

number

nullable

officer

object

index

number

nullable

chinese

string

nullable

pinyin

string

nullable

name

string

nullable

summary

string

nullable

suitable

Array<string>

nullable

unsuitable

Array<string>

nullable

mansion

object

index

number

nullable

chinese

string

nullable

pinyin

string

nullable

name

string

nullable

quadrant

string

nullable

planet

string

nullable

weekday

number

nullable

clash

object

branch

string

nullable

animal

string

nullable

note

string

nullable

notes

Array<string>

nullable

Example

{
  "ok": true,
  "data": {
    "date": "2026-09-12",
    "dayPillar": {
      "stem": "Ji",
      "branch": "Chou",
      "pillar": "Ji-Chou",
      "animal": "Ox"
    },
    "monthBranch": "You",
    "solarYear": 2026,
    "officer": {
      "index": 4,
      "chinese": "定",
      "pinyin": "Ding",
      "name": "Stable",
      "summary": "Settling. What is begun here is meant to last.",
      "suitable": [
        "marriage"
      ],
      "unsuitable": [
        "travel"
      ]
    },
    "mansion": {
      "index": 24,
      "chinese": "柳",
      "pinyin": "Liu",
      "name": "Willow",
      "quadrant": "Vermilion Bird",
      "planet": "Saturn",
      "weekday": 6
    },
    "clash": {
      "branch": "Wei",
      "animal": "Goat",
      "note": "A Goat person is traditionally advised to leave the day's major undertakings to somebody else."
    },
    "notes": [
      "Which officer and which mansion govern the day is exact arithmetic, pinned against published almanacs. What the day is good for is a register copied from the tradition."
    ]
  }
}

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"
  }
}