{"_id":"@apilayer/ipapi","_rev":"1-b406558749b9ac6561160160a4485e03","name":"@apilayer/ipapi","dist-tags":{"latest":"0.1.6"},"versions":{"0.1.6":{"name":"@apilayer/ipapi","version":"0.1.6","author":{"name":"Samuel Oloruntoba","email":"github@kayandra.co","url":"https://kayandra.co"},"license":"MIT","dependencies":{"@types/node-fetch":"^2.5.0","is-ip":"^3.1.0","node-fetch":"^2.5.0"},"gitHead":"e0a9510ba4e021cc2692311d4869e451bef33799","publishConfig":{"access":"public"},"description":"Ipapi offers real-time Geolocation & reverse IP lookup.","_id":"@apilayer/ipapi@0.1.6","_nodeVersion":"10.16.3","_npmVersion":"lerna/3.16.4/node@v10.16.3+x64 (linux)","dist":{"integrity":"sha512-0u7/xbE/rgxVvfEXW1Muz+wxhOgax5Y58/MQKKeQ/prL6DCIU1y8tPe6sy3Xp9Rh/3cBpkxvWOkxH8rkOswoDg==","shasum":"3a989fe4035bee219823a2460c37d1e8f2411aa8","tarball":"https://registry.npmjs.org/@apilayer/ipapi/-/ipapi-0.1.6.tgz","fileCount":5,"unpackedSize":10860,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdkzKiCRA9TVsSAnZWagAA/voQAIfSjTLCS9dZ+X+4KcbD\nFNPNElIayz8l8b42fWEw9eGhwMm1yYCdnlGQpv+9kf/UB4jQHq8YPsGv47fw\n7knHs5DM0DL7wJ5DdzDou5WL7u2PS1bKeVtATF7VPedvFqRxaOdQr1zLxbSc\naZH2yJFZ+MYKhtVC3DuDk+3UsvHTClvsZiSySeOuztYn8zpPEVrYeaqZ5qaW\no3XzDBNnNBZdkNXRAsMZ/3JuRRsZUSFavKplnXZGtqvsd0jiXZQTY6jrD77G\np6IoRxT3/H9/+s53DcQcp0R2U0ANzn/WM0t8kFEATLHoHKoc2QsArv9FoUk5\nIe9AwfClW1fHk7lGjKK9aK7vR54S2rLD0IOC3veG2lVFQjaI2/Vce3GmaLAM\n46UTwMtENu74CKKewz+9KMQiAz3KWAy5bpBPyjzcX4Fdwr1cP6gIPpV+8ZPy\nlpz9L0pn/2Eq2kEB7ZMeB/0elhXGFh48vvQSeQ9iEaqegb4codeY0RtZ1uyD\nWn1m3QiTXiGn76zdhbJjumPP2H6LCTlRcojUOEJgYjMaVSoXgcLXOu2Eboyx\nSljVJznaRws7JkW4Ojur+ktulwdcL870iZwHvlyuWaz7cZkcvl8fL/oQxjK3\nz92BUF/0Ynt0HoPqllh74u7d9ayGculCUGreTm0GecZ8wJs/RIGzWrqEnODW\nEFsq\r\n=P1oW\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICD7+Sd06TrEoI6mYlOOv8S627+D8QDKZ3I8yCGIARFvAiB/GcEAkPn4yzLDMA6c6F6HD+/1vZAWhsUleZVcAWq5Bg=="}]},"maintainers":[{"name":"kayandra","email":"tag@kayandra.co"},{"name":"apilayer-p","email":"support@apilayer.com"}],"_npmUser":{"name":"kayandra","email":"tag@kayandra.co"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ipapi_0.1.6_1569927842090_0.8691771573615212"},"_hasShrinkwrap":false}},"time":{"created":"2019-10-01T11:04:01.809Z","0.1.6":"2019-10-01T11:04:02.259Z","modified":"2022-04-04T14:37:50.488Z"},"maintainers":[{"name":"kayandra","email":"tag@kayandra.co"},{"name":"apilayer-p","email":"support@apilayer.com"}],"description":"Ipapi offers real-time Geolocation & reverse IP lookup.","author":{"name":"Samuel Oloruntoba","email":"github@kayandra.co","url":"https://kayandra.co"},"license":"MIT","readme":"# ipapi-go\n\nIpapi offers real-time Geolocation & reverse IP lookup.\n\n## Installation\n\nUsing npm\n\n```\nnpm install --save @apilayer/ipapi\n```\n\nor yarn\n\n```\nyarn add @apilayer/ipapi\n```\n\n## Getting Started\n\nHead over to [ipapi](https://ipapi.com/) and\ncreate an account. Copy access key from dashboard.\n\n```javascript\nimport ipapi from '@apilayer/ipapi'\n\nconst useHTTPs = false\nconst layer = new ipapi(\"<your-access-key\", useHTTPs, {\n  language: \"en\",\n  hostname: true, // includes hostname information in response\n  security: true, // allows for return of security data\n})\n```\n\n> Checkout [supported languages](#supported-languages) and their codes.\n\n**Note:**\n> Each method below can accept options that overwrite the ones set above.\n\n## `lookup`\n\n`lookup` returns information based on IP address\n\n**Signature:**\n\n```typescript\nlookup(ip: string, option: Options = null)\n```\n\n**Example:**\n\n```javascript\nlayer.lookup(\"134.201.250.155\")\n```\n\n**Response:**\n\n```javascript\n{\n  ip: \"134.201.250.155\",\n  hostname: \"134.201.250.155\",\n  type: \"ipv4\",\n  continent_code: \"NA\",\n  continent_name: \"North America\",\n  country_code: \"US\",\n  country_name: \"United States\",\n  region_code: \"CA\",\n  region_name: \"California\",\n  city: \"Los Angeles\",\n  zip: \"90013\",\n  latitude: 34.0453,\n  longitude: -118.2413,\n  location: {\n    geoname_id: 5368361,\n    capital: \"Washington D.C.\",\n    languages: [\n      {\n        code: \"en\",\n        name: \"English\",\n        native: \"English\"\n      }\n    ],\n    country_flag: \"https://assets.ipstack.com/images/assets/flags_svg/us.svg\",\n    country_flag_emoji: \"🇺🇸\",\n    country_flag_emoji_unicode: \"U+1F1FA U+1F1F8\",\n    calling_code: \"1\",\n    is_eu: false\n  },\n  time_zone: {\n    id: \"America/LosAngeles\",\n    current_time: \"2018-03-29T07:35:08-07:00\",\n    gmt_offset: -25200,\n    code: \"PDT\",\n    is_daylight_saving: true\n  },\n  currency: {\n    code: \"USD\",\n    name: \"US Dollar\",\n    plural: \"US dollars\",\n    symbol: \"$\",\n    symbol_native: \"$\"\n  },\n  connection: {\n    asn: 25876,\n    isp: \"Los Angeles Department of Water & Power\"\n  },\n  security: {\n    is_proxy: false,\n    proxy_type: null,\n    is_crawler: false,\n    crawler_name: null,\n    crawler_type: null,\n    is_tor: false,\n    threat_level: \"low\",\n    threat_types: null\n  }\n}\n```\n\n## `bulkLookup`\n\n`bulkLookup` return information of multiple IP addresses\n\n**Signature:**\n\n```typescript\nbulkLookup(ips: string[], option: Options = null)\n```\n\n**Example:**\n\n```javascript\nlayer.bulkLookup([\"134.201.250.155\"])\n```\n\n**Response:**\n\n```javascript\n[{\n  ip: \"134.201.250.155\",\n  hostname: \"134.201.250.155\",\n  type: \"ipv4\",\n  continent_code: \"NA\",\n  continent_name: \"North America\",\n  country_code: \"US\",\n  country_name: \"United States\",\n  region_code: \"CA\",\n  region_name: \"California\",\n  city: \"Los Angeles\",\n  zip: \"90013\",\n  latitude: 34.0453,\n  longitude: -118.2413,\n  location: {\n    geoname_id: 5368361,\n    capital: \"Washington D.C.\",\n    languages: [\n      {\n        code: \"en\",\n        name: \"English\",\n        native: \"English\"\n      }\n    ],\n    country_flag: \"https://assets.ipstack.com/images/assets/flags_svg/us.svg\",\n    country_flag_emoji: \"🇺🇸\",\n    country_flag_emoji_unicode: \"U+1F1FA U+1F1F8\",\n    calling_code: \"1\",\n    is_eu: false\n  },\n  time_zone: {\n    id: \"America/LosAngeles\",\n    current_time: \"2018-03-29T07:35:08-07:00\",\n    gmt_offset: -25200,\n    code: \"PDT\",\n    is_daylight_saving: true\n  },\n  currency: {\n    code: \"USD\",\n    name: \"US Dollar\",\n    plural: \"US dollars\",\n    symbol: \"$\",\n    symbol_native: \"$\"\n  },\n  connection: {\n    asn: 25876,\n    isp: \"Los Angeles Department of Water & Power\"\n  },\n  security: {\n    is_proxy: false,\n    proxy_type: null,\n    is_crawler: false,\n    crawler_name: null,\n    crawler_type: null,\n    is_tor: false,\n    threat_level: \"low\",\n    threat_types: null\n  }\n}]\n```\n\n## `check`\n\n`check` autodetects the IP address and returns gathered information\n\n**Signature:**\n\n```typescript\ncheck(option: Options = null)\n```\n\n**Example:**\n\n```javascript\nlayer.check()\n```\n\n**Response:**\n\n```javascript\n{\n  ip: \"134.201.250.155\",\n  hostname: \"134.201.250.155\",\n  type: \"ipv4\",\n  continent_code: \"NA\",\n  continent_name: \"North America\",\n  country_code: \"US\",\n  country_name: \"United States\",\n  region_code: \"CA\",\n  region_name: \"California\",\n  city: \"Los Angeles\",\n  zip: \"90013\",\n  latitude: 34.0453,\n  longitude: -118.2413,\n  location: {\n    geoname_id: 5368361,\n    capital: \"Washington D.C.\",\n    languages: [\n      {\n        code: \"en\",\n        name: \"English\",\n        native: \"English\"\n      }\n    ],\n    country_flag: \"https://assets.ipstack.com/images/assets/flags_svg/us.svg\",\n    country_flag_emoji: \"🇺🇸\",\n    country_flag_emoji_unicode: \"U+1F1FA U+1F1F8\",\n    calling_code: \"1\",\n    is_eu: false\n  },\n  time_zone: {\n    id: \"America/LosAngeles\",\n    current_time: \"2018-03-29T07:35:08-07:00\",\n    gmt_offset: -25200,\n    code: \"PDT\",\n    is_daylight_saving: true\n  },\n  currency: {\n    code: \"USD\",\n    name: \"US Dollar\",\n    plural: \"US dollars\",\n    symbol: \"$\",\n    symbol_native: \"$\"\n  },\n  connection: {\n    asn: 25876,\n    isp: \"Los Angeles Department of Water & Power\"\n  },\n  security: {\n    is_proxy: false,\n    proxy_type: null,\n    is_crawler: false,\n    crawler_name: null,\n    crawler_type: null,\n    is_tor: false,\n    threat_level: \"low\",\n    threat_types: null\n  }\n}\n```\n\n## Supported Languages\n\n| Code    | Name                 |\n|:-------:|----------------------|\n| \"en\"    | \"English/US\"         |\n| \"de\"    | \"German\"             |\n| \"es\"    | \"Spanish\"            |\n| \"fr\"    | \"French\"             |\n| \"ja\"    | \"Japanese\"           |\n| \"pt-br\" | \"Portugues (Brazil)\" |\n| \"ru\"    | \"Russian\"            |\n| \"zh\"    | \"Chinese\"            |\n\n## License\n\n[MIT](/LICENSE)\n","readmeFilename":"README.md"}