Region Analysis API
AvailableScores a drawn polygon or bounding box from the cities inside it, with lines and strongest planets.
Call it with POST /v1/location-astrology/zone-analysis. Input: birth details. Output: JSON, as a direct response. Each successful call costs 3 credits. It offers 16 options, such as Career, Marriage and Wealth.
- Endpoint
- POST /v1/location-astrology/zone-analysis
- Input
- Birth details
- Output
- JSON
- Delivery
- Direct response
- Cost
- 3 credits
- Compute class
- Heavy
Options
- Career
- Marriage
- Wealth
- Spiritual
- Health
- Education
- Peace of mind
- Children
- Property
- Romance
- Fame
- Foreign settlement
- Travel
- Politics
- Arts
- Business
Example response
Fields in data (inferred from the example)
goal· stringformula· array of objectarea_km2· numbercities_inside· integercities_in_catalogue· integerscore· objectbest_goals· array of objectlines_crossing· array of objectparans_inside· array of objectstrongest_planets· array of objecttop_cities· array of objectbounds· object
Example response
Captured from the live engine with a sandbox key (so credits_used is 0) and trimmed: long arrays keep their first items and images are replaced by a placeholder.
Loading the example…
Request schema and every field: the Location astrology reference.
Region Analysis API: common questions
What does the Region Analysis API return?
Scores a drawn polygon or bounding box from the cities inside it, with lines and strongest planets. The response's data object includes goal, formula, area_km2, cities_inside, cities_in_catalogue, score, best_goals and lines_crossing. See the reference for an example response.
What input does Region Analysis need?
Birth details. It accepts 16 options, for example Career, Marriage and Wealth.
How much does a Region Analysis call cost?
3 credits per successful call; a failed call is not charged. Plans and top-ups are on the pricing page.
Can I try it before paying?
Yes. Every account gets sandbox keys and trial credits, so you can call it from your own code before choosing a plan.