Generate Chinese Year Forecast (PDF or HTML)
astroway_reports_chinese_yearGenerate a Chinese zodiac year forecast report in PDF, HTML, or Markdown with your animal and element, Lichun dates, Tai Sui relations, allies, opposites, and monthly pillars.
Instructions
A Chinese zodiac year forecast as an A4 PDF (default), HTML or Markdown: your animal and the element of your birth year with their characterisation, the pillar of the year asked for with its exact Lichun dates, how the year's branch stands to yours (your own year 本命年, the clash 冲太岁, harmony, trine, harm or neutral) and how its element stands to yours, your allies and opposites, and the twelve solar months with their pillars and their relation to your branch. Animal from /chinese/zodiac/animal, boundaries from the ephemeris. year defaults to next calendar year.
[Group: Reports] [Endpoint: POST /v1/reports/chinese-year] [Required: date] [Cost: 5,000 credits (Tier 7)] ⚠️ Premium — ~50% of free monthly budget. Confirm with user before invoking.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | Yes | ||
| name | No | Printed on the cover. | |
| time | No | Birth time; decides the animal for a birth within a day of Lichun. | |
| year | No | The Chinese year read, counted from its Lichun. Defaults to next calendar year. | |
| format | No | `pdf` (default) stores a PDF and answers with its `url`. `html` returns one self-contained `text/html` document, `markdown` returns `text/markdown` with the same sections and tables; neither is stored. Same price in every format. | |
| language | No | ||
| timezone | No | 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. | |
| whitelabel | No | ||
| timezoneOffset | No | 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. Ignored when timezone is sent. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | ||
| expires_at | No | ||
| page_count | No | ||
| byte_length | No | ||
| duration_ms | No | ||
| storage_key | No |