Retrieve trajectory predictions for a balloon launch. This endpoint simulates balloon flight paths based on launch conditions, balloon physics, and altitude control strategies.
The following required and optional parameters control the trajectory prediction.
| Name | Type | Description |
|---|---|---|
| latitude Required | number | Launch latitude in decimal degrees (-90 to 90) |
| longitude Required | number | Launch longitude in decimal degrees (-180 to 180) |
| time Required | number | Launch time as Unix timestamp (seconds since epoch) |
| h0 Required | number | Initial altitude in meters above sea level |
| Name | Type | Default | Description |
|---|---|---|---|
| v0 Optional | number | 0 | Initial ascent rate in meters per second |
| Name | Type | Default | Description |
|---|---|---|---|
| simCount Required | number | - | Number of Monte Carlo runs. 0 = setpoint mode, >0 = bounds mode |
| Name | Type | Default | Description |
|---|---|---|---|
| dt Required | number | - | Time discretization step (seconds) |
| downsample Optional | number | None | Downsample factor for output points |
The API operates in bounds mode, which simulates uncertainty and uses altitude constraints to guide the balloon trajectory.
The balloon operates within altitude constraints and the simulation explores uncertainties through Monte Carlo runs.
| Name | Type | Description |
|---|---|---|
| softUpperBound Required | string | Comma-separated preferred upper altitude limits in meters over time Example: 15000,16000,15500 |
| softLowerBound Required | string | Comma-separated preferred lower altitude limits in meters over time Example: 5000,6000,5500 |
| hardUpperBound Optional | string | Comma-separated absolute upper altitude limits in meters (hard constraints) Example: 16000,17000,16500 |
| hardLowerBound Optional | string | Comma-separated absolute lower altitude limits in meters (hard constraints) Example: 4000,4500,4000 |
In setpoint mode, the balloon follows a fixed altitude profile.
| Name | Type | Description |
|---|---|---|
| profile Required for setpoint mode | string | Comma-separated altitude checkpoints in meters. Format: altitude1,altitude2,altitude3 Example: 5000,8000,12000 |