# lunar-api

> JavaScript Wrapper for Lunar API

Latest version **1.1.2** (published 2022-11-13) · AGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install lunar-api
pnpm add lunar-api
yarn add lunar-api
bun add lunar-api
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2022-11-13 |
| First published | 2022-10-06 |
| Weekly downloads | 0 |
| License | AGPL-3.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 22.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | WinterFe#2000 |
| Maintainers | lunarsdev |
| Keywords | api, rest-api, lunar-api, lunarapi, wrapper, images, anime, discordbot, discord, lunar, lunar-api |

## Links

- npm: https://www.npmjs.com/package/lunar-api
- Repository: https://github.com/LunarsDev/lunar-js
- Homepage: https://docs.lunardev.group/
- Issues: https://github.com/LunarsDev/lunar-js/issues
- npm.io page: https://npm.io/package/lunar-api

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [node-superfetch](https://npm.io/package/node-superfetch.md) ^0.2.3

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 1.1.2 (latest) — 2022-11-13
- 1.1.1 — 2022-10-11
- 1.1.0 — 2022-10-06
- 1.0.0 — 2022-10-06

## README

# ⚡ Lunar API

<center>
    <h3>
        <kbd>JS Library for the Lunar API
    </h3>
</center>

---

### Lunar API lets you interact with our image libraries and image generation
<br>

> Currently this library does not support our image generation endpoints, but will be available in a later update.

```js
require('dotenv').config();
const LunarAPI = require('lunar-api');
const lunar = new LunarAPI(process.env.LUNARAPI); // Your API Key goes here

(async () => {
	const res = await lunar.sfw.hug();
	// const resid = await lunar.sfw.hug(true); 
    // Passing true returns the raw JSON response with the ID and URL
    
	console.log(res);
    /* If passing true to return the JSON response, simply do the following to get each key/value:
    console.log(res.id) or console.log(res.url)
    */
})();
```

# **Lunar API Docs:**
## https://docs.lunardev.group

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