{"_id":"@apilayer/ipstack","_rev":"1-d227dd2f5e776da842782e7e676fd769","name":"@apilayer/ipstack","dist-tags":{"latest":"0.1.6"},"versions":{"0.1.6":{"name":"@apilayer/ipstack","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":"ipstack offers one of the leading IP to geolocation APIs and global IP database services worldwide.","_id":"@apilayer/ipstack@0.1.6","_nodeVersion":"10.16.3","_npmVersion":"lerna/3.16.4/node@v10.16.3+x64 (linux)","dist":{"integrity":"sha512-q9WPghWLPIeTY4bGEgNrV9G5vLAh0jhU0az0jWoJOSzW7HnsGwbo/N4adQY1/WxesCPmQDJpPX4q2aCEUKoD4Q==","shasum":"6d7307b62a9e888bd51470629207c4d6c1578a9e","tarball":"https://registry.npmjs.org/@apilayer/ipstack/-/ipstack-0.1.6.tgz","fileCount":5,"unpackedSize":11523,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdkzKjCRA9TVsSAnZWagAA1bIQAIgME5D/IvQayBdfLKau\nXj+WJxvKbm77MUNik4QZpjCzwYpCqa8pllKvXNLDRV0WmZrKa0M7+vjPS2YD\nj0yAwb415kurMN39c82mv+7XCzti48SYeT0zS7rTHj631aDALVBrDl5Fk79m\naRMajvsnhZ110rwc5QGN5YbpGrZXFsunymzxglhZxycNu7xjNC0MEmYwzKmQ\n/j/B+Dyr/f7ahRBzJA9S4CqimZ4+mfwTJCIprHwqez3IZmk4rs9OngmtLa4f\n9dlIABx9sxvQzTlwxXJ8qJAj7V6PxWqkoiI/Z8HFO4sJOq8u7GKm4z2KErvp\n94NfORtPNFfPTbqsjfL/JF9MUYWeB/JEM4n0MKhLsDKfRRNbtTjwe7lewkUq\nKjGOaiuhLrgs7s4Wpgf6HNEukMc9rZlF9rdJUfqOKzBVtDLzkKH+/kQDkYze\niGhGlb8LpntC80Lsf1MUGzOyT2wdG6PMVppqHyKXHqGHzx9nwkTE2feQ1MH8\nwupyBs49qYLEGaDcUG4EGEBSLKXjB14FQOdXMrq4BQdGB0ZzrTId12OeG6Tf\nJ685eqCTJ8VoV/EiWi6+4oahpnBi/v+Mo+ZmHYbfEwmi71ZMAUUj5YZJJXos\nl0HSv/MpzdMn6TQnXVxfQb7ozklvgpC9CgFreBtkABBgNttN4Jd+mPPtPFgq\neD0o\r\n=OH/l\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDHts1pv6YxbFftQAo5csSHTPpAWshRpoXCJtlMB65jtAiEA8X+CKSUD7vhWJF15r01SJy04xbo9B0PNI7cTy1Vivb0="}]},"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/ipstack_0.1.6_1569927842464_0.5217155664073712"},"_hasShrinkwrap":false}},"time":{"created":"2019-10-01T11:04:02.156Z","0.1.6":"2019-10-01T11:04:02.595Z","modified":"2022-04-04T14:37:50.611Z"},"maintainers":[{"name":"kayandra","email":"tag@kayandra.co"},{"name":"apilayer-p","email":"support@apilayer.com"}],"description":"ipstack offers one of the leading IP to geolocation APIs and global IP database services worldwide.","author":{"name":"Samuel Oloruntoba","email":"github@kayandra.co","url":"https://kayandra.co"},"license":"MIT","readme":"# ipstack-go\n\nipstack offers one of the leading IP to geolocation APIs and global IP database services worldwide.\n\n## Installation\n\nUsing npm\n\n```\nnpm install --save @apilayer/ipstack\n```\n\nor yarn\n\n```\nyarn add @apilayer/ipstack\n```\n\n## Getting Started\n\nHead over to [Ipstack](https://ipstack.com/) and\ncreate an account. Copy access key from dashboard.\n\n```javascript\nimport Ipstack from '@apilayer/ipstack'\n\nconst useHTTPs = false\nconst layer = new Ipstack(\"<your-access-key\", useHTTPs)\n```\n\n## `setLanguage`\n\n`setLanguage` sets a global response language. Use the code of one of\nthe [supported languages](#supported-languages)\n\n**Signature:**\n\n```typescript\nsetLanguage(lang: Language)\n```\n\n**Example:**\n\n```javascript\nlayer.setLanguage(\"en\")\n```\n\n## `enableSecurity`\n\n`enableSecurity` allows for return of security data\n\n**Signature:**\n\n```typescript\nenableSecurity()\n```\n\n**Example:**\n\n```javascript\nlayer.enableSecurity()\n```\n\n## `enableHostname`\n\n`enableHostname` icludes hostname information in response\n\n**Signature:**\n\n```typescript\nenableHostname()\n```\n\n**Example:**\n\n```javascript\nlayer.enableHostname()\n```\n\n## `lookup`\n\n`lookup` returns information based on IP address\n\n**Signature:**\n\n```typescript\nlookup(ip: string)\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[])\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()\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`languages` return all supported response languages\n\n**Example:**\n\n```javascript\nlayer.languages()\n```\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"}