# luxorpool

> Unofficial Luxor Mining Pool API Wrapper

Latest version **1.0.4** (published 2023-04-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install luxorpool
pnpm add luxorpool
yarn add luxorpool
bun add luxorpool
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2023-04-20 |
| First published | 2023-04-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 86.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Scott Pickering |
| Maintainers | scottpickering |
| Keywords | luxor, bitcoin, mining, pool |

## Links

- npm: https://www.npmjs.com/package/luxorpool
- Repository: https://github.com/scottypickering/luxorpool
- Issues: https://github.com/scottypickering/luxorpool/issues
- npm.io page: https://npm.io/package/luxorpool

## Dependencies (3)

- [big.js](https://npm.io/package/big.js.md) ^6.2.1
- [graphql](https://npm.io/package/graphql.md) ^16.6.0
- [graphql-request](https://npm.io/package/graphql-request.md) ^6.0.0

## Recent versions

- 1.0.4 (latest) — 2023-04-20
- 1.0.3 — 2023-04-20
- 1.0.2 — 2023-04-20
- 1.0.1 — 2023-04-19
- 1.0.0 — 2023-04-19

## README

# Unofficial Luxor Pool JavaScript API Client

[![Version](https://img.shields.io/npm/v/luxorpool.svg)](https://www.npmjs.org/package/luxorpool)
[![Try on RunKit](https://badge.runkitcdn.com/luxorpool.svg)](https://runkit.com/npm/luxorpool)

This unofficial Luxor Mining Pool client provides convenient access to the Luxor API from
client-side and server-side JavaScript applications.

## Installation
```sh
npm install luxorpool
# or
yarn add luxorpool
```

## Usage
The package needs to be configured with an API key from your Luxor account:
1. Log in to [Luxor](https://app.luxor.tech/en/login).
1. Go to *Settings* > *API Keys* > *Generate new Key*.

```js
import { Luxor } from 'luxorpool'

const luxor = new Luxor({
  key: 'YOUR_API_KEY',
  coin: 'BTC',
  units: 'TH'
})

async function example() {
  const subaccounts = await luxor.getSubaccounts()
  const hashrate = await luxor.getPoolHashrate()
  const transactions = await luxor.getTransactionHistory('YOUR_SUBACOUNT')
  // etc.
}
```

## Documentation
This library is a pretty lightweight wrapper around the Luxor Pool API, so [Luxor's API documentation](https://docs.luxor.tech/docs/schema/getting-started) is probably helpful.
It also includes type definitions, so it should be convenient for TypeScript folks.

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