Skip to content

Lunar Calendar Information API

1. Basic Call

TIP

The server will not record any of your requests or steal any of your privacy!

Base API URL

txt
https://zeapi.ink/v1/api/lunar

Send a GET request directly to the following URL to retrieve lunar calendar information:

txt
https://zeapi.ink/v1/api/lunar

Shell request code:

shell
curl -X GET https://zeapi.ink/v1/api/lunar

2. Request Parameters

This API does not require additional request parameters; simply call it using a GET request.

3. JSON Response Format

Example of a successful response:

json
{
    "md": "Eighth Month, First Day",
    "ymd": "Eighth Month, First Day, 2025",
    "nayin": "Great Sea Water",
    "chongsha": "Clash Horse (Bing Wu), Sha South",
    "pengzu": "Bing avoids repairing stoves, Wu avoids covering roofs",
    "xishen": "Northwest",
    "fushen": "Due East",
    "caishen": "Due South",
    "yi": "Worship, Pray for Blessings, Consecration, Seek Heirs, Travel",
    "ji": "Marriage, Groundbreaking, Burial",
    "jshen": "Si",
    "xshen": "Wu"
}

Example of an error response (data retrieval failed):

json
{
    "md": "",
    "ymd": "",
    "nayin": "",
    "chongsha": "",
    "pengzu": "",
    "xishen": "",
    "fushen": "",
    "caishen": "",
    "yi": "",
    "ji": "",
    "jshen": "",
    "xshen": ""
}

4. Response Field Descriptions

FieldTypeDescription
mdstringLunar date (month and day, e.g., "Eighth Month, First Day")
ymdstringFull lunar date (year, month, day, e.g., "Eighth Month, First Day, 2025")
nayinstringNayin (Five Elements, e.g., "Great Sea Water")
chongshastringClash and Sha information (e.g., "Clash Horse (Bing Wu), Sha South")
pengzustringPengzu's Hundred Taboos (e.g., "Bing avoids repairing stoves, Wu avoids covering roofs")
xishenstringDirection of the Joy God (e.g., "Northwest")
fushenstringDirection of the Fortune God (e.g., "Due East")
caishenstringDirection of the Wealth God (e.g., "Due South")
yistringFavorable activities (e.g., "Worship, Pray for Blessings")
jistringUnfavorable activities (e.g., "Marriage, Groundbreaking")
jshenstringAuspicious God (e.g., "Si")
xshenstringInauspicious God (e.g., "Wu")

Released under the MIT License.