Full Chart (computed)

POST

/ziwei/chart

request.sh

curl -X POST https://api.astroway.info/v1/ziwei/chart \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "date": "2000-08-16", "time": "04:00:00", "gender": "male" }'

▸ Try it POST /ziwei/chart

• Production

Real star placement: soul and body palaces, the five-element class, all 14 main stars plus auxiliaries, the twelve stages, the 12 decade limits and the 四化 marked on the stars that carry them.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

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

4

Request Body ^required

Media type application/json

object

date required

string

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

time required

string

/^\d{2}:\d{2}(:\d{2})?$/

timezoneOffset

Ignored when timezone is sent.

number

>= -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

longitude

number

>= -180 <= 180

trueSolarTime

boolean

gender required

string

Allowed values: male female

school

string

Allowed values: zhongzhou quanji quanshu beipai

yearDivide

string

Allowed values: lunar lichun

fixLeap

boolean

dayDivide

string

Allowed values: forward current

tianmaSchool

string

Allowed values: year month

age

integer

>= 1 <= 120

language

string

Example

{
  "date": "2000-08-16",
  "time": "04:00:00",
  "gender": "male"
}

Responses

200

Successful calculation

Media type application/json

object

ok

boolean

data

object

lunar

object

month

number

nullable

isLeapMonth

boolean

nullable

day

number

nullable

monthStart

string

nullable

fiveElementClass

object

key

string

nullable

chinese

string

nullable

value

number

nullable

soulPalace

object

index

number

nullable

branch

string

nullable

ziwei

object

index

number

nullable

branch

string

nullable

palaces

Array<object>

nullable

object

branch

string

nullable

palace

string

nullable

pillar

string

nullable

majorStars

Array<object>

nullable

object

chinese

string

nullable

name

string

nullable

lifeStage

object

chinese

string

nullable

name

string

nullable

decade

object

index

number

nullable

fromAge

number

nullable

toAge

number

nullable

computed

boolean

nullable

Example

{
  "ok": true,
  "data": {
    "lunar": {
      "month": 7,
      "isLeapMonth": false,
      "day": 17,
      "monthStart": "2000-07-31"
    },
    "fiveElementClass": {
      "key": "wood3",
      "chinese": "木三局",
      "value": 3
    },
    "soulPalace": {
      "index": 4,
      "branch": "Wu"
    },
    "ziwei": {
      "index": 4,
      "branch": "Wu"
    },
    "palaces": [
      {
        "branch": "Wu",
        "palace": "destiny",
        "pillar": "Ren-Wu",
        "majorStars": [
          {
            "chinese": "紫微",
            "name": "Purple Star"
          }
        ],
        "lifeStage": {
          "chinese": "死",
          "name": "Death"
        },
        "decade": {
          "index": 0,
          "fromAge": 3,
          "toAge": 12
        }
      }
    ],
    "computed": true
  }
}

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