get
/api/v1/chinese-calendar/year/{year}
Get Chinese year information
Overview
Returns comprehensive Chinese lunar calendar information for a Gregorian year, including zodiac animal, element, sexagenary cycle, and Chinese New Year date.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
year | string | path | Yes | Gregorian year (1900-2100) |
Response
200 — Chinese year information
gregorianYearinteger requiredchineseYearinteger requiredsexagenaryCycleobject requiredyearInCycleinteger requiredstemobject requiredindexinteger requiredchinesestring requiredpinyinstring requiredelementstring required- Enum:
WoodFireEarthMetalWater polaritystring required- Enum:
YangYin
branchobject requiredindexinteger requiredchinesestring requiredpinyinstring requiredanimalstring required- Enum:
RatOxTigerRabbitDragonSnakeHorseGoatMonkeyRoosterDogPig
combinedstring requiredcombinedPinyinstring required
zodiacAnimalobject requiredenglishstring required- Enum:
RatOxTigerRabbitDragonSnakeHorseGoatMonkeyRoosterDogPig chinesestring requiredpinyinstring requiredcharacteristicsarray requiredarray of string
compatibleWitharray requiredarray of string
incompatibleWitharray requiredarray of string
elementobject requiredenglishstring required- Enum:
WoodFireEarthMetalWater chinesestring requiredpinyinstring required
polaritystring required- Enum:
YangYin newYearobject requireddatestring requiredgregorianDatestring required
hasLeapMonthboolean requiredleapMonthinteger requiredtotalDaysinteger required
Example Request
cURL
curl "https://api.almuten.io/api/v1/chinese-calendar/year/{year}" \
-H "Authorization: Bearer YOUR_API_KEY"Example Response
JSON
{
"gregorianYear": 0,
"chineseYear": 0,
"sexagenaryCycle": {
"yearInCycle": 1,
"stem": {
"index": 0,
"chinese": "",
"pinyin": "",
"element": "Wood",
"polarity": "Yang"
},
"branch": {
"index": 0,
"chinese": "",
"pinyin": "",
"animal": "Rat"
},
"combined": "",
"combinedPinyin": ""
},
"zodiacAnimal": {
"english": "Rat",
"chinese": "",
"pinyin": "",
"characteristics": [
""
],
"compatibleWith": [
"Rat"
],
"incompatibleWith": [
"Rat"
]
},
"element": {
"english": "Wood",
"chinese": "",
"pinyin": ""
},
"polarity": "Yang",
"newYear": {
"date": "",
"gregorianDate": ""
},
"hasLeapMonth": true,
"leapMonth": 1,
"totalDays": 0
}