{"id":15649557,"url":"https://github.com/a-tokyo/micro-geoip-lite-js","last_synced_at":"2025-04-30T16:27:59.575Z","repository":{"id":40709434,"uuid":"253926847","full_name":"a-tokyo/micro-geoip-lite-js","owner":"a-tokyo","description":"🌍 An extremely lite geoip decoder utilizing the micro-geoip-lite microservice to geo decode the IP info via an https request - the microservice utilizes MaxMind's IP info dataset.","archived":false,"fork":false,"pushed_at":"2025-02-10T03:35:58.000Z","size":318,"stargazers_count":9,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-19T22:12:02.798Z","etag":null,"topics":["country","decode","flow","flow-typed","free","geocoding","geoip","geoip-lite","geolocation","ip","lite-weight","maxmind","types","typescripe"],"latest_commit_sha":null,"homepage":"https://geoip-lite.now.sh","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/a-tokyo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["a-tokyo"],"buy_me_a_coffee":"ahmedtokyo"}},"created_at":"2020-04-07T22:31:24.000Z","updated_at":"2025-04-17T20:07:46.000Z","dependencies_parsed_at":"2025-02-25T02:04:18.883Z","dependency_job_id":"7263fc87-303b-4fe2-9dff-403d5e3e1494","html_url":"https://github.com/a-tokyo/micro-geoip-lite-js","commit_stats":{"total_commits":30,"total_committers":2,"mean_commits":15.0,"dds":0.4666666666666667,"last_synced_commit":"18d9751e9f80beb4ea2a680f98e183164a153965"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-tokyo%2Fmicro-geoip-lite-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-tokyo%2Fmicro-geoip-lite-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-tokyo%2Fmicro-geoip-lite-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-tokyo%2Fmicro-geoip-lite-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/a-tokyo","download_url":"https://codeload.github.com/a-tokyo/micro-geoip-lite-js/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251741697,"owners_count":21636305,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["country","decode","flow","flow-typed","free","geocoding","geoip","geoip-lite","geolocation","ip","lite-weight","maxmind","types","typescripe"],"created_at":"2024-10-03T12:30:14.783Z","updated_at":"2025-04-30T16:27:59.327Z","avatar_url":"https://github.com/a-tokyo.png","language":"JavaScript","funding_links":["https://github.com/sponsors/a-tokyo","https://buymeacoffee.com/ahmedtokyo"],"categories":[],"sub_categories":[],"readme":"# micro-geoip-lite\n\n🌍 An extremely lite geoip decoder utilizing the [micro-geoip-lite microservice](https://github.com/A-Tokyo/micro-geoip-lite) to geo decode the IP info via an https request - the microservice utilizes MaxMind's IP info dataset.\n\n\u003ca href=\"https://npmjs.com/package/micro-geoip-lite\"\u003e\n  \u003cimg src=\"https://img.shields.io/npm/v/micro-geoip-lite.svg\"\u003e\u003c/img\u003e\n  \u003cimg src=\"https://img.shields.io/npm/dt/micro-geoip-lite.svg\"\u003e\u003c/img\u003e\n\u003c/a\u003e\n\u003ca href=\"https://codecov.io/gh/A-Tokyo/micro-geoip-lite-js\"\u003e\n  \u003cimg src=\"https://img.shields.io/codecov/c/github/a-tokyo/micro-geoip-lite-js.svg\"\u003e\u003c/img\u003e\n\u003c/a\u003e\n\u003ca href=\"https://twitter.com/intent/follow?screen_name=ahmad_tokyo\"\u003e\u003cimg src=\"https://img.shields.io/twitter/follow/ahmad_tokyo.svg?label=Follow%20@ahmad_tokyo\" alt=\"Follow @ahmad_tokyo\"\u003e\u003c/img\u003e\u003c/a\u003e\n\n# Installation\n- Run `yarn add micro-geoip-lite`, `npm i micro-geoip-lite`\n\n# Usage\n- params:\n  - ip?: string - optional, defaults to client's IP\n  - options?: \n    ```js\n    {\n      serviceUrl?: string, // called instead of the default provider URL. You can also provide this via an env var `REACT_APP_SERVICE_URL_GEOIP` or `SERVICE_URL_GEOIP`\n      timeout?: string, // timeout in ms\n    }\n    ```\n- returns:\n  ```js\n  {\n    ip: string, // if ip param was not provided, this defaults to request.ip\n    range: [ number, number ],\n    country: string,\n    region: string,\n    eu: string, // '0' or '1'\n    timezone: string,\n    city: string,\n    ll: [ number, number ],\n    metro: number,\n    area: number,\n    // error: 'Error text', // only exists if an error happened\n  }\n  ```\n\n- example - fetch own ip info:\n  ```js\n  import geodecodeIp from 'micro-geoip-lite';\n  \n  const result = await geodecodeIp();\n\n  {\n    ip: '207.97.227.239', // if ip param was not provided, this defaults to request.ip\n    range: [ 3479298048, 3479300095 ],\n    country: 'US',\n    region: 'TX',\n    eu: '0',\n    timezone: 'America/Chicago',\n    city: 'San Antonio',\n    ll: [ 29.4969, -98.4032 ],\n    metro: 641,\n    area: 1000,\n    // error: 'Error text', // only exists if an error happened\n  }\n  ```\n\n- example - fetch specific ip info:\n  ```js\n  import geodecodeIp from 'micro-geoip-lite';\n  \n  const result = await geodecodeIp('207.97.227.239');\n  ```\n\n- [Live DEMO](https://geoip-lite.vercel.app/?ip=207.97.227.239)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-tokyo%2Fmicro-geoip-lite-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fa-tokyo%2Fmicro-geoip-lite-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-tokyo%2Fmicro-geoip-lite-js/lists"}