# brasileirao-api

> A crawler that provider an open API to get brasileirao matches and scores

Latest version **1.0.0** (published 2017-08-23) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-08-23 |
| First published | 2017-08-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Leonan Luppi |
| Maintainers | leonanluppi |
| Keywords | brasileirao, campeonato brasileiro, brasileirao api |

## Links

- npm: https://www.npmjs.com/package/brasileirao-api
- Repository: https://github.com/leonanluppi/brasileirao-api
- Homepage: https://github.com/leonanluppi/brasileirao-api#readme
- Issues: https://github.com/leonanluppi/brasileirao-api/issues
- npm.io page: https://npm.io/package/brasileirao-api

## Dependencies (3)

- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.2
- [request](https://npm.io/package/request.md) ^2.81.0
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.1

## Recent versions

- 1.0.0 (latest) — 2017-08-23

## README

# Brasilerião API

Get ranking of brazilian futebool soccer championship by classification (A, B, C)

## How to install

Open terminal in your project folder, then:

```sh
$ npm install brasileirao-api
```

## How to use

In you project, just do:

- You can change serie to a, b, c

If you are using ES5
```sh
// ES5
const brasileirao = require('brasileirao-api')

// EXAMPLE
brasileirao('a').then(function(raking) {
	console.log(ranking)
})
```

If you are using ES6

```sh
// ES6
import brasileirao from 'brasileirao-api'

// EXAMPLE
brasileirao('a').then((raking) => {
	console.log(ranking)
})
```

If you have any doubts you can check example folder

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