# Eclipse Path Map (SVG)

`POST https://api.astroway.info/v1/render/eclipse-path`

Equirectangular world graticule with caller-supplied eclipse track. Renders centerline + shaded band of given degree-width.

Group: Visualization. Auth: `X-Api-Key` header. Operation ID: `render_eclipse-path`.

## 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 |
|---|---|---|---|
| `path` | object[] | yes |  |
| `centerlinePoints` | object[] | no |  |
| `bandWidthDeg` | number | no |  |
| `title` | string | no |  |
| `options` | object | no |  |
| `options.size` | integer | no |  |
| `options.theme` | "light" \| "dark" \| "console" | no |  |
| `options.showAspects` | boolean | no |  |
| `options.showRetrograde` | boolean | no |  |
| `options.title` | string | no |  |
| `options.format` | "svg" \| "json" | no |  |
| `options.width` | integer | no |  |
| `options.height` | integer | no |  |
| `options.showGraticule` | boolean | no |  |
| `options.pathColor` | string | no |  |

```json
{
  "path": [
    {
      "latitude": 40,
      "longitude": -100
    },
    {
      "latitude": 35,
      "longitude": -90
    }
  ],
  "bandWidthDeg": 3,
  "title": "Eclipse 2026"
}
```

## Responses

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

### Success fields, under `data`

| Field | Type | Required | Description |
|---|---|---|---|
| `svg` | string | no |  |
| `format` | string | no |  |
| `byteLength` | number | no |  |

## Example

```bash
curl -X POST https://api.astroway.info/v1/render/eclipse-path \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "path": [ { "latitude": 40, "longitude": -100 }, { "latitude": 35, "longitude": -90 } ], "bandWidthDeg": 3, "title": "Eclipse 2026" }'
```

---

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