# Forecast routes

URL: /code/api/forecast · Id: `page:code/api/forecast`

> Every Forecast Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for [Forecast](/business/nouns/forecast).

| Noun | System | Run by |
| --- | --- | --- |
| [Forecast](/business/nouns/forecast) | [Treasury](/systems/treasury) | [Treasurer](/agents/finance/treasurer) |

### Forecast.create
Creates a Forecast. [Verb page](/business/nouns/forecast/create?interface=api).

```text
POST /{namespace}/forecasts
```

Body, as JSON: the inputs. Emits `Forecast.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `asOf` | `datetime` | Yes | When the inputs were read. |
| `runwayWeeks` | `number` | Yes | Weeks until cash reaches zero at the projected rates. |
| `defaultAlive` | `boolean` | Yes | True when projected revenue covers projected Cost before cash runs out. |
| `profitWeek` | `date` | No | The first week projected revenue covers fully loaded Cost. |
| `spendState` | `string` | Yes | The spend state it sets: `free` when default alive, `tight` when default dead, `hold` under 13 weeks of runway. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `forecast` | [Forecast](/business/nouns/forecast) | Yes | The Forecast. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl -X POST https://api.sb/leaseline.app/forecasts \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"asOf":"2026-10-22T12:00:00Z","runwayWeeks":1,"defaultAlive":true,"spendState":"free"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "forecast": {
    "$id": "https://api.sb/leaseline.app/forecasts/forecast_a2kwkwcmRy",
    "$type": "Forecast",
    "asOf": "2026-10-22T12:00:00Z",
    "runwayWeeks": 1,
    "defaultAlive": true,
    "spendState": "free"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Forecast.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

### Forecast.get
Returns one Forecast by id. [Verb page](/business/nouns/forecast/get?interface=api).

```text
GET /{namespace}/forecasts/{id}
```

Path: `id`. Query: the other inputs. Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Forecast. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `forecast` | [Forecast](/business/nouns/forecast) | Yes | The Forecast. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl https://api.sb/leaseline.app/forecasts/forecast_a2kwkwcmRy \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Forecast",
  "$id": "https://api.sb/leaseline.app/forecasts/forecast_a2kwkwcmRy",
  "forecast": {
    "$id": "https://api.sb/leaseline.app/forecasts/forecast_a2kwkwcmRy",
    "$type": "Forecast",
    "asOf": "2026-10-22T12:00:00Z",
    "runwayWeeks": 1,
    "defaultAlive": true,
    "spendState": "free"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/forecasts/forecast_a2kwkwcmRy",
    "up": "https://api.sb/leaseline.app/forecasts"
  }
}
```

### Forecast.list
Returns Forecasts, newest first, one page at a time. [Verb page](/business/nouns/forecast/list?interface=api).

```text
GET /{namespace}/forecasts
```

Query: the inputs. Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `forecasts` | list of [Forecast](/business/nouns/forecast) | Yes | One page of Forecasts. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl "https://api.sb/leaseline.app/forecasts?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Forecast",
  "forecasts": [
    {
      "$id": "https://api.sb/leaseline.app/forecasts/forecast_a2kwkwcmRy",
      "$type": "Forecast",
      "asOf": "2026-10-22T12:00:00Z",
      "runwayWeeks": 1,
      "defaultAlive": true,
      "spendState": "free"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "forecast_a2kwkwcmRy"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/forecasts?limit=20",
    "next": "https://api.sb/leaseline.app/forecasts?after=forecast_a2kwkwcmRy"
  }
}
```