# @brawltracker/brawl-api

> Simple API wrapper for [Brawl API](https://brawlapi.com/).

Latest version **1.2.2** (published 2024-01-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @brawltracker/brawl-api
pnpm add @brawltracker/brawl-api
yarn add @brawltracker/brawl-api
bun add @brawltracker/brawl-api
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2024-01-25 |
| First published | 2023-11-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 16.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | death_blows |
| Keywords | brawlstars, brawl-stars, bs, api, supercell, brawl stars |

## Links

- npm: https://www.npmjs.com/package/@brawltracker/brawl-api
- Repository: https://github.com/technorav3nn/brawl-tracker
- Homepage: https://github.com/technorav3nn/brawl-tracker#readme
- Issues: https://github.com/technorav3nn/brawl-tracker/issues
- npm.io page: https://npm.io/package/@brawltracker/brawl-api

## Dependencies (1)

- [ofetch](https://npm.io/package/ofetch.md) ^1.3.3

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.2.2 (latest) — 2024-01-25
- 1.2.1 — 2023-12-29
- 1.2.0 — 2023-12-25
- 1.1.1 — 2023-11-21
- 1.1.0 — 2023-11-20
- 1.0.0 — 2023-11-19

## README

Simple API wrapper for [Brawl API](https://brawlapi.com/).

- No classes, very simple to use
- Written in TypeScript, with typings included
- Uses [ofetch](https://unjs.io/packages/ofetch) for requests
- Includes every API endpoint
- ESM and CJS support
- Unit tested

## Installation

```bash
yarn add @brawltracker/brawl-api
# or
pnpm add @brawltracker/brawl-api
# or
npm install @brawltracker/brawl-api
```

## Usage

```js
import { brawlApi } from "@brawltracker/brawl-api";

const shelly = await brawlApi.brawlers.getBrawler(16000000);
```

or

```js
import { brawlers } from "@brawltracker/brawl-api";

const shelly = await brawlers.getBrawler(16000000);
```

## Documentation

You can find the documentation [here](https://brawlapi.com).
Everything is exported from the `brawlApi` object, or you can import the specific endpoint you want to use

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