# kred

> Kred API client for Node.js

Latest version **0.1.0** (published 2013-08-29) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2013-08-29 |
| First published | 2013-08-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.8 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Dirk Bonhomme |
| Maintainers | dirkbonhomme |
| Keywords | kred, api, social media, influence |

## Links

- npm: https://www.npmjs.com/package/kred
- Repository: https://github.com/dirkbonhomme/kred
- npm.io page: https://npm.io/package/kred

## Recent versions

- 0.1.0 (latest) — 2013-08-29

## README

# Kred API client for Node.js

This library allows you to easily access all API endpoints for Kred.
Refer to the [Kred API documentation](https://developer.peoplebrowsr.com/kred) for more details.

## Requirements

Request a free API key at https://developer.peoplebrowsr.com/signup

## Usage

Use your app id and app key to create a Kred instance

    var Kred = require('kred');
    var kred = new Kred(APP_ID, APP_KEY);
    
Default configuration can be overriden by providing a config object

    var kred = new Kred(APP_ID, APP_KEY, {
        protocol: 'http',
        host: 'api.kred.com',
        port: 80
    });
    
Call any of the available API methods `kredscore`, `kred`, `kredentials`, `dailyscore`, `dailypoints`, `activityStream`, `friendStream`, `kredinfluence`, `kredoutreach`, `kredretweetinfluence` with a parameters object and a callback function

    var parameters = {source: 'twitter', term: 'dirkbonhomme'};
    kred.kredscore(parameters, function(error, results){
        if(error){
            console.log('Something went wrong', error);
        }else{
            console.log('Results', results);
        }
    });
    
or call new/unsupported API endpoints

    kred.request('kredscore', parameters, callback);

## Developing

The library is published to NPM and can be installed with the following command:

    $ npm install kred

## Testing

Navigate to this module's repository and make sure you have the development modules installed:

    $ npm install


Run the tests:

    $ npm test

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