# Flying Star natal chart (Xuan Kong Fei Xing)

`POST https://api.astroway.info/v1/chinese/feng-shui/flying-star`

The nine-palace natal chart of a building: mountain star, period star and facing star per sector, the named arrangement (旺山旺水 and the other three), and the special patterns. Send the facing in degrees or as one of the 24 mountains, and the period directly or as the date the building was occupied. Neither is defaulted.

Group: Chinese: Zodiac & Feng Shui. Auth: `X-Api-Key` header. Operation ID: `chinese_feng-shui_flying-star`.

## 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 |
|---|---|---|---|
| `facing` | number | no |  |
| `facingMountain` | string | no |  |
| `period` | integer | no |  |
| `occupiedDate` | string | no |  |
| `occupiedTime` | string | no |  |
| `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. |
| `year` | integer | no |  |
| `language` | string | no |  |

```json
{
  "period": 8,
  "facing": 180,
  "year": 2026
}
```

## Responses

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

### Success fields, under `data`

| Field | Type | Required | Description |
|---|---|---|---|
| `period` | object | no |  |
| `period.number` | number | no |  |
| `period.source` | string | no |  |
| `period.startYear` | object | no |  |
| `period.endYear` | object | no |  |
| `facing` | object | no |  |
| `facing.degrees` | number | no |  |
| `facing.mountain` | string | no |  |
| `facing.chinese` | string | no |  |
| `facing.pinyin` | string | no |  |
| `facing.sector` | string | no |  |
| `facing.polarity` | string | no |  |
| `sitting` | object | no |  |
| `sitting.mountain` | string | no |  |
| `sitting.chinese` | string | no |  |
| `sitting.pinyin` | string | no |  |
| `sitting.sector` | string | no |  |
| `sitting.degrees` | number | no |  |
| `palaces` | object[] | no |  |
| `chartType` | object | no |  |
| `chartType.id` | string | no |  |
| `chartType.chinese` | string | no |  |
| `chartType.meaning` | string | no |  |
| `patterns` | object[] | no |  |
| `flight` | object | no |  |
| `flight.mountain` | object | no |  |
| `flight.facing` | object | no |  |
| `annualYear` | number | no |  |
| `warnings` | object[] | no |  |
| `notes` | string[] | no |  |

## Example

```bash
curl -X POST https://api.astroway.info/v1/chinese/feng-shui/flying-star \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "period": 8, "facing": 180, "year": 2026 }'
```

---

Rendered from https://api.astroway.info/v1/openapi.json. HTML page: https://api.astroway.info/docs/api/operations/chinese_feng-shui_flying-star/