Skip to content

PreciselyData/PreciselyAPIsSDK-Java

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits

Documentation

Documentation

 
 

docs

docs

 
 

gradle/wrapper

gradle/wrapper

 
 

src

src

 
 

.gitignore

.gitignore

 
 

.openapi-generator-ignore

.openapi-generator-ignore

 
 

.travis.yml

.travis.yml

 
 

LICENSE

LICENSE

 
 

README.md

README.md

 
 

build.gradle

build.gradle

 
 

build.sbt

build.sbt

 
 

dependency-reduced-pom.xml

dependency-reduced-pom.xml

 
 

git_push.sh

git_push.sh

 
 

gradle.properties

gradle.properties

 
 

gradlew

gradlew

 
 

gradlew.bat

gradlew.bat

 
 

pom.xml

pom.xml

 
 

precisely_logo_purple.jpg

precisely_logo_purple.jpg

 
 

settings.gradle

settings.gradle

 
 

Repository files navigation

Precisely

Precisely APIs

Description

Precisely APIs Enrich your data, and enhance your applications, business processes and workflows with dozens of powerful location & identity APIs.

Precisely APIs:

  • Geocode: Accurate Geocoding. Convert individual or batch collections of addresses to latitude & longitude coordinates and vice versa. Useful for enhancing & enriching your customer addresses.

  • Address Autocomplete: Address Autocomplete. Build Address Autocomplete into your websites. The Address Autocomplete API returns an autocompleted list of addresses based on the input of a partial address. Useful for any local search, checkout, shipping, or billing experiences on your website. Increase e-commerce conversion by 3-6%!

  • Address Autocomplete Enterprise :Build Address Autocomplete Enterprise into your websites. The Address Autocomplete Enterprise API returns an autocompleted list of addresses based on the input of a partial address. It is useful for any local search, checkout, shipping, or billing experiences on your website.

  • Maps: Beautiful Visualization. Add your data and/or Precisely data atop beautiful maps for visualizations. Choose from three map styles - Bronze, Iron, and Steel.

  • Zones: Smart Zones. The Zones API returns geographic zones by Radius, Drive Distance, Drive Time and highly localized geofence zones with the input of Location Coordinates or Addresses. Useful for anyone wanting to create smarter geofence zones for Local Engagement and Analysis.

  • Routing: Accurate Routing. The Routing API returns Point-to-Point and Multi-Point Travel Directions by Various Travel Modes. Critical for any Simple or Complex Routing Requirement.

  • Streets: Global Street Information. Enrich your applications, business processes, and workflows with global street information including nearest intersections and speed limits. The Streets API accepts an address or location and returns nearest intersection information. The speed limit method accepts a series of locations and returns speed limits along a street segment.

  • Places : Global Place Data. Enrich your applications, business processes, and workflows with over 180 million of global retail businesses and landmark points-of-interest. The Places API accepts multiple powerful inputs & filtering options and returns thousands of records in a single API request. The Places API also supports global typeahead place search. Useful for enriching your data and/or analytics processes with rich commercial business information and place names.

  • Risks: Risks Insights. Capture Crime, Earthquake, Flood, Fire, Fire Station and Distance-to-Flood-Hazard risk data for Analysis, Planning, Claims, and Mitigation. The Risks API returns risk intelligence with the input of Location Coordinates or Addresses. Critical for any impact analysis involving threats to lives or property.

  • 911/PSAP: Emergency call handling. Integrate Public Safety Answering Point (PSAP) administrative call routing information plus Authority Having Jurisdiction (AHJ) phone numbers into your emergency services products and services. The 911/PSAP API retrieves 10-digit phone numbers and local contact info with the input of a location coordinate. Useful for emergency services administrators, call handlers, and dispatchers.

  • Demographics : Audience Enrichment. Add local demographics and lifestyle segmentation to your people profiles. The Demographics & Lifestyle API returns household demographics and lifestyle characteristics with the input of an address or location coordinate. Know more about your customers and their customers.

  • Local Tax: Local Tax. Add hyperlocal tax rates to your applications, business processes, and workflows. The Local Tax API returns local tax rates with the input of location coordinates or addresses. Critical for any billing, commerce, payment, or payroll application or service.

  • Telecomm Info: Service Provider Intelligence. Identify Local Exchange Carrier presence, area codes, exchanges, and more within a Rate Center area. The Telecomm Info API retrieves Incumbent Local Exchange Carrier (ILEC) doing-business-as names along with NPA/NXX, LATA, and phone number ranges with the input of an address or location coordinates. Useful for local telecommunications competitive intelligence, partnerships, and provisioning subscribers.

  • Time Zone: Local time. The Time Zone API returns time zones and UTC offsets with the input of a location coordinate or address. Useful for do-not-call, logistics, and customer engagement applications, business processes and workflows.

  • Geolocation: Device Location. The Geolocation API returns location coordinates based on the input of an IP Address or Wi-Fi Access point MAC address. Useful for a variety of applications, business processes and workflows in eCommerce, Fraud Detection, Physical-Digital interactions, Field Service and more.

  • Schools: School Listings. Gather local multiple school listings, types, districts and education levels for your applications. The Schools API accepts multiple powerful inputs & geographic filtering options and returns nearby school listings and additional data a single API request. Useful for enriching your applications and websites.

  • Neighborhoods: Neighborhood Insights. Integrate global neighborhood names and classification information into your applications and enrich other data. The Neighborhood API accepts latitude & longitude coordinates and returns the corresponding neighborhood name & type. Useful for a wide range of data enrichment use cases.

  • Property Information: Property Insights. Integrate extensive residential & commercial property information into your applications. The Property Information API returns key property attributes for millions of US properties with the input of Location Coordinates or Addresses. Useful for Real Estate use cases or those involving risk assessments.

  • Address Verification: Real, accurate and complete address. Eliminate errors in address data, improve customer experience. The Address Verification API makes communication easier, faster and effortless by enriching customer details, keeping it up-to-date and maintaining its accuracy and consistency. It eliminates redundancy in reaching out to customers and makes it easy for distinct functional areas to work seamlessly in improving customer relationship.

  • Email Verification: Email address validation and protection. The Email Verification API corrects and validates your email addresses to protect your database from invalid, toxic and undesirable email addresses. We help you avoid a damaged sender reputations by flagging those bouncing emails, spam trap hits, honeypots, stale lists and do-not-contact list before you have a chance to use them.

  • Addresses: Gather multiple Addresses if you don’t have them and use these to query all other Precisely APIs. The Addresses API accepts names of a boundary such as zip code, neighborhood, county, and city—as well as your custom geographic boundaries or drivetimes & drive distances—and returns all known & valid Addresses associated with these names, or Addresses contained with the supplied or chosen geographic boundary.

  • Phone Verification: The Phone Verification API accepts any phone number as input and returns verification information, Service Provider name, and more. Useful to verify if phone numbers exist to reduce fraud and improve communications.

The following platforms are supported by Precisely SDKs:

Click here for detailed Documentation on Precisely APIs

PreciselyAPISJavaSDK

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users (Java SDK Maven Repo Reference)

Add this dependency to your project's POM:

<dependency>
    <groupId>com.precisely.apis</groupId>
    <artifactId>PreciselyAPISJavaSDK</artifactId>
    <version>18.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

 implementation "com.precisely.apis:PreciselyAPISJavaSDK:18.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/PreciselyAPISJavaSDK-18.0.0.jar
  • target/lib/*.jar

Getting Started

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

import com.precisely.ApiException;
import com.precisely.apis.model.AddressesResponse;
import com.precisely.apis.AddressesServiceApi;

public class AddressesServiceApiExample {
    public static void main(String[] args) {
        AddressesServiceApi api = new AddressesServiceApi();
        try {
            api.getApiClient().generateAndSetAccessToken("PUT_YOUR_KEY_HERE","PUT_YOUR_SECRET_HERE");

            String country = "USA";
            String areaName1 = null;
            String areaName2 = null;
            String areaName3 = null;
            String areaName4 = null;
            String postCode = "90001";
            String maxCandidates = "3";
            String page = "1";

            AddressesResponse response = api.getAddressesbyBoundaryName(country, areaName1, areaName2, areaName3, areaName4, postCode, maxCandidates, page);
			System.out.println(response);

        } catch (ApiException e) {
            e.printStackTrace();
        }

    }
}

Documentation for API Endpoints

All URIs are relative to https://api.precisely.com

Class Method HTTP request Description
AddressAutocompleteEnterpriseServiceApi listLocations GET /typeahead/v1/list/locations
AddressAutocompleteEnterpriseServiceApi listSelect GET /typeahead/v1/list/select
AddressAutocompleteServiceApi searchV2 GET /typeahead/v1/locations Address Autocomplete Search
AddressVerificationServiceApi getCityStateProvince POST /addressverification/v1/getcitystateprovince/results.json GetCityStateProvince
AddressVerificationServiceApi getPostalCodes POST /addressverification/v1/getpostalcodes/results.json GetPostalCodes
AddressVerificationServiceApi validateMailingAddress POST /addressverification/v1/validatemailingaddress/results.json ValidateMailingAddress
AddressVerificationServiceApi validateMailingAddressPremium POST /addressverification/v1/validatemailingaddresspremium/results.json ValidateMailingAddressPremium
AddressVerificationServiceApi validateMailingAddressPro POST /addressverification/v1/validatemailingaddresspro/results.json ValidateMailingAddressPro
AddressVerificationServiceApi validateMailingAddressUSCAN POST /addressverification/v1/validatemailingaddressuscan/results.json ValidateMailingAddressUSCAN
AddressesServiceApi getAddressesCountByBoundaryName GET /addresses/v1/addresscount/byboundaryname Addresses Count by Boundary Name.
AddressesServiceApi getAddressesCountbyBoundary POST /addresses/v1/addresscount/byboundary Addresses count by Boundary.
AddressesServiceApi getAddressesbyBoundary POST /addresses/v1/address/byboundary Addresses by Boundary.
AddressesServiceApi getAddressesbyBoundaryName GET /addresses/v1/address/byboundaryname Addresses by Boundary Name.
DemographicsServiceApi getDemographicsAdvanced POST /demographics-segmentation/v1/advanced/demographics Demographics Advanced Endpoint
DemographicsServiceApi getDemographicsBasic GET /demographics-segmentation/v1/basic/demographics Demographics Basic
DemographicsServiceApi getDemographicsByAddress GET /demographics-segmentation/v1/demographics/byaddress Demographics By Address.
DemographicsServiceApi getDemographicsByBoundaryIds GET /demographics-segmentation/v1/demographics/byboundaryids Demographics By Boundaryids.
DemographicsServiceApi getDemographicsByLocation GET /demographics-segmentation/v1/demographics/bylocation Demographics By Location.
DemographicsServiceApi getSegmentationByAddress GET /demographics-segmentation/v1/segmentation/byaddress Segmentation By Address.
DemographicsServiceApi getSegmentationByLocation GET /demographics-segmentation/v1/segmentation/bylocation Segmentation By Location.
EmailVerificationServiceApi validateEmailAddress POST /emailverification/v1/validateemailaddress/results.json ValidateEmailAddress
GeocodeServiceApi geocode GET /geocode/v1/{datapackBundle}/geocode Get Forward Geocode(Basic/Premium/Advanced)
GeocodeServiceApi geocodeBatch POST /geocode/v1/{datapackBundle}/geocode Post Forward Geocode
GeocodeServiceApi getPBKey GET /geocode/v1/key/byaddress Get PreciselyID By Address
GeocodeServiceApi getPBKeys POST /geocode/v1/key/byaddress Post PreciselyID By Address
GeocodeServiceApi keyLookup GET /geocode/v1/keylookup Get Key Lookup
GeocodeServiceApi keyLookupBatch POST /geocode/v1/keylookup Post Key Lookup
GeocodeServiceApi reverseGeocodBatch POST /geocode/v1/{datapackBundle}/reverseGeocode Post Reverse Geocode
GeocodeServiceApi reverseGeocode GET /geocode/v1/{datapackBundle}/reverseGeocode Get Reverse Geocode(Basic/Premium/Advanced)
GeolocationServiceApi getLocationByIPAddress GET /geolocation/v1/location/byipaddress Location By IP Address.
GeolocationServiceApi getLocationByWiFiAccessPoint GET /geolocation/v1/location/byaccesspoint Location by WiFi Access Point.
LocalTaxServiceApi getBatchTaxByAddress POST /localtax/v1/tax/{taxRateTypeId}/byaddress Post Tax By Address
LocalTaxServiceApi getBatchTaxByLocation POST /localtax/v1/tax/{taxRateTypeId}/bylocation Post Tax By Location
LocalTaxServiceApi getBatchTaxRateByAddress POST /localtax/v1/taxrate/{taxRateTypeId}/byaddress Post Taxrate By Address
LocalTaxServiceApi getBatchTaxRateByLocation POST /localtax/v1/taxrate/{taxRateTypeId}/bylocation Post Taxrate By Location
LocalTaxServiceApi getIPDTaxByAddress GET /localtax/v1/taxdistrict/ipd/byaddress Get IPD Tax by Address
LocalTaxServiceApi getIPDTaxByAddressBatch POST /localtax/v1/taxdistrict/ipd/byaddress Get IPD Tax for batch requests.
LocalTaxServiceApi getSpecificTaxByAddress GET /localtax/v1/tax/{taxRateTypeId}/byaddress Get Tax By Address
LocalTaxServiceApi getSpecificTaxByLocation GET /localtax/v1/tax/{taxRateTypeId}/bylocation Get Tax By Location
LocalTaxServiceApi getSpecificTaxRateByAddress GET /localtax/v1/taxrate/{taxRateTypeId}/byaddress Get Taxrate By Address
LocalTaxServiceApi getSpecificTaxRateByLocation GET /localtax/v1/taxrate/{taxRateTypeId}/bylocation Get Taxrate By Location
NeighborhoodsServiceApi getPlaceByLocation GET /neighborhoods/v1/place/bylocation Place By Location.
PhoneVerificationServiceApi validatephonenumber POST /phoneverification/v2/validatephonenumber/results.json Phone verification.
PlacesServiceApi getCategoryCodeMetadata GET /places/v1/metadata/category Category Code Metadata.
PlacesServiceApi getPOIById GET /places/v1/poi/{id} Points Of Interest Details By Id
PlacesServiceApi getPOIsByAddress GET /places/v1/poi/byaddress Get POIs By Address.
PlacesServiceApi getPOIsByArea GET /places/v1/poi/byarea GET Points Of Interest By Area.
PlacesServiceApi getPOIsByGeometry POST /places/v1/poi/byboundary Points Of Interest By Boundary
PlacesServiceApi getPOIsByLocation GET /places/v1/poi/bylocation Get POIs By Location.
PlacesServiceApi getPOIsCount POST /places/v1/poicount Points Of Interest Count
PlacesServiceApi getSICMetadata GET /places/v1/metadata/sic Get SIC Metadata
PlacesServiceApi poisAutocomplete GET /places/v1/poi/autocomplete Points Of Interest Autocomplete
PropertyInformationServiceApi getParcelBoundaryByAddress GET /property/v2/parcelboundary/byaddress Get Parcel Boundary By Address
PropertyInformationServiceApi getParcelBoundaryByLocation GET /property/v2/parcelboundary/bylocation Get Parcel Boundary By Location
PropertyInformationServiceApi getParcelBoundaryByPreciselyID GET /property/v2/parcelboundary/bypreciselyID Get Parcel Boundary By PreciselyID
PropertyInformationServiceApi getPropertyAttributesByAddress GET /property/v2/attributes/byaddress PropertyV2 Attributes By Address.
PropertyInformationServiceApi getPropertyAttributesByAddressBatch POST /property/v2/attributes/byaddress PropertyV2 Attributes By Address Batch.
Psap911ServiceApi getAHJPlusPSAPByAddress GET /911/v1/ahj-psap/byaddress AHJ & PSAP By Address.
Psap911ServiceApi getAHJPlusPSAPByLocation GET /911/v1/ahj-psap/bylocation AHJ & PSAP By Location
Psap911ServiceApi getPSAPByAddress GET /911/v1/psap/byaddress PSAP By Address.
Psap911ServiceApi getPSAPByLocation GET /911/v1/psap/bylocation PSAP By Location.
Psap911ServiceApi searchByFccId GET /911/v1/ahj-psap/byfccid AHJ & PSAP By Fccid
RisksServiceApi getCrimeRiskByAddress GET /risks/v1/crime/byaddress Get Crime Risk By Address
RisksServiceApi getCrimeRiskByAddressBatch POST /risks/v1/crime/byaddress Post Crime Risk By Address
RisksServiceApi getCrimeRiskByLocation GET /risks/v1/crime/bylocation Get Crime Risk By Location
RisksServiceApi getCrimeRiskByLocationBatch POST /risks/v1/crime/bylocation Post Crime Risk By Location
RisksServiceApi getDistanceToCoastByAddress GET /risks/v1/shoreline/distancetofloodhazard/byaddress Get Distance To Flood Hazard By Address
RisksServiceApi getDistanceToCoastByAddressBatch POST /risks/v1/shoreline/distancetofloodhazard/byaddress Post Distance To Flood Hazard By Address
RisksServiceApi getDistanceToCoastByLocation GET /risks/v1/shoreline/distancetofloodhazard/bylocation Get Distance To Flood Hazard By Location
RisksServiceApi getDistanceToCoastByLocationBatch POST /risks/v1/shoreline/distancetofloodhazard/bylocation Post Distance To Flood Hazard By Location
RisksServiceApi getEarthquakeHistory GET /risks/v1/earthquakehistory Earthquake History
RisksServiceApi getEarthquakeRiskByAddress GET /risks/v1/earthquake/byaddress Get Earthquake Risk By Address
RisksServiceApi getEarthquakeRiskByAddressBatch POST /risks/v1/earthquake/byaddress Post Earthquake Risk By Address
RisksServiceApi getEarthquakeRiskByLocation GET /risks/v1/earthquake/bylocation Get Earthquake Risk By Location
RisksServiceApi getEarthquakeRiskByLocationBatch POST /risks/v1/earthquake/bylocation Post Earthquake Risk By Location
RisksServiceApi getFireHistory GET /risks/v1/firehistory Get Fire History
RisksServiceApi getFireHistoryV2 GET /risks/v2/firehistory Get Fire History
RisksServiceApi getFireRiskByAddress GET /risks/v1/fire/byaddress Get Fire Risk By Address
RisksServiceApi getFireRiskByAddressBatch POST /risks/v1/fire/byaddress Post Fire Risk By Address
RisksServiceApi getFireRiskByLocation GET /risks/v1/fire/bylocation Get Fire Risk By Location
RisksServiceApi getFireRiskByLocationBatch POST /risks/v1/fire/bylocation Post Fire Risk By Location
RisksServiceApi getFireRiskV2ByAddress GET /risks/v2/fire/byaddress Get Fire Risk By Address
RisksServiceApi getFireRiskV2ByAddressBatch POST /risks/v2/fire/byaddress Post Fire Risk By Address
RisksServiceApi getFireRiskV2ByLocation GET /risks/v2/fire/bylocation Get Fire Risk By Location
RisksServiceApi getFireRiskV2ByLocationBatch POST /risks/v2/fire/bylocation Post Fire Risk By Location
RisksServiceApi getFireStationByAddress GET /risks/v1/firestation/byaddress Get Fire Station By Address
RisksServiceApi getFireStationByLocation GET /risks/v1/firestation/bylocation Get Fire Station By Location
RisksServiceApi getFloodRiskByAddress GET /risks/v1/flood/byaddress Get Flood Risk By Address
RisksServiceApi getFloodRiskByAddressBatch POST /risks/v1/flood/byaddress Post Flood Risk By Address
RisksServiceApi getFloodRiskByLocation GET /risks/v1/flood/bylocation Get Flood Risk By Location
RisksServiceApi getFloodRiskByLocationBatch POST /risks/v1/flood/bylocation Post Flood Risk By Location
RoutingServiceApi getRouteByAddress GET /routing/v1/route/byaddress Gets Route By Address.
RoutingServiceApi getRouteByLocation GET /routing/v1/route/bylocation Gets Route By Location.
RoutingServiceApi getTravelCostMatrixByAddress GET /routing/v1/travelcostmatrix/byaddress Get Cost Matrix By Address.
RoutingServiceApi getTravelCostMatrixByLocation GET /routing/v1/travelcostmatrix/bylocation Get Cost Matrix By Location.
SchoolsServiceApi getSchoolsByAddress GET /schools/v1/school/byaddress Search Nearby Schools by Address
StreetsServiceApi getIntersectionByAddress GET /streets/v1/intersection/byaddress Nearest Intesection By Address.
StreetsServiceApi getIntersectionByLocation GET /streets/v1/intersection/bylocation Nearest Intesection By Location.
StreetsServiceApi getNearestSpeedLimit GET /streets/v1/speedlimit Nearest Speedlimit.
TelecommInfoServiceApi getRateCenterByAddress GET /telecomm/v1/ratecenter/byaddress Rate Center By Address.
TelecommInfoServiceApi getRateCenterByLocation GET /telecomm/v1/ratecenter/bylocation Rate Center By Location.
TimeZoneServiceApi getBatchTimezoneByLocation POST /timezone/v1/timezone/bylocation Timezone Batch by Location.
TimeZoneServiceApi getTimezoneByAddress GET /timezone/v1/timezone/byaddress Timezone By Address.
TimeZoneServiceApi getTimezoneByAddressBatch POST /timezone/v1/timezone/byaddress Timezone Batch by Address.
TimeZoneServiceApi getTimezoneByLocation GET /timezone/v1/timezone/bylocation Timezone By Location.
ZonesServiceApi getBasicBoundaryByAddress GET /zones/v1/basicboundary/byaddress Gets Basic Boundary by Address.
ZonesServiceApi getBasicBoundaryByLocation GET /zones/v1/basicboundary/bylocation Gets Basic Boundary by Location.
ZonesServiceApi getPOIBoundaryByAddress GET /zones/v1/poiboundary/byaddress Gets Point of Interests Boundary by Address.
ZonesServiceApi getPOIBoundaryByAddressBatch POST /zones/v1/poiboundary/byaddress Batch method for getting Point of Interests Boundary by Address.
ZonesServiceApi getPOIBoundaryByLocation GET /zones/v1/poiboundary/bylocation Get Point of Interests Boundary by Location.
ZonesServiceApi getPOIBoundaryByLocationBatch POST /zones/v1/poiboundary/bylocation Batch method for getting Point of Interests Boundary by Location.
ZonesServiceApi getTravelBoundaryByDistance GET /zones/v1/travelboundary/bydistance Get TravelBoundary By Distance.
ZonesServiceApi getTravelBoundaryByTime GET /zones/v1/travelboundary/bytime Get TravelBoundary By Time.

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

oAuth2Password

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

About

No description, website, or topics provided.

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

1 star

Watchers

4 watching

Forks

1 fork
Report repository

Releases 8

PreciselyAPIsSDK-Java 15.0.0 Latest
Apr 12, 2023
+ 7 releases

Packages

No packages published

Contributors 2

  •  
  •  

Languages