API


Chinese Horoscope

The Chinese Horoscope endpoint calculates a person's Chinese Horoscope sign.

Basic Flow

To generate a Chinese Horoscope from the AstroAPI, the system (your implementation) makes a POST-request to the /api/chinese-horo endpoint with the necessary parameters. With correct parameters the AstroAPI will provide the sign + text.

Generating a Chinese Horoscope

POST /api/chinese-horo

Header Value
Accept-Encoding application/json
Authorization Bearer [accessToken]


body

{
    "name": "Matthias",
    "date": "1987-03-27",
    "time": "13:13",
    "lang": "en"
}


Params explanation

Header Value
name The name of the person or event you wish to create a Chinese Horoscope for
date The (birth)date of the person or event in format YYYY-mm-dd
time The (birth)time of the person or event in format HH:mm
lang The language you wish to receive the astrological interpretation texts associated with the horoscope in.

Response

Example response


JSON-object Explanation Custom Text
name Name of the person or event -
date (Birth)date of the event -
sign Chinese Horoscope Sign Name -
intro Introtext for the Chinese Horoscope sign Yes
text Text for the Chinese Horoscope sign Yes


{
    "name": "Matthias",
    "date": "1987-03-27 13:13:00",
    "sign": "Rabbit",
    "intro": "[Your custom intro]",
    "text": "<p>[Your custom text]</p>"
}