Relocation Report API
AvailableRelocation reading: relocation potential, stay-or-move verdict, foreign settlement, best directions, house and D4 analysis, dasha support, ranked places, timing and a confidence statement.
Call it with POST /v1/reports/report-relocation. Input: birth details. Output: JSON, as a direct response (json); pdf via /v1/jobs/pdf. Each successful call costs 10 credits.
- Endpoint
- POST /v1/reports/report-relocation
- Input
- Birth details
- Output
- JSON
- Delivery
- Direct response (JSON); PDF via /v1/jobs/pdf
- Cost
- 10 credits
- Compute class
- Report
Example response
Fields in data (inferred from the example)
topic· stringtitle· stringascendant· objectrelocation_potential· objectstay_or_move· objectforeign_settlement· objectrelocation_types· array of objectdirections· objecthouse_analyses· array of objectd4· objectdasha_support· objectcities· objectstates· objectcountries· objectgoals· objectcaution_locations· array of objecttiming· objectconfidence· objectevidence· array of objectmeta· 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 Reports reference.
Relocation Report API: common questions
What does the Relocation Report API return?
Relocation reading: relocation potential, stay-or-move verdict, foreign settlement, best directions, house and D4 analysis, dasha support, ranked places, timing and a confidence statement. The response's data object includes topic, title, ascendant, relocation_potential, stay_or_move, foreign_settlement, relocation_types and directions. See the reference for an example response.
What input does Relocation Report need?
Birth details.
How much does a Relocation Report call cost?
10 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.