# @lune-climate/lune

> Lune Typescript Client

Latest version **3.10.1** (published 2026-11-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @lune-climate/lune
pnpm add @lune-climate/lune
yarn add @lune-climate/lune
bun add @lune-climate/lune
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.10.1 |
| Published | 2026-11-13 |
| First published | 2022-03-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 2.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 2 |
| Author | Lune Climate |
| Maintainers | rbruggem, festinajashari, jstasiak, troglo9080 |
| Keywords | Lune |

## Links

- npm: https://www.npmjs.com/package/@lune-climate/lune
- Repository: https://github.com/lune-climate/lune-ts
- Homepage: https://docs.lune.co/
- Issues: https://github.com/lune-climate/lune-ts/issues
- npm.io page: https://npm.io/package/@lune-climate/lune

## Dependencies (4)

- [axios](https://npm.io/package/axios.md) ^1.15.0
- [ts-results-es](https://npm.io/package/ts-results-es.md) ^6.0.0 || ^7.0.0
- [camelcase-keys](https://npm.io/package/camelcase-keys.md) <8.0.0
- [snakecase-keys](https://npm.io/package/snakecase-keys.md) <9.0.0

## Recent versions

- 3.10.1 (latest) — 2026-11-13
- 3.10.0 — 2026-11-11
- 3.9.8 — 2026-11-09
- 3.9.7 — 2026-11-06
- 3.9.6 — 2026-10-01
- 3.9.5 — 2026-09-15
- 3.9.4 — 2026-09-15
- 3.9.3 — 2026-09-08
- 3.9.2 — 2026-08-20
- 3.9.1 — 2026-08-07
- 3.9.0 — 2026-06-26
- 3.8.9 — 2026-04-24
- 3.8.8 — 2026-04-17
- 3.8.7 — 2026-04-16
- 3.8.6 — 2026-04-16
- … 160 more at https://npm.io/package/@lune-climate/lune/versions

## README

# Lune

Lune is Javascript/Typescript library that allows easy communication with Lune's API.
All endpoints are supported allowing for easier integration into any codebase. For a full
list of possible operations, you can rely on your IDE auto-completion, check the source
classes directly or go through our full OpenAPI schema present here:
https://docs.lune.co/openapi.yml

The library is ESM and CommonJS compatible.

## How to use

You can check some basic example usage from our github repo here:
https://github.com/lune-climate/lune-ts/tree/master/example-usage

Overview:

```javascript
import * as lune from '@lune-climate/lune';

const luneClient = new lune.LuneClient('your_api_key_would_go_here');
(async () => {
  const resp = await luneClient.createOrderByMass({
    createOrderByQuantityRequest: {
      mass: { amount: '123.21', unit: lune.MassUnit.T },
    }
  });
  // Handle error and success response separately
  if (resp.isErr()) {
      const error = resp.error
      if ('statusCode' in error) {
          console.log(`API status code (if available): ${JSON.stringify(error.errors)}`)
          console.log(`API Errors (if available): ${error.statusCode}`)
      }
      console.log(`Human friendly error description: ${error.description}`)

      return
  }
  const orderByQuantity = resp.value
  console.log(`OrderByQuantity: ${JSON.stringify(orderByQuantity)}`)
})();
```

---
_Source: https://npm.io/package/@lune-climate/lune · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
