get

/api/v1/chinese-calendar/compatibility

Calculate zodiac compatibility

Overview

Calculates compatibility between two birth years based on Chinese zodiac animals and elements. Uses traditional six harmonies, six clashes, and three harmonies relationships.

Parameters

NameTypeInRequiredDescription
year1stringqueryYes

First birth year

year2stringqueryYes

Second birth year

Response

200 — Compatibility analysis

person1 object required
year integer required
animal string required
Enum:
RatOxTigerRabbitDragonSnakeHorseGoatMonkeyRoosterDogPig
element string required
Enum:
WoodFireEarthMetalWater
person2 object required
year integer required
animal string required
Enum:
RatOxTigerRabbitDragonSnakeHorseGoatMonkeyRoosterDogPig
element string required
Enum:
WoodFireEarthMetalWater
compatibility object required
rating string required
Enum:
excellentgoodmoderatechallengingdifficult
score integer required
summary string required
strengths array required

array of string

challenges array required

array of string

Example Request

cURL
curl "https://api.almuten.io/api/v1/chinese-calendar/compatibility" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

JSON
{
  "person1": {
    "year": 0,
    "animal": "Rat",
    "element": "Wood"
  },
  "person2": {
    "year": 0,
    "animal": "Rat",
    "element": "Wood"
  },
  "compatibility": {
    "rating": "excellent",
    "score": 0,
    "summary": "",
    "strengths": [
      ""
    ],
    "challenges": [
      ""
    ]
  }
}