# node-erepublik

> A Node.js wrapper for the eRepublik API

Latest version **0.0.1** (published 2015-02-04) · 0 weekly downloads

## Install

```sh
npm install node-erepublik
pnpm add node-erepublik
yarn add node-erepublik
bun add node-erepublik
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2015-02-04 |
| First published | 2015-02-04 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Marcelo |
| Maintainers | marcelofs |

## Links

- npm: https://www.npmjs.com/package/node-erepublik
- Repository: https://bitbucket.org/marcelofs/node-erepublik
- Issues: https://bitbucket.org/marcelofs/node-erepublik/issues
- npm.io page: https://npm.io/package/node-erepublik

## Dependencies (1)

- [request](https://npm.io/package/request.md) 2.51.x

## Recent versions

- 0.0.1 (latest) — 2015-02-04

## README

# node-erepublik


A Node.js wrapper for the [eRepublik API](http://api.erepublik.com/)

## Usage

The easier way:

    var erepublik = require('node-erepublik');
    var erep = new erepublik.Adapter();
    var callback = function(error, response) { console.log(response) };
    
    erep.citizenProfile(citizenId, callback);
    erep.countryRegions(countryId, callback);
    erep.countriesIndex(callback);
    erep.regionCitizens(regionId, page, callback);
    erep.mapData(callback); 
    erep.industriesIndex(callback);
    erep.battleIndex(battleId, callback);
    erep.warBattles(warId, callback);
    
Some JSON response examples are on `/examples`.

You can also have some more control:

    var erepublik = require('node-erepublik');
    var connector = new erepublik.Connector(); 
    connector.fetch(resource, action, paramsObj, function(error, body){
        console.log(body); //full response object from the API
    });
    
## How to contribute

Send your pull request! Don't forget a proper test (we use `mocha`) and, if possible, an example of the API response.

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