# Generate Chinese Year Forecast (PDF or HTML)

`POST https://api.astroway.info/v1/reports/chinese-year`

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. A reading by the birth-year animal, and it says so. No AI. Texts in Ukrainian or English; any other language gets the English document.

Group: Reports. Auth: `X-Api-Key` header. Operation ID: `reports_chinese-year`.

## Parameters

| Name | In | Required | Type | Description |
|---|---|---|---|---|
| `retain_days` | query | no | integer | How many days the PDF stays at its `url`. 1 by default; up to 90 for a link you hand to a client. Delete it sooner with `DELETE /v1/reports/files/{filename}`. |
| `format` | query | no | "pdf" \| "html" \| "markdown" | Same switch as the `format` body field (send one or the other; two different values are a 400). `pdf` stores a PDF and answers with its `url`. `html` returns one self-contained `text/html` document (inline CSS and drawings, no scripts, no external fonts; the white-label logo stays a link to your https image). `markdown` returns `text/markdown` with the same headings, text and tables, drawings left out with a one-line note. Neither html nor markdown is stored, so `retain_days` does not apply. Same price in every format. |
| `fields` | query | no | 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. |
| `precision` | query | no | integer | 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. |
| `Idempotency-Key` | header | no | string | Unique per logical operation, kept across retries. For 24 hours from the first request, a repeat with the same key, method, path, body and query string returns the stored response with `Idempotent-Replayed: true` and costs 0 credits. The same key with a different body or query string is a 409 `IDEMPOTENCY_KEY_REUSED`; a repeat while the first is still running is a 409 `IDEMPOTENCY_IN_PROGRESS`. Only 2xx responses are kept. See /idempotency/. |

## Request body

| Field | Type | Required | Description |
|---|---|---|---|
| `date` | string | yes |  |
| `time` | string | no | Birth time; decides the animal for a birth within a day of Lichun. |
| `timezoneOffset` | number | 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. |
| `timezone` | string | 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. |
| `year` | integer | no | The Chinese year read, counted from its Lichun. Defaults to next calendar year. |
| `name` | string | no | Printed on the cover. |
| `language` | "uk" \| "en" \| "de" \| "ru" \| "pl" \| "es" \| "pt" \| "hi" \| … | no |  |
| `whitelabel` | boolean \| object | no |  |
| `format` | "pdf" \| "html" \| "markdown" | 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. |

```json
{
  "name": "Olena",
  "date": "1990-05-15",
  "time": "14:30",
  "timezoneOffset": 3,
  "year": 2027,
  "language": "uk"
}
```

## Responses

| Status | Meaning |
|---|---|
| 200 | With `format` `pdf` (default): JSON with the stored PDF `url` and its `expires_at`. With `html` or `markdown`: the document itself, nothing stored. |
| 400 | Validation error |
| 401 | Missing or invalid API key |

### Success fields, under `data`

| Field | Type | Required | Description |
|---|---|---|---|
| `url` | string | no |  |
| `storage_key` | string | no |  |
| `byte_length` | number | no |  |
| `page_count` | number | no |  |
| `duration_ms` | number | no |  |
| `expires_at` | string | no |  |

## Example

```bash
curl -X POST https://api.astroway.info/v1/reports/chinese-year \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Olena", "date": "1990-05-15", "time": "14:30", "timezoneOffset": 3, "year": 2027, "language": "uk" }'
```

---

Rendered from https://api.astroway.info/v1/openapi.json. HTML page: https://api.astroway.info/docs/api/operations/reports_chinese-year/