lightbox_parcel_api_sdk

v1.7.4

Published

10 months ago

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

Downloads

0High
0Medium
0Low

jirwin-lb

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- LightBoxParcelsApi.AddressApi | parcelsAddressGet | GET /parcels/address | Query by address. LightBoxParcelsApi.ByLightBoxIDApi | parcelsCountryCodeIdGet | GET /parcels/{countryCode}/{id} | Query LightBox ID LightBoxParcelsApi.ByLightBoxIDApi | parcelsOnAddressUsIdGet | GET /parcels/_on/address/us/{id} | Query LightBox ID LightBoxParcelsApi.ByLightBoxIDApi | parcelsOnAssessmentUsIdGet | GET /parcels/_on/assessment/us/{id} | Query LightBox ID LightBoxParcelsApi.ByLightBoxIDApi | parcelsOnLocationinfoUsIdGet | GET /parcels/_on/locationinfo/us/{id} | Query LightBox ID LightBoxParcelsApi.ByLightBoxIDApi | parcelsOnSiteUsIdGet | GET /parcels/_on/site/us/{id} | Query LightBox ID LightBoxParcelsApi.ByLightBoxIDApi | parcelsOnStructureUsIdGet | GET /parcels/_on/structure/us/{id} | Query LightBox ID LightBoxParcelsApi.GeneralApi | parcelsAdjacentCountryCodeIdGet | GET /parcels/_adjacent/{countryCode}/{id} | Query adjacent parcels with common ownership LightBoxParcelsApi.GeneralApi | parcelsUsFipsFipsApnApnGet | GET /parcels/us/fips/{fips}/apn/{apn} | Query by fips and apn LightBoxParcelsApi.HealthApi | parcelsHealthGet | GET /parcels/health | Health check LightBoxParcelsApi.MapDisplayApi | getMap | GET /parcels/{countryCode}/tile | Map display LightBoxParcelsApi.MapDisplayApi | getTile | GET /parcels/{countryCode}/tile/{zoom}/{x}/{y} | Map display LightBoxParcelsApi.SpatialApi | parcelsCountryCodeGeometryGet | GET /parcels/{countryCode}/geometry | Query by geometry string. LightBoxParcelsApi.SpatialApi | parcelsCountryCodeGeometryPost | POST /parcels/{countryCode}/geometry | Query by geometry string. LightBoxParcelsApi.WMSApi | wmsParcelsUsGet | GET /wms/parcels/us | OGC WMS Capability

Documentation for Models

Documentation for Authorization

ApiKeyHeaderAuth

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