Socket
Socket
Sign inDemoInstall

lightbox_parcel_api_sdk

Package Overview
Dependencies
118
Maintainers
1
Versions
15
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    lightbox_parcel_api_sdk

LightBoxParcelsApi - JavaScript client for light_box_parcels_api ## Overview Access nationwide parcel boundaries with a large selection of property and tax attributes to help you make more confident decisions. Covers 3,100+ U.S. counties including territ


Version published
Weekly downloads
1
Maintainers
1
Created
Weekly downloads
 

Readme

Source

light_box_parcels_api

LightBoxParcelsApi - JavaScript client for light_box_parcels_api

Overview Access nationwide parcel boundaries with a large selection of property and tax attributes to help you make more confident decisions. Covers 3,100+ U.S. counties including territories, with over 150 million parcels with polygon geometry that is normalized across state and county boundaries.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.6.0
  • Package version: 1.6.0
  • Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install light_box_parcels_api --save
git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var LightBoxParcelsApi = require('light_box_parcels_api');
var defaultClient = LightBoxParcelsApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeaderAuth
var ApiKeyHeaderAuth = defaultClient.authentications['ApiKeyHeaderAuth'];
ApiKeyHeaderAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeaderAuth.apiKeyPrefix['x-api-key'] = "Token"

var api = new LightBoxParcelsApi.AddressApi()
var text = "text_example"; // {String} Address string for matching.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.parcelsAddressGet(text, callback);

Documentation for API Endpoints

All URIs are relative to https://api.lightboxre.com/v1

ClassMethodHTTP requestDescription
LightBoxParcelsApi.AddressApiparcelsAddressGetGET /parcels/addressQuery by address.
LightBoxParcelsApi.ByLightBoxIDApiparcelsCountryCodeIdGetGET /parcels/{countryCode}/{id}Query LightBox ID
LightBoxParcelsApi.ByLightBoxIDApiparcelsOnAddressUsIdGetGET /parcels/_on/address/us/{id}Query LightBox ID
LightBoxParcelsApi.ByLightBoxIDApiparcelsOnAssessmentUsIdGetGET /parcels/_on/assessment/us/{id}Query LightBox ID
LightBoxParcelsApi.ByLightBoxIDApiparcelsOnLocationinfoUsIdGetGET /parcels/_on/locationinfo/us/{id}Query LightBox ID
LightBoxParcelsApi.ByLightBoxIDApiparcelsOnSiteUsIdGetGET /parcels/_on/site/us/{id}Query LightBox ID
LightBoxParcelsApi.ByLightBoxIDApiparcelsOnStructureUsIdGetGET /parcels/_on/structure/us/{id}Query LightBox ID
LightBoxParcelsApi.GeneralApiparcelsAdjacentCountryCodeIdGetGET /parcels/_adjacent/{countryCode}/{id}Query adjacent parcels with common ownership
LightBoxParcelsApi.GeneralApiparcelsUsFipsFipsApnApnGetGET /parcels/us/fips/{fips}/apn/{apn}Query by fips and apn
LightBoxParcelsApi.HealthApiparcelsHealthGetGET /parcels/healthHealth check
LightBoxParcelsApi.MapDisplayApigetMapGET /parcels/{countryCode}/tileMap display
LightBoxParcelsApi.MapDisplayApigetTileGET /parcels/{countryCode}/tile/{zoom}/{x}/{y}Map display
LightBoxParcelsApi.SpatialApiparcelsCountryCodeGeometryGetGET /parcels/{countryCode}/geometryQuery by geometry string.
LightBoxParcelsApi.SpatialApiparcelsCountryCodeGeometryPostPOST /parcels/{countryCode}/geometryQuery by geometry string.
LightBoxParcelsApi.WMSApiwmsParcelsUsGetGET /wms/parcels/usOGC WMS Capability

Documentation for Models

Documentation for Authorization

ApiKeyHeaderAuth

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

FAQs

Last updated on 25 Jan 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc