Relocation Compatibility
The Relocation Compatibility endpoint compares a person with a city, country, optional address, and optional move date for symbolic relocation fit. It is part of the v1.0.2 preparation set and uses the expanded 26-locale meaning bundles.
Endpoint
| Method | Path |
GET | https://api.numerologyapi.com/api/v1/relocation-compatibility |
POST | https://api.numerologyapi.com/api/v1/relocation-compatibility |
Availability
- Authentication:
X-API-Key or Authorization: Bearer YOUR_API_KEY - Supported
lang values: en, fr, es, de, pt, ja, hi, ar, ru, tr, it, pl, nl, id, ko, th, ro, ur, gu, bn, vi, ta, te, mr, pa, zh - Access channel: direct API (
https://api.numerologyapi.com) - RapidAPI gateway: Not currently supported for extended endpoints
- Optional numerology systems:
pythagorean, chaldean, vedic (pythagorean is the default) - Release target: v1.0.2. The already-released v1.0.1 docs remain accurate at 8-language support.
Parameters
GET Query Parameters
| Parameter | Type | Required | Default | Options | Description |
full_name | string | Yes | — | length 1..160 | Person name |
dob | string | Yes | — | YYYY-MM-DD | Date of birth |
destination_city | string | Yes | — | length 1..120 | Destination city |
destination_country | string | No | null | length 0..120 | Destination country |
address_line | string | No | null | length 0..180 | Optional address or neighborhood |
move_date | string | No | null | YYYY-MM-DD | Optional move date |
priority | string | No | career | career, belonging, relationships, creativity, restoration | Relocation priority |
num_sys | string | No | pythagorean | pythagorean, chaldean, vedic | Numerology system |
lang | string | No | en | 26 supported locales | Response language |
POST Query Parameters
| Parameter | Type | Required | Default | Options | Description |
lang | string | No | en | 26 supported locales | Response language |
POST Body Parameters
| Parameter | Type | Required | Default | Options | Description |
full_name | string | Yes | — | length 1..160 | Person name |
dob | string | Yes | — | YYYY-MM-DD | Date of birth |
destination_city | string | Yes | — | length 1..120 | Destination city |
destination_country | string | No | null | length 0..120 | Destination country |
address_line | string | No | null | length 0..180 | Optional address or neighborhood |
move_date | string | No | null | YYYY-MM-DD | Optional move date |
priority | string | No | career | career, belonging, relationships, creativity, restoration | Relocation priority |
num_sys | string | No | pythagorean | pythagorean, chaldean, vedic | Numerology system |
Request Examples
GET
curl -H "X-API-Key: YOUR_API_KEY" \
"https://api.numerologyapi.com/api/v1/relocation-compatibility?full_name=Maya%20Thompson&dob=1988-09-23&destination_city=Lisbon&destination_country=Portugal&address_line=18%20Rua%20do%20Sol&move_date=2027-03-01&priority=career&num_sys=chaldean&lang=en"
POST
curl -X POST "https://api.numerologyapi.com/api/v1/relocation-compatibility?lang=en" \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"full_name": "Maya Thompson",
"dob": "1988-09-23",
"destination_city": "Lisbon",
"destination_country": "Portugal",
"address_line": "18 Rua do Sol",
"move_date": "2027-03-01",
"priority": "career",
"num_sys": "chaldean"
}'
POST Body Example
{
"full_name": "Maya Thompson",
"dob": "1988-09-23",
"destination_city": "Lisbon",
"destination_country": "Portugal",
"address_line": "18 Rua do Sol",
"move_date": "2027-03-01",
"priority": "career",
"num_sys": "chaldean"
}
Response Highlights
relocation_composite_number destination_number address_number move_date_number relocation_scores alignment_band meaning
Response Example Shape
{
"numerology_system": "pythagorean",
"meaning": { "title": "...", "overview": "..." },
"detailed_meaning": "...",
"_api_metadata_": {
"endpoint_name": "relocation_compatibility",
"response_language": "en",
"supported_languages": ["en", "fr", "es", "de", "pt", "ja", "hi", "ar", "ru", "tr", "it", "pl", "nl", "id", "ko", "th", "ro", "ur", "gu", "bn", "vi", "ta", "te", "mr", "pa", "zh"]
}
}
Open Dashboard
Note
This endpoint belongs to the Extended suite and is available through direct API access at https://api.numerologyapi.com. It is currently not supported via the RapidAPI gateway.