API

Chinese Forecasts Horoscope

The Chinese Forecasts Horoscope endpoint gives you the Forecast for a year of a person's Chinese Horoscope sign.

Basic Flow

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

Generating a Chinese Horoscope

POST /api/chinese-forecasts

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


body

{
    "name": "Matthias",
    "date": "1984-03-27",
    "time": "13:13",
    "lang": "en",
    "year": 2021
}


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.
year The year you wish to receive the forecast report for.

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
year Year of the forecast - 


{
    "name": "Matthias",
    "date": "1984-03-27 13:13:00",
    "sign_id": 1,
    "sign": "Rat",
    "intro": "[Your custom intro]",
    "text": "[Your custom text]",
    "year": 2021
}