https://github.com/a-tokyo/micro-geoip-lite

🌍 Small microservice that geo looks up an IP - Easy to clone and deploy - 🦾 Automatically up to date.
https://github.com/a-tokyo/micro-geoip-lite

automatic-updates bot-maintained clonable country decode easy-deploy fast free geo geocoder geoip geoip-lite geolocation ip micro microservice no-key request-country timezone

Last synced: 2 months ago
JSON representation

🌍 Small microservice that geo looks up an IP - Easy to clone and deploy - 🦾 Automatically up to date.

• Host: GitHub
• URL: https://github.com/a-tokyo/micro-geoip-lite
• Owner: a-tokyo
• License: mit
• Created: 2020-04-02T18:36:27.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-09T21:39:37.000Z (9 months ago)
• Last Synced: 2024-04-10T01:00:49.005Z (9 months ago)
• Topics: automatic-updates, bot-maintained, clonable, country, decode, easy-deploy, fast, free, geo, geocoder, geoip, geoip-lite, geolocation, ip, micro, microservice, no-key, request-country, timezone
• Language: JavaScript
• Homepage: https://geoip-lite.now.sh
• Size: 379 KB
• Stars: 16
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# micro-geoip-lite

> 🌍 Small microservice that geo looks up an IP for free using geoip-lite database.

[![Test Release Publish](https://github.com/A-Tokyo/micro-geoip-lite/actions/workflows/test.yml/badge.svg)](https://github.com/A-Tokyo/micro-geoip-lite/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/A-Tokyo/micro-geoip-lite/branch/main/graph/badge.svg)](https://codecov.io/gh/A-Tokyo/micro-geoip-lite)

## Usage

- [https://geoip-lite.now.sh/?ip=207.97.227.239](https://geoip-lite.now.sh/?ip=207.97.227.239)

```js

{

  ip: '207.97.227.239', // if ip param was not provided, this defaults to request.ip

  range: [ 3479298048, 3479300095 ],

  country: 'US',

  region: 'TX',

  eu: '0',

  timezone: 'America/Chicago',

  city: 'San Antonio',

  ll: [ 29.4969, -98.4032 ],

  metro: 641,

  area: 1000,

  error: 'Error text', // only exists if an error happened

}

```

### Query Params

- ip?: string // IP to lookup, defaults to request.ip

- timeout?: : number // timeout before failing, defaults to 5 seconds -- maximum of 10 seconds and minimum of 1/2 seconds

### Usage with JS

- A library is available for javascript out of the box on npm [micro-geoip-lite-js](https://github.com/A-Tokyo/micro-geoip-lite-js).

---

## Automation Note

- This repo is auto maintained by bots. For example: dependabot opens weekly PRs to upgrade dependencies that are auto merged if the tests pass.

- This will keep the repo up to date with minimal human interaction.

Hosted on [now](https://zeit.co/now)