Astrology icon

Astrology

Perform astrological calculations via Astrology API

Actions231

Chinese → Compatibility

AI-generated

Summary

Calculate Chinese astrology compatibility between two individuals based on their full birth data, including date, time, and location, returning an interpretative compatibility report.

Inputs

  • year (required) — Birth year of the first person (4-digit format, e.g., 1990).
  • month (required) — Birth month of the first person as number 1-12.
  • day (required) — Birth day of the first person (1-31).
  • hour (required) — Birth hour of the first person in 24-hour format (0-23).
  • minute (required) — Birth minute of the first person (0-59).
  • locationType (required) — Choice to specify birth location by city name or exact latitude/longitude for the first person.
  • city (required) — Birth city name of the first person when locationType is 'city'.
  • countryCode (required) — 2-letter ISO country code for the first person's birth city when locationType is 'city'.
  • latitude (required) — Latitude in decimal degrees for the first person's birth location when locationType is 'coordinates'.
  • longitude (required) — Longitude in decimal degrees for the first person's birth location when locationType is 'coordinates'.
  • subject2Name — Optional name for the second person, used in report titles.
  • subject2Year (required) — Birth year of the second person (4-digit format).
  • subject2Month (required) — Birth month of the second person as number 1-12.
  • subject2Day (required) — Birth day of the second person (1-31).
  • subject2Hour (required) — Birth hour of the second person in 24-hour format (0-23).
  • subject2Minute (required) — Birth minute of the second person (0-59).
  • subject2LocationType (required) — Choice to specify birth location for the second person by city or coordinates.
  • subject2City (required) — Birth city name of the second person when subject2LocationType is 'city'.
  • subject2CountryCode (required) — 2-letter ISO country code for the second person's birth city when subject2LocationType is 'city'.
  • subject2Latitude (required) — Latitude for the second person's birth location when subject2LocationType is 'coordinates'.
  • subject2Longitude (required) — Longitude for the second person's birth location when subject2LocationType is 'coordinates'.
  • language (required) — Language code for response text and interpretations (e.g., 'en' for English).
  • simplify (required) — Boolean to return a simplified compatibility report with key data only, or full detailed API response.

Output shape

a JSON object representing the compatibility report between two subjects including interpretive text.

The returned data contains detailed compatibility analysis between two persons based on Chinese astrology using complete birth information including date, time, and location. If 'simplify' is enabled, the response returns only the key overview fields for easier integration; disabling it returns the full detailed data with all metadata and interpretive text. The language of response contents depends on the 'language' input. Errors or incomplete inputs may cause the API to return an error response.

Examples

Example 1: Use this operation to determine the Chinese astrology compatibility between two people by providing their full birth date, time, and geographic locations. Opt to receive a concise summary or detailed interpretive data in the language of choice.

Set resource to Chinese and operation to Compatibility. Provide full birth data for both persons, including year, month, day, hour, minute, and either city with country code or latitude/longitude coordinates. Choose output language and whether to simplify the response.

Links

Discussion