{"_id":"@connect211/boundaries-io-sdk","_rev":"6-5a96e1f142352fa39fba76fe1d23ce07","name":"@connect211/boundaries-io-sdk","dist-tags":{"latest":"0.0.3"},"versions":{"0.0.1":{"name":"@connect211/boundaries-io-sdk","version":"0.0.1","description":"boundaries-io is an easy to use HTTP api that allows you to retrieve geography polygons in GeoJSON format. This package is not affiliated with boundaries.io and is an ongoing project to bring all endpoints from boundaries.io in to a simple sdk.","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"prepublish":"npm run build","build":"tsc"},"keywords":["boundaries","boundaries.io","api","geoJSON api","geo shape api","rapid api","rapidapi","geoshape"],"author":{"name":"Site Savvy"},"license":"MIT","homepage":"https://github.com/211-Connect/boundaries.io-sdk/blob/main/README.md","repository":{"url":"git+https://github.com/211-Connect/boundaries.io-sdk.git"},"devDependencies":{"@types/node-fetch":"^2.5.10","@typescript-eslint/eslint-plugin":"^4.25.0","@typescript-eslint/parser":"^4.25.0","eslint":"^7.27.0","eslint-config-prettier":"^8.3.0","prettier":"^2.3.0","typescript":"^4.3.2"},"dependencies":{"node-fetch":"^2.6.1","url":"^0.11.0"},"gitHead":"01a2d9e193020369f0017541f340a7b75dd48df6","bugs":{"url":"https://github.com/211-Connect/boundaries.io-sdk/issues"},"_id":"@connect211/boundaries-io-sdk@0.0.1","_nodeVersion":"14.17.4","_npmVersion":"6.14.14","dist":{"integrity":"sha512-XIg4yRPRjsXOvZL76tjvCpjdIqHwjOc7Keso2GU/LkfcbbYC9uGV+Rv/A7umsquS8XlQvH2R7CRcaUHGm+d1Xg==","shasum":"1e8fdb1c869b691e28c145aa4c8d3cd822020e00","tarball":"https://registry.npmjs.org/@connect211/boundaries-io-sdk/-/boundaries-io-sdk-0.0.1.tgz","fileCount":12,"unpackedSize":24716,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIG76KRKn7g1ROx0jGUNJD7J8iSrzrH4DBbDUyOinktV+AiAR/jjw+Cc66vqlFYG5AsDYf2AAsmZOexpK5hKjOb2Gpw=="}]},"_npmUser":{"name":"nightlight","email":"devcshort@protonmail.com"},"directories":{},"maintainers":[{"name":"cskyleryoung","email":"sky@sitesavvy.com"},{"name":"nightlight","email":"devcshort@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/boundaries-io-sdk_0.0.1_1636048242028_0.6366090740004207"},"_hasShrinkwrap":false},"0.0.2":{"name":"@connect211/boundaries-io-sdk","version":"0.0.2","description":"boundaries-io is an easy to use HTTP api that allows you to retrieve geography polygons in GeoJSON format. This package is not affiliated with boundaries.io and is an ongoing project to bring all endpoints from boundaries.io in to a simple sdk.","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"prepublish":"npm run build","build":"tsc"},"keywords":["boundaries","boundaries.io","api","geoJSON api","geo shape api","rapid api","rapidapi","geoshape"],"author":{"name":"Site Savvy"},"license":"MIT","homepage":"https://github.com/211-Connect/boundaries.io-sdk/blob/main/README.md","repository":{"url":"git+https://github.com/211-Connect/boundaries.io-sdk.git"},"devDependencies":{"@types/node-fetch":"^2.5.10","@typescript-eslint/eslint-plugin":"^4.25.0","@typescript-eslint/parser":"^4.25.0","eslint":"^7.27.0","eslint-config-prettier":"^8.3.0","prettier":"^2.3.0","typescript":"^4.3.2"},"dependencies":{"node-fetch":"^2.6.1","url":"^0.11.0"},"gitHead":"01a2d9e193020369f0017541f340a7b75dd48df6","bugs":{"url":"https://github.com/211-Connect/boundaries.io-sdk/issues"},"_id":"@connect211/boundaries-io-sdk@0.0.2","_nodeVersion":"14.17.4","_npmVersion":"6.14.14","dist":{"integrity":"sha512-SWbQV15ubbEE0CKcRzzOU3ny1HMM7Esiddp4fEWs+e3tt/IKFibdKJzGrBTF5R2ZKNSPt+Qrg2DGWYaWFN31ZQ==","shasum":"3b94064ccbacb9daef3269a40f392bb99d29fa7a","tarball":"https://registry.npmjs.org/@connect211/boundaries-io-sdk/-/boundaries-io-sdk-0.0.2.tgz","fileCount":12,"unpackedSize":24716,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC9ha1DtNiSsyZeZrDNq/wv+l3o6xAp8JktJmU0VxH8dgIhAOrfOt07+UH9EMvLc2jK3NjhT23bLIHjDS+Y3n6KpgGh"}]},"_npmUser":{"name":"nightlight","email":"devcshort@protonmail.com"},"directories":{},"maintainers":[{"name":"cskyleryoung","email":"sky@sitesavvy.com"},{"name":"nightlight","email":"devcshort@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/boundaries-io-sdk_0.0.2_1636048325007_0.681633919042389"},"_hasShrinkwrap":false},"0.0.3":{"name":"@connect211/boundaries-io-sdk","version":"0.0.3","description":"boundaries-io is an easy to use HTTP api that allows you to retrieve geography polygons in GeoJSON format. This package is not affiliated with boundaries.io and is an ongoing project to bring all endpoints from boundaries.io in to a simple sdk.","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"prepublish":"npm run build","build":"tsc"},"keywords":["boundaries","boundaries.io","api","geoJSON api","geo shape api","rapid api","rapidapi","geoshape"],"author":{"name":"Site Savvy"},"license":"MIT","homepage":"https://github.com/211-Connect/boundaries.io-sdk/blob/main/README.md","repository":{"url":"git+https://github.com/211-Connect/boundaries.io-sdk.git"},"devDependencies":{"@types/node-fetch":"^2.5.10","@typescript-eslint/eslint-plugin":"^4.25.0","@typescript-eslint/parser":"^4.25.0","eslint":"^7.27.0","eslint-config-prettier":"^8.3.0","prettier":"^2.3.0","typescript":"^4.3.2"},"dependencies":{"node-fetch":"^2.6.1","url":"^0.11.0"},"gitHead":"333149c470171b7672858f3a4c6f809540e90999","bugs":{"url":"https://github.com/211-Connect/boundaries.io-sdk/issues"},"_id":"@connect211/boundaries-io-sdk@0.0.3","_nodeVersion":"14.17.4","_npmVersion":"6.14.14","dist":{"integrity":"sha512-8/zra+tXTk3qcese6zPpJmc4tWy8uqypw01Bg2oKw6oJDYdZxCBMSosX7nouMEnNag2JWkm9+7LsI4xxr0mcbA==","shasum":"b26f1e551a1b25ed62777d6b970e01bb99515d4b","tarball":"https://registry.npmjs.org/@connect211/boundaries-io-sdk/-/boundaries-io-sdk-0.0.3.tgz","fileCount":12,"unpackedSize":25414,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhxPkkCRA9TVsSAnZWagAA67YP/2yEKzqxlw0V9lh/mVKv\nPJcvL/awwgtQTeYxbfUkrURHBMav5BJCUYXgzpB5AIZW6oOiW9oxn4IdchCq\n9uBMAzdYcTCS/Z5jh6g/Ov/jG7SHHUHsIN8Ydh36T2ZLY0H/zH6DinYxd3Vo\nyBp70t4S6SaXRxZR/fxHqpB+RQSSTiRDp3/faZQorAKiZ36+n/h63TRjwtIr\nblDjYpqFKDgzMN0rlS4kz52mbzVbkeStUHBIQzgr+Hz0PwfO1KvJbrRdaBPQ\nln7DMXHOri/zpsaLaA5GRw4E10NBzgDdsQPs+CioPilcD0WMMCoxl3yk9l6S\nu52p4lTBcqW/mb23jnek3GYRiPUKNf6PXs0f+U8lb7ySUtxkvCh7fsYHjPCl\nOMKEw35hQIJ3hb+wih23zY0fJav/Ae5A0AE7Jz9nhSPUmRarHGW4hQYK8yjB\n1MR4KSodj+Sq5OUJ21Qr0xJPSnyRQTQG0gXo1zp/+MfnEQT2sF7Cd/MASpSw\nY8iA+UGFkGczod1P3UB9ygSp/KKs4BA61gJSwMyQvYF4hi6F6k3WP7WICohL\nyVQqy7WtNpzR2OfaffGdRYaVIO94Wj6wo0HUTD5M9r/OGRDDiOLFx5cQLVCq\ngxBFiEQ4NMGPTSOnJT2+TQEwUSL6JCxiUvLUDk+cvy5FUYKDxcLvb8R2ldRQ\ngIqq\r\n=Ixua\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCAReTYiSGxr8y3QpVtoSyqhu0BpMRyWyN1uOCmUgndoQIhALepMAekpWhrmE957bn61GtD0cc5V49o1GosoJPLCfNt"}]},"_npmUser":{"name":"nightlight","email":"devcshort@protonmail.com"},"directories":{},"maintainers":[{"name":"cskyleryoung","email":"sky@sitesavvy.com"},{"name":"nightlight","email":"devcshort@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/boundaries-io-sdk_0.0.3_1640298788519_0.036276373088713676"},"_hasShrinkwrap":false}},"time":{"created":"2021-11-04T17:50:42.028Z","0.0.1":"2021-11-04T17:50:42.189Z","modified":"2023-01-05T22:57:54.315Z","0.0.2":"2021-11-04T17:52:05.170Z","0.0.3":"2021-12-23T22:33:08.644Z"},"maintainers":[{"email":"tim@sitesavvy.com","name":"timothyhinh79"},{"email":"brandon.david.spicer@gmail.com","name":"brandon-spicer"},{"email":"sky@sitesavvy.com","name":"cskyleryoung"},{"email":"devcshort@protonmail.com","name":"nightlight"}],"description":"boundaries-io is an easy to use HTTP api that allows you to retrieve geography polygons in GeoJSON format. This package is not affiliated with boundaries.io and is an ongoing project to bring all endpoints from boundaries.io in to a simple sdk.","homepage":"https://github.com/211-Connect/boundaries.io-sdk/blob/main/README.md","keywords":["boundaries","boundaries.io","api","geoJSON api","geo shape api","rapid api","rapidapi","geoshape"],"repository":{"url":"git+https://github.com/211-Connect/boundaries.io-sdk.git"},"author":{"name":"Site Savvy"},"bugs":{"url":"https://github.com/211-Connect/boundaries.io-sdk/issues"},"license":"MIT","readme":"# Boundaries.io SDK\n\nboundaries-io is an easy to use HTTP api that allows you to retrieve geography polygons in GeoJSON format. This package is not affiliated with boundaries-io and is an ongoing project to bring all endpoints from boundaries-io in to a simple sdk.\n\n[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)\n\n## Installation\n\nInstall Boundaries.io SDK with npm\n\n```bash\n  npm install --save @211-connect/boundaries.io-sdk\n```\n\n## Prerequisites\n\n- You must have an API key from [Rapid API](https://rapidapi.com/VanitySoft/api/boundaries-io-1)\n\n## Usage/Examples\n\n```javascript\nvar Client = require('@211-connect/boundaries.io-sdk');\n\nvar boundaries = new Client({ apiKey: 'YOUR-BOUNDARIES.IO-API-KEY' });\n\nasync function getZipCodes() {\n  // Pass in an array of zip codes\n  await boundaries.queryByZipCodes(['98908', '98903', '98902'], {\n    combine: true,\n  });\n\n  // Alternatively you can pass in a comma delimited list of zip codes\n  await boundaries.queryByZipCodes('98908,98903,98902', { combine: true });\n}\n```\n\n## API Reference\n\n#### Client\n\nClient constructor takes an object with the following properties\n| Property | Type | Description |\n| :-------- | :------- | :------------------------- |\n| `apiKey` | `string` | **Required**. API key from [Rapid API](https://rapidapi.com/VanitySoft/api/boundaries-io-1) |\n| `apiHost`| `string` | **Optional**. This can be ignored in most cases, however it is exposed in case the RapidAPI host changes prior to us being able to update this package |\n| `baseUrl`| `string` | **Optional**. This can be ignored in most cases, however it is exposed in case the RapidAPI base url changes prior to us being able to update this package\n\n#### queryByZipCodes(zipCodes, options)\n\n| Parameter  | Type                | Description                                                                 |\n| :--------- | :------------------ | :-------------------------------------------------------------------------- |\n| `zipCodes` | `string` or `array` | **Required**. A comma delimited list of zip codes, or an array of zip codes |\n| `options`  | `object`            | **Optional**. See table below                                               |\n\n| Property      | Type      | Description   |\n| :------------ | :-------- | :------------ |\n| `city`        | `string`  | **Optional**. |\n| `state`       | `string`  | **Optional**. |\n| `county`      | `string`  | **Optional**. |\n| `showCenter`  | `boolean` | **Optional**. |\n| `combine`     | `boolean` | **Optional**. |\n| `showDetails` | `boolean` | **Optional**. |\n| `and`         | `boolean` | **Optional**. |\n\n#### queryCountyByLatLon(lat, lon)\n\n| Parameter | Type     | Description             |\n| :-------- | :------- | :---------------------- |\n| `lat`     | `number` | **Required**. Latitude  |\n| `lon`     | `number` | **Required**. Longitude |\n\n#### queryCountyByName(countyName, stateAbbrv)\n\n| Parameter    | Type     | Description                      |\n| :----------- | :------- | :------------------------------- |\n| `countyName` | `string` | **Required**. County name        |\n| `stateAbbrv` | `string` | **Required**. State abbreviation |\n\n#### queryPlaceByName(placeName, stateAbbrv)\n\n| Parameter    | Type     | Description                      |\n| :----------- | :------- | :------------------------------- |\n| `placeName`  | `string` | **Required**. Place name         |\n| `stateAbbrv` | `string` | **Required**. State abbreviation |\n\n#### queryPlaceByLatLon(lat, lon)\n\n| Parameter | Type     | Description             |\n| :-------- | :------- | :---------------------- |\n| `lat`     | `number` | **Required**. Latitude  |\n| `lon`     | `number` | **Required**. Longitude |\n\n## Feedback\n\nIf you have any feedback, please open an issue on our [repo](https://github.com/211-Connect/boundaries.io-sdk/issues).\n\n## Authors\n\n- [@devcshort](https://github.com/devcshort)\n- [@cskyleryoung](https://github.com/cskyleryoung)\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n","readmeFilename":"README.md"}