# Generate Relocation Report (PDF or HTML)

`POST https://api.astroway.info/v1/reports/relocation`

Compare up to five places for one birth chart as a multi-page A4 PDF (default) or live HTML (add `?format=html`). Per place: the relocated ascendant and midheaven with the signed shift from birth, **which planets changed house** (the substantive difference, diffed rather than left as two tables), every astrocartography line running within 300 km with its interpretation text, and supportive/challenging scores across the 19 life categories. With more than one place a side-by-side comparison leads the document. Relocation moves no planet: every body keeps its natal zodiac degree and only the houses and angles are re-cast, which the report states before anything else. Distance to a line comes from the body hour angle and altitude rather than from a discretised polyline, so it is exact. Coordinates are required per place and never defaulted. No AI narrative and no chart wheel, both on purpose: a wheel of the relocated chart reads as a second chart, and a narrative about a place is advice on where to live.

Group: Reports. Auth: `X-Api-Key` header. Operation ID: `reports_relocation`.

## Parameters

| Name | In | Required | Type | Description |
|---|---|---|---|---|
| `fields` | query | no | string | Comma-separated dotted paths, relative to `data`, to keep in the response. A path is applied to every element of an array, so `planets.name` means the name of each planet. Paths that match nothing come back in `_fields_unmatched`; a list where nothing matches at all is a 400, because an empty object would be a confident wrong answer. |
| `precision` | query | no | integer | Round every non-integer number in the response to this many decimal places. Integers are left alone, because an id is not a measurement. Ecliptic longitudes ship with fourteen decimals by default; 2 is about a tenth of an arcminute. |

## Request body

| Field | Type | Required | Description |
|---|---|---|---|
| `chart` | object | yes | Birth data for a single natal chart. Required: date (YYYY-MM-DD), time (HH:mm:ss), latitude and longitude in decimal degrees. The short forms lat, lon, lng and tz are rejected with 400 INVALID_FIELD; pass the full names. timezoneOffset is hours from UTC and defaults to 0, meaning UTC; send timezone instead (an IANA name such as Europe/Kyiv, or auto) and the offset for that date is worked out, summer time included. city is a display label only: nothing here geocodes it, so it never stands in for coordinates. houseSystem is a single Swiss Ephemeris letter, P by default; a name such as "Placidus" is refused, and the case matters because I and i are two different Sunshine systems. |
| `chart.date` | string | yes |  |
| `chart.time` | string | yes |  |
| `chart.timezoneOffset` | number | no | Hours from UTC at the given moment, not minutes. Fractional zones are hours too: 5.5 for India, 5.75 for Nepal, -3.5 for Newfoundland. Defaults to 0, meaning UTC. Ignored when timezone is sent. |
| `chart.timezone` | string | no | IANA zone name such as Europe/Kyiv, or auto to look the zone up from latitude and longitude. The server takes the offset that zone kept at this local date and time, summer time included, and uses it in place of timezoneOffset. A clock time that happened twice takes the first occurrence; one skipped when clocks went forward takes the offset from before the change. Abbreviations such as EST are refused. Before 1970 the tz database is not reliable for every place, so send timezoneOffset when the local clock is known. |
| `chart.latitude` | number | yes | Birth latitude. Required here: the whole document is computed from it. |
| `chart.longitude` | number | yes | Birth longitude. Required here: the whole document is computed from it. |
| `chart.houseSystem` | "P" \| "K" \| "R" \| "C" \| "E" \| "W" \| "B" \| "M" \| … | no |  |
| `chart.name` | string | no |  |
| `chart.city` | string | no |  |
| `chart.zodiacType` | "tropical" \| "sidereal" | no |  |
| `chart.ayanamsaId` | number | no |  |
| `chart.ayanamsa` | "fagan-bradley" \| "lahiri" \| "de-luce" \| "raman" \| "krishnamurti" \| "kp" \| "yukteshwar" \| "jn-bhasin" \| … | no | Sidereal school by name. Lahiri when omitted. Equivalent to ayanamsaId; send either. |
| `chart.cosmogram` | boolean | no |  |
| `locations` | object[] | yes |  |
| `categories` | string[] | no |  |
| `orbKm` | number | no |  |
| `language` | "uk" \| "en" \| "de" \| "ru" \| "pl" \| "es" \| "pt" \| "hi" \| … | no |  |
| `whitelabel` | boolean \| object | no |  |

```json
{
  "chart": {
    "date": "1990-05-15",
    "time": "15:30:00",
    "timezone": "Europe/Kyiv",
    "latitude": 50.45,
    "longitude": 30.52
  },
  "locations": [
    {
      "name": "Lisbon",
      "latitude": 38.7223,
      "longitude": -9.1393
    },
    {
      "name": "Vancouver",
      "latitude": 49.2827,
      "longitude": -123.1207
    }
  ],
  "categories": [
    "career",
    "love"
  ],
  "orbKm": 1126,
  "language": "uk",
  "whitelabel": false
}
```

## Responses

| Status | Meaning |
|---|---|
| 200 | Successful calculation |
| 400 | Validation error |
| 401 | Missing or invalid API key |

### Success fields, under `data`

| Field | Type | Required | Description |
|---|---|---|---|
| `url` | string | no |  |
| `storage_key` | string | no |  |
| `byte_length` | number | no |  |
| `page_count` | number | no |  |
| `duration_ms` | number | no |  |
| `expires_at` | string | no |  |

## Example

```bash
curl -X POST https://api.astroway.info/v1/reports/relocation \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "chart": { "date": "1990-05-15", "time": "15:30:00", "timezone": "Europe/Kyiv", "latitude": 50.45, "longitude": 30.52 }, "locations": [ { "name": "Lisbon", "latitude": 38.7223, "longitude": -9.1393 }, { "name": "Vancouver", "latitude": 49.2827, "longitude": -123.1207 } ], "categories": [ "career", "love" ], "orbKm": 1126, "language": "uk", "whitelabel": false }'
```

---

Rendered from https://api.astroway.info/v1/openapi.json. HTML page: https://api.astroway.info/docs/api/operations/reports_relocation/