POST/v1/western/compatibility

Western Compatibility Score

Overall compatibility score (0-100) between two natal charts. Scores element affinity, synastry aspects between personal planets (Sun, Moon, Venus, Mars), and Sun/Moon/rising sign comparisons.

Request parameters

person1required

object

person1.locationoptional

string | null

City name to resolve to lat/lon/tz automatically. Example: 'Mumbai' or 'New Delhi, India'. If provided, latitude, longitude and timezone are not required.

person1.nameoptional

string

Person name associated with the birth record

person1.daterequired

string

Birth date in YYYY-MM-DD format

person1.timeoptional

string | null

Birth time in HH:MM 24-hour format. If omitted, sunrise chart is used as fallback.

person1.latitudeoptional

number | null

Latitude. Required if location not provided.

person1.longitudeoptional

number | null

Longitude. Required if location not provided.

person1.timezoneoptional

string | null

IANA timezone. Required if location not provided (unless utc_offset is given). For dates before the zone adopted a standard time, the birthplace's local mean time (longitude / 15 hours) is used.

person1.utc_offsetoptional

string | null

Optional explicit UTC offset of the birth time, as ±HH:MM or ±HH:MM:SS (e.g. '+04:51:31' for Bombay mean time). Overrides the offset timezone would give. Use it when the birth record states the offset, or for historical local times the IANA database cannot represent.

person1.ayanamsaoptional

string

Sidereal ayanamsa mode used in calculations

person2required

object

person2.locationoptional

string | null

City name to resolve to lat/lon/tz automatically. Example: 'Mumbai' or 'New Delhi, India'. If provided, latitude, longitude and timezone are not required.

person2.nameoptional

string

Person name associated with the birth record

person2.daterequired

string

Birth date in YYYY-MM-DD format

person2.timeoptional

string | null

Birth time in HH:MM 24-hour format. If omitted, sunrise chart is used as fallback.

person2.latitudeoptional

number | null

Latitude. Required if location not provided.

person2.longitudeoptional

number | null

Longitude. Required if location not provided.

person2.timezoneoptional

string | null

IANA timezone. Required if location not provided (unless utc_offset is given). For dates before the zone adopted a standard time, the birthplace's local mean time (longitude / 15 hours) is used.

person2.utc_offsetoptional

string | null

Optional explicit UTC offset of the birth time, as ±HH:MM or ±HH:MM:SS (e.g. '+04:51:31' for Bombay mean time). Overrides the offset timezone would give. Use it when the birth record states the offset, or for historical local times the IANA database cannot represent.

person2.ayanamsaoptional

string

Sidereal ayanamsa mode used in calculations

Response fields

success

boolean

True if the request succeeded

message

string

Human-readable status message

data

object

data.birth_time_provided

boolean

True only when both people supplied a birth time. See person1_birth_time_provided and person2_birth_time_provided.

data.person1_birth_time_provided

boolean

True when person 1 supplied a birth time.

data.person2_birth_time_provided

boolean

True when person 2 supplied a birth time.

data.overall_score

integer

data.element_score

integer

data.aspect_score

integer

data.sun_sign_affinity

string

data.moon_sign_affinity

string

data.rising_sign_affinity

string

data.person1_sun

string

data.person2_sun

string

data.person1_moon

string

data.person2_moon

string

data.key_aspects

array[object]

data.key_aspects[].person1_planet

string

data.key_aspects[].person2_planet

string

data.key_aspects[].type

string

data.key_aspects[].exact_angle

number

data.key_aspects[].orb

number

Errors

api_key_invalid

Invalid API key format.

api_key_missing

API key is missing. Include it in the Authorization header as 'Bearer YOUR_KEY'.

api_key_not_found

The provided API key was not found. Verify the key in your Asterwise dashboard.

api_key_revoked

This API key has been revoked.

burst_limit_exceeded

Too many requests per minute. Please slow down.

internal_error

Something went wrong on our end. Please try again, or contact [email protected] if the problem persists. Include your request_id when contacting support.

invalid_request_body

Request body is missing or malformed.

ip_rate_limit_exceeded

Too many requests from this IP address. Please slow down.

monthly_usage_limit_exceeded

Monthly API call limit reached. Upgrade your plan to continue.

payload_too_large

Request body exceeds maximum allowed size of 64KB.

subscription_expired

Your subscription has expired. Please renew at asterwise.com/dashboard to continue.

validation_error

The request couldn't be processed. See the 'details' field for specific field-level issues.

Related endpoints

• Western Composite Chart
• Western Synastry
• Western Zodiac Sign Compatibility

Request

POST·application/json

curl

curl -X POST "https://api.asterwise.com/v1/western/compatibility" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"person1":{"name":"Arjun Mehta","date":"1985-11-12","time":"06:45","latitude":19.076,"longitude":72.8777,"timezone":"Asia/Kolkata"},"person2":{"name":"Sofia Shah","date":"1988-03-24","time":"14:30","latitude":28.6139,"longitude":77.209,"timezone":"Asia/Kolkata"}}'

Python

import asterwise
from asterwise.api.western_astrology_api import WesternAstrologyApi
from asterwise.models.two_person_request import TwoPersonRequest

configuration = asterwise.Configuration(
    host="https://api.asterwise.com",
    access_token="YOUR_API_KEY",
)

request = TwoPersonRequest(
    person1={'name': 'Arjun Mehta', 'date': '1985-11-12', 'time': '06:45', 'latitude': 19.076, 'longitude': 72.8777, 'timezone': 'Asia/Kolkata'},
    person2={'name': 'Sofia Shah', 'date': '1988-03-24', 'time': '14:30', 'latitude': 28.6139, 'longitude': 77.209, 'timezone': 'Asia/Kolkata'},
)

with asterwise.ApiClient(configuration) as client:
    api = WesternAstrologyApi(client)
    result = api.western_compatibility(two_person_request=request)
    print(result)

TypeScript

import { createClient, createConfig, westernCompatibility } from 'asterwise';

const client = createClient(createConfig({
  baseUrl: 'https://api.asterwise.com',
  headers: { Authorization: 'Bearer YOUR_API_KEY' },
}));

const result = await westernCompatibility({
  client,
  body: {
      "person1": {
        "name": "Arjun Mehta",
        "date": "1985-11-12",
        "time": "06:45",
        "latitude": 19.076,
        "longitude": 72.8777,
        "timezone": "Asia/Kolkata"
      },
      "person2": {
        "name": "Sofia Shah",
        "date": "1988-03-24",
        "time": "14:30",
        "latitude": 28.6139,
        "longitude": 77.209,
        "timezone": "Asia/Kolkata"
      }
  },
});

console.log(result.data);

Response

200 OK·application/jsonsigned

{
  "success": true,
  "message": "success",
  "data": {
    "overall_score": 52,
    "element_score": 43,
    "aspect_score": 62,
    "sun_sign_affinity": "challenging",
    "moon_sign_affinity": "challenging",
    "rising_sign_affinity": "challenging",
    "person1_sun": "Scorpio",
    "person2_sun": "Aries",
    "person1_moon": "Scorpio",
    "person2_moon": "Gemini",
    "key_aspects": [
      {
        "person1_planet": "Sun",
        "person2_planet": "Sun",
        "type": "sesquiquadrate",
        "exact_angle": 134.3467,
        "orb": 0.6533
      },
      {
        "person1_planet": "Sun",
        "person2_planet": "Venus",
        "type": "opposition",
        "exact_angle": 179.9187,
        "orb": 0.0813
      },
      "... and 2 more items"
    ]
  }
}