> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Stormglass plugin

> Global weather, marine, tide, astronomy, solar, bio and elevation data for any coordinate, from the Stormglass API.

Use **Stormglass** through Corsair: one client, typed API calls, local DB sync.

The plugin covers the whole Stormglass v2 API: hourly weather and marine forecasts, historical weather back to 2014, tide extremes and hourly sea levels, tide stations, astronomy, solar, bio and elevation.
Get a key from the Stormglass dashboard; it is sent as the Authorization header with no Bearer prefix. Every call counts against the account's daily request quota (10 a day on the free plan); each response's `quota` shows the limit and how many requests were used today. A 402 means the quota is used up.
Hourly ops return `values` (one number per parameter: the first source you asked for, else Stormglass's own `sg` blend) and `sources` (every source's value). Times are UTC; `start` and `end` take UNIX seconds or ISO strings such as 2024-01-01 or 2024-01-01T06, and one call covers at most 10 days.
Tide data is astronomical tide from the nearest tide station; `station` in the result names it and its distance. Coordinates are not written to events.

**What you get:**

* 10 typed API operations
* 4 synced entities (`extremes`, `points`, `quotas`, `stations`) for fast `.search()` / `.list()`

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/stormglass better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/stormglass better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/stormglass better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/stormglass better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { stormglass } from '@corsair-dev/stormglass';

export const corsair = createCorsair({
	plugins: [
		stormglass(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Stormglass API key before the first call: `pnpm corsair setup --plugin=stormglass --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> stormglass()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'stormglass',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Get the wind and wave forecast**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.stormglass.api.weather.get({ lat: 58.7984, lng: 17.8081, params: 'windSpeed,waveHeight' });
```

**Write**

*No write-style endpoint inferred; pick any operation from the [API](https://docs.corsair.dev/plugins/stormglass/api.md) reference.*

See the full list on the [API](https://docs.corsair.dev/plugins/stormglass/api.md) page.

## Query synced data

Synced entities support `tenant.stormglass.db.<entity>.search()` and `.list()`: `extremes`, `points`, `quotas`, `stations`.

See [Database](https://docs.corsair.dev/plugins/stormglass/database.md) for filters and operators.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/stormglass/api.md)
>
> Every `stormglass.api.*` operation with input and output types.

> [card] [Database](https://docs.corsair.dev/plugins/stormglass/database.md)
>
> Synced entities, search filters, and operators.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.