# @freeatnet/iplocation

> Get ip location information.

Latest version **7.3.0-alpha.1** (published 2021-03-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @freeatnet/iplocation
pnpm add @freeatnet/iplocation
yarn add @freeatnet/iplocation
bun add @freeatnet/iplocation
```

## 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 | 7.3.0-alpha.1 |
| Published | 2021-03-05 |
| First published | 2021-03-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 3 |
| Unpacked size | 8.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 76 |
| Author | Richie Bendall |
| Maintainers | freeatnet |
| Keywords | ip, location, coordinates, locate, find, address, ip-location, geolocation |

## Links

- npm: https://www.npmjs.com/package/@freeatnet/iplocation
- Repository: https://github.com/Richienb/iplocation
- npm.io page: https://npm.io/package/@freeatnet/iplocation

## Dependencies (3)

- [ky](https://npm.io/package/ky.md) ^0.19.1
- [is-ip](https://npm.io/package/is-ip.md) ^3.1.0
- [ky-universal](https://npm.io/package/ky-universal.md) ^0.6.0

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 7.3.0-alpha.1 (latest) — 2021-03-05
- 7.3.0-alpha.0 — 2021-03-04

## README

# iplocation [![Travis CI Build Status](https://img.shields.io/travis/com/Richienb/iplocation/master.svg?style=for-the-badge)](https://travis-ci.com/Richienb/iplocation)

Get ip location information.

[![NPM Badge](https://nodei.co/npm/iplocation.png)](https://npmjs.com/package/iplocation)

## Install

```sh
npm install iplocation
```

## Usage

```js
const ipLocation = require("iplocation");

(async () => {
	await ipLocation("172.217.167.78");
	//=> { latitude: -33.8591, longitude: 151.2002, region: { name: "New South Wales" ... } ... }
})();
```

## API

### ipLocation(ip)

#### ip

Type: `string`

The ipv4 address to get the information for.

## Providers

iplocation currently uses [ipapi](https://ipapi.co/) for IP lookups. Their free API is limited to 1000 requests per day.

## Related

- [iplocation-cli](https://github.com/Richienb/iplocation-cli) - CLI for this module.

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