Generate Chinese Year Forecast (PDF or HTML)

Відкрити як Markdown Налаштування агента

POST

/reports/chinese-year

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

const res = await fetch('https://api.astroway.info/v1/reports/chinese-year', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Olena",
    "date": "1990-05-15",
    "time": "14:30",
    "timezoneOffset": 3,
    "year": 2027,
    "language": "uk"
  }),
});
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/reports/chinese-year',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
    json={
      'name': "Olena",
      'date': "1990-05-15",
      'time': "14:30",
      'timezoneOffset': 3,
      'year': 2027,
      'language': "uk"
    },
)
result = r.json()
if not result['ok']:
    raise RuntimeError(result['error']['message'])
print(result['data'])

<?php
use GuzzleHttp\Client;

$client = new Client(['base_uri' => 'https://api.astroway.info/v1/']);
$r = $client->post('reports/chinese-year', [
    'headers' => ['X-Api-Key' => getenv('ASTROWAY_API_KEY')],
    'json' => [
        'name' => 'Olena',
        'date' => '1990-05-15',
        'time' => '14:30',
        'timezoneOffset' => 3,
        'year' => 2027,
        'language' => 'uk',
    ],
]);
$result = json_decode($r->getBody(), true);
if (!$result['ok']) throw new \RuntimeException($result['error']['message']);
print_r($result['data']);

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.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

retain_days

integer

default: 1 >= 1 <= 90

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

string

default: pdf

Allowed values: 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

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.

Example

planets.name,planets.longitude

precision

integer

<= 15

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.

Example

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters /^[\x21-\x7E]+$/

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/.

Example

01HXY2A7ZM0ABCDEF

Request Body^required

application/json

object

date required

string

/^\d{4}-\d{2}-\d{2}$/

time

Birth time; decides the animal for a birth within a day of Lichun.

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. Ignored when timezone is sent.

number

0 nullable >= -14 <= 14

timezone

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.

string

year

The Chinese year read, counted from its Lichun. Defaults to next calendar year.

integer

>= 1900 <= 2100

name

Printed on the cover.

string

<= 100 characters

language

string

Allowed values: uk en de ru pl es pt hi fr ko it ja id tr nl ro cs vi ar el hu

whitelabel

Any of:

boolean
object

boolean

format

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.

string

Allowed values: pdf html markdown

Example

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

Responses

200

With format pdf (default): JSON with the stored PDF url and its expires_at. With html or markdown: the document itself, nothing stored.

object

boolean

data

object

url

string

nullable

storage_key

string

nullable

byte_length

number

nullable

page_count

number

nullable

duration_ms

number

nullable

expires_at

string

nullable

Example

{
  "ok": true,
  "data": {
    "url": "https://api.astroway.info/reports/3e6f8041-5d70-4fb1-8c43-9d0e1f2a3b4c-chinese-year.pdf",
    "storage_key": "reports/3e6f8041-5d70-4fb1-8c43-9d0e1f2a3b4c-chinese-year.pdf",
    "byte_length": 85000,
    "page_count": 3,
    "duration_ms": 1100,
    "expires_at": "2026-11-08T12:00:00.000Z"
  }
}

string

Example

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><title>Natal Chart Report: Ada</title><style>h1{color:#d4a84c}</style></head><body><h1>Natal Chart Report</h1><p class="subtitle">Prepared for Ada</p><h2>Big Three</h2>...</body></html>

string

Example

# Natal Chart Report

Prepared for Ada

**Birth date:** 1990-05-15 **Birth time:** 14:30:00

## Big Three

Sun · ☉ · Taurus · 24.21°

## Planets

| Planet | Sign | Degree | House | Motion |
| --- | --- | --- | --- | --- |
| Sun | Taurus | 24.21° | 9 | – |

400

Validation error

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

application/json

Example

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

Generate Chinese Year Forecast (PDF or HTML)

Authorizations

Parameters

Query Parameters

Example

Example

Header Parameters

Example

Request Body required

Example

Responses

200

Example

Example

Example

400

Example

401

Example

Request Body^required