Chinese Zodiac Animal

POST

/chinese/zodiac/animal

• Production

Animal sign of birth year (Lichun / Feb 4 cutoff) plus full pillar (stem + branch + element).

Authorizations

• ApiKeyAuth

Code Samples

cURL

curl -X POST https://api.astroway.info/v1/chinese/zodiac/animal \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "date": "1990-05-15", "time": "14:30:00", "timezoneOffset": 3, "latitude": 50.45, "longitude": 30.52 }'

Node.js

const res = await fetch('https://api.astroway.info/v1/chinese/zodiac/animal', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.ASTROWAY_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "date": "1990-05-15",
    "time": "14:30:00",
    "timezoneOffset": 3,
    "latitude": 50.45,
    "longitude": 30.52
  }),
});
const { ok, data, error } = await res.json();
if (!ok) throw new Error(error.message);
console.log(data);

Python

import os, requests

r = requests.post(
    'https://api.astroway.info/v1/chinese/zodiac/animal',
    headers={'X-Api-Key': os.environ['ASTROWAY_API_KEY'], 'Content-Type': 'application/json'},
    json={
      'date': "1990-05-15",
      'time': "14:30:00",
      'timezoneOffset': 3,
      'latitude': 50.45,
      'longitude': 30.52
    },
)
result = r.json()
if not result['ok']:
    raise RuntimeError(result['error']['message'])
print(result['data'])

PHP

<?php
use GuzzleHttp\Client;

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

Request Body ^required

object

Example

{
  "date": "1990-05-15",
  "time": "14:30:00",
  "timezoneOffset": 3,
  "latitude": 50.45,
  "longitude": 30.52
}

Responses

200

Successful calculation

object

ok

boolean

Example

true

data

object

solarYear

number

animal

string

glyph

string

branch

string

stem

string

element

object

fixed

string

cycling

string

yin

boolean

pillar

string

Example

{
  "ok": true,
  "data": {
    "solarYear": 1990,
    "animal": "Horse",
    "glyph": "🐎",
    "branch": "Wu",
    "stem": "Geng",
    "element": {
      "fixed": "Fire",
      "cycling": "Metal",
      "yin": false
    },
    "pillar": "Geng-Wu"
  }
}

400

Validation error

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

Example

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