# retrieve-ip

> Get IP address of a HTTP request object

Latest version **1.1.1** (published 2017-01-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install retrieve-ip
pnpm add retrieve-ip
yarn add retrieve-ip
bun add retrieve-ip
```

## 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.1.1 |
| Published | 2017-01-24 |
| First published | 2016-11-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | rajikaimal |
| Maintainers | rajikaimal |

## Links

- npm: https://www.npmjs.com/package/retrieve-ip
- Repository: https://github.com/rajikaimal/retrieve-ip
- Homepage: https://github.com/rajikaimal/retrieve-ip#readme
- Issues: https://github.com/rajikaimal/retrieve-ip/issues
- npm.io page: https://npm.io/package/retrieve-ip

## Recent versions

- 1.1.1 (latest) — 2017-01-24
- 1.0.1 — 2016-11-30
- 1.0.0 — 2016-11-26

## README

# retrieve-ip [![Build Status](https://travis-ci.org/rajikaimal/retrieve-ip.svg?branch=master)](https://travis-ci.org/rajikaimal/retrieve-ip)

Get IP address of a HTTP request object

## Install

```
npm install --save retrieve-ip
```

## Usage

```js
const app = require('express')();
const retrieveIp = require('retrieve-ip');

app.get('/', function(req, res) {
  const ip = retrieveIp(req);
});
```

## API

### retrieveIp(requestObject)

Return IP address of request

#### requestObject

Type: `object`

Request object

## License

MIT © [Rajika Imal](https://rajikaimal.github.io)

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