Skip to main content
GET
Enhance Location

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

sources
enum<string>[]
required

Specify any desired third-party data sources to include for this location.

Available options:
PG,
PH,
LB
address
string | null

Street address in any standard format.

address_line_1
string | null

Street address line 1.

Minimum string length: 1
address_line_2
string | null

Street address line 2, e.g. suite, unit, or floor.

Minimum string length: 1
architectural_style
string | null

Architectural style of the building (e.g. 'Victorian', 'Ranch', 'Contemporary').

Minimum string length: 1
bldg_name
string | null

Building name (e.g. 'Empire State Building').

Minimum string length: 1
bq_id
string | null

BrightQuery Organization ID.

Minimum string length: 1
check_cache
boolean
default:true

If false, bypass the cache and force a fresh fetch from all datasources.

city
string | null

City name.

Minimum string length: 1
company_ein
string | null

Company Employer Identification Number (EIN).

Minimum string length: 1
company_name
string | null

Company name.

Minimum string length: 1
company_website
string | null

Company website URL.

Minimum string length: 1
const__bldg_area
integer | null

Building usable area (sq ft).

const__bldg_year_built
integer | null

Year the building was constructed.

const__code_air
string | null

AIR construction code.

Minimum string length: 1
const__code_rms
string | null

RMS construction code.

Minimum string length: 1
const__desc_ping
enum<string> | null

Construction type using Ping's taxonomy.

Available options:
Automobiles - Automobiles,
Bridges - Conventional - Continuous Bridges,
Bridges - Conventional - Multiple Span Bridges,
Bridges - General - Concrete (Non-Seismic or Seismic) Bridge,
Bridges - General - Steel (Non-Seismic or Seismic) Bridge,
Bridges - Major Bridge (Non-Seismic or Seismic),
Bridges - Major Bridges,
Bridges - Multi-Span - Continuous (Non-Seismic or Seismic) Concrete Bridge,
Bridges - Multi-Span - Continuous (Non-Seismic or Seismic) Steel Bridge,
Bridges - Multi-Span - Simply Supported (Non-Seismic or Seismic) Concrete Bridge,
Bridges - Multi-Span - Simply Supported (Non-Seismic or Seismic) Steel Bridge,
Bridges - Single Span (Non-Seismic or Seismic) Bridge,
Bridges - Unknown Bridge (Non-Seismic or Seismic),
Cash In Transit - Cash being transferred,
Chimneys - Concrete Chimneys,
Chimneys - Masonry Chimneys,
Chimneys - Steel Chimneys,
Concrete - Pre-cast Concrete,
Concrete - Pre-cast Concrete with Shear Wall,
Concrete - Reinforced Concrete,
Concrete - Reinforced Concrete MRF,
Concrete - Reinforced Concrete MRF - Ductile,
Concrete - Reinforced Concrete MRF - Non-Ductile,
Concrete - Reinforced Concrete MRF with URM,
Concrete - Reinforced Concrete Shear Wall (with MRF),
Concrete - Reinforced Concrete Shear Wall (without MRF),
Concrete - Tilt-Up,
Dams - Concrete Dams,
Dams - Earthfill Dams,
Equipment - Electrical Equipment,
Equipment - High Technology Equipment,
Equipment - Mechanical Equipment,
Equipment - Office Equipment,
Equipment - Residential Equipment,
Equipment - Thermal Power Plant,
Equipment - Trains, Trucks, Airplanes,
Fine Art & Collectibles - Paintings, frames, sculpture, etc.,
General Specie - Statuettes, ornamental articles, fibers, arts and crafts, etc.,
Jewellers Block - Jewels, engravings and valuable metals and stones,
Marine Assets - Break Bulk Cargo,
Marine Assets - Chemical Products,
Marine Assets - Consumables,
Marine Assets - Electronics Cargo,
Marine Assets - Explosives Cargo,
Marine Assets - General Cargo,
Marine Assets - Heavy Industry Cargo,
Marine Assets - Light Industry Cargo,
Marine Assets - Livestock being shipped,
Marine Assets - Marine Assets Automobiles,
Marine Assets - Marine Assets Dry Bulk Cargo,
Marine Assets - Marine Assets Liquid Bulk Cargo,
Marine Assets - Petroleum Products,
Marine Assets - Pharmaceuticals,
Marine Assets - Project Cargos,
Marine Assets - Temperature-Controlled Cargo,
Marine Cargo - Carpool,
Marine Cargo - Combustible - Carpool,
Marine Cargo - Combustible - Dry Bulk Cargo,
Marine Cargo - Combustible - General and Containerized Cargo,
Marine Cargo - Combustible - Heavy Cargo,
Marine Cargo - Combustible - Liquid Bulk Cargo,
Marine Cargo - Combustible - Refrigerated Cargo,
Marine Cargo - Dry Bulk Cargo,
Marine Cargo - General and Containerized Cargo,
Marine Cargo - General/Unknown,
Marine Cargo - Heavy Cargo,
Marine Cargo - Liquid Bulk Cargo,
Marine Cargo - Non-Combustible - Carpool,
Marine Cargo - Non-Combustible - Dry Bulk Cargo,
Marine Cargo - Non-Combustible - General and Containerized Cargo,
Marine Cargo - Non-Combustible - Heavy Cargo,
Marine Cargo - Non-Combustible - Liquid Bulk Cargo,
Marine Cargo - Non-Combustible - Refrigerated Cargo,
Marine Cargo - Refrigerated Cargo,
Marine Cargo - Unknown Marine Cargo - Combustible,
Marine Cargo - Unknown Marine Cargo - Non-Combustible,
Marine Craft (Boats and Yachts) - Pleasure Boats and Yachts,
Marine Craft (Boats and Yachts) - Pleasure Boats and Yachts - Power Boats,
Marine Craft (Boats and Yachts) - Pleasure Boats and Yachts - Sail Boats,
Masonry - Adobe,
Masonry - Cavity Double Brick,
Masonry - Confined Masonry,
Masonry - Joisted Masonry,
Masonry - Masonry,
Masonry - Reinforced Masonry,
Masonry - Reinforced Masonry Shear Wall (with MRF),
Masonry - Reinforced Masonry Shear Wall (without MRF),
Masonry - Rubble Stone Masonry,
Masonry - Unreinforced Masonry - Bearing Frame,
Masonry - Unreinforced Masonry - Bearing Wall,
Miscellaneous - Canals,
Miscellaneous - Compressor Stations,
Miscellaneous - Conveyor Systems,
Miscellaneous - Cranes,
Miscellaneous - Earth Retaining Structures,
Miscellaneous - Marine Hull,
Miscellaneous - Offshore Structures,
Miscellaneous - Pumping Stations,
Miscellaneous - Railway Property (not valid in the United states),
Miscellaneous - Transit Warehouse,
Miscellaneous - Waterfront Structures,
Mobile Homes - Mobile Home with Full Tie-Downs,
Mobile Homes - Mobile Home with No Tie-Downs,
Mobile Homes - Mobile Home with Partial Tie-Downs,
Mobile Homes - Mobile Homes,
Offshore Assets - Caisson,
Offshore Assets - Compliant Tower,
Offshore Assets - Drill Rig,
Offshore Assets - Drill Ship,
Offshore Assets - Fixed Jacket Platform,
Offshore Assets - Jackup,
Offshore Assets - Mini Tension Leg Platform (MTLP),
Offshore Assets - Offshore Wind Turbines,
Offshore Assets - SPAR Floating Production System,
Offshore Assets - Semi-Submersible Floating Production System,
Offshore Assets - Submersible Production System,
Offshore Assets - Tension Leg Platform,
Offshore Assets - Underwater Production Units, Completion Units, and Templates,
Offshore Assets - Unknown,
Offshore Assets - Well Protector,
Pavements - Highways,
Pavements - Railroads,
Pavements - Runways,
Pipelines - At Grade Asbestos Cement Pipelines,
Pipelines - At Grade Cast Iron Pipelines,
Pipelines - At Grade Concrete Pipelines,
Pipelines - At Grade Ductile Iron Pipelines,
Pipelines - At Grade PVC Pipelines,
Pipelines - At Grade Pipelines,
Pipelines - General At Grade Pipelines,
Pipelines - General Underground Pipelines,
Pipelines - Underground Asbestos Cement Pipelines,
Pipelines - Underground Cast Iron Pipelines,
Pipelines - Underground Concrete Pipelines,
Pipelines - Underground Ductile Iron Pipelines,
Pipelines - Underground PVC Pipelines,
Pipelines - Underground Pipelines,
Pipelines - Unknown Pipeline,
Special - Impact Resistance Glass,
Special - Long Span,
Special - Safety Glass,
Special - Semi-Wind Resistive,
Special - Unknown Glass,
Special - Wind Resistive,
Steel - Braced Steel Frame,
Steel - Light Metal,
Steel - Steel,
Steel - Steel Frame with Concrete Shear Wall,
Steel - Steel Frame with URM,
Steel - Steel Long Span,
Steel - Steel MRF,
Steel - Steel MRF - Distributed,
Steel - Steel MRF - Perimeter,
Steel - Steel Reinforced Concrete,
Storage Tanks - Elevated Concrete Liquid Tanks (2000 series),
Storage Tanks - Elevated Concrete Solid Tanks,
Storage Tanks - Elevated Liquid Tanks,
Storage Tanks - Elevated Liquid Tanks (2000 series),
Storage Tanks - Elevated Solid Tanks,
Storage Tanks - Elevated Solid Tanks (2000 series),
Storage Tanks - Elevated Steel Liquid Tanks,
Storage Tanks - Elevated Steel Solid Tanks,
Storage Tanks - On Ground Concrete Liquid Tanks,
Storage Tanks - On Ground Concrete Solid Tanks,
Storage Tanks - On Ground Liquid Tanks,
Storage Tanks - On Ground Liquid Tanks (2000 series),
Storage Tanks - On Ground Solid Tanks,
Storage Tanks - On Ground Solid Tanks (2000 series),
Storage Tanks - On Ground Steel Liquid Tanks,
Storage Tanks - On Ground Steel Solid Tanks,
Storage Tanks - Underground Liquid Tanks,
Storage Tanks - Underground Liquid Tanks (2000 series),
Storage Tanks - Underground Solid Tanks,
Storage Tanks - Underground Solid Tanks (2000 series),
Storage Tanks - Unknown Tanks,
Towers - Broadcast Towers,
Towers - Electrical Transmission - Conventional,
Towers - Electrical Transmission - Major,
Towers - Observation Towers,
Towers - Offshore Towers,
Tunnels - Alluvial Bored Tunnels,
Tunnels - Alluvial Cut and Cover Tunnels,
Tunnels - Alluvium Tunnels,
Tunnels - Alluvium Tunnels (2000 series),
Tunnels - Cut and Cover Tunnels,
Tunnels - Rock Bored Tunnels,
Tunnels - Rock Cut and Cover Tunnels,
Tunnels - Rock Tunnels,
Tunnels - Rock Tunnels (2000 series),
Tunnels - Unknown Tunnel,
Unknown,
Wood - Hale Construction (Indigenous Hawaii),
Wood - Heavy Timber,
Wood - Light Wood Frame,
Wood - Lightweight Cladding,
Wood - Masonry Veneer,
Wood - Wood Frame (Modern),
null
Minimum string length: 1
const__num_stories
number<double> | null

Number of above-grade floors.

const__num_stories_below_gnd
integer | null

Number of below-grade floors.

const__roof_covering
string | null

Roof covering material type (e.g. 'Tile', 'Metal', 'Asphalt Shingle').

Minimum string length: 1
const__wall_type
string | null

Exterior wall type (e.g. 'Masonry', 'Frame', 'Concrete').

Minimum string length: 1
country
string | null

Country name or ISO code.

Minimum string length: 1
county
string | null

County name.

Minimum string length: 1
deductible_amount
number<double> | null

Primary deductible amount (USD).

deductible_amount2
number<double> | null

Secondary deductible amount (USD).

deductible_amount3
number<double> | null

Tertiary deductible amount (USD).

deductible_type
integer | null

Deductible type: 1=Building, 2=Contents, 3=Business Interruption.

delegate_to
string | null

If set, delegate this request to another user (requires delegation permissions).

Minimum string length: 1
dtc_include_coastline_within_miles
number<double> | null

Distance-to-coast: include coastlines within this many miles of the location.

dtc_return_connected_coastlines
boolean | null

Distance-to-coast: if true, return all connected coastlines rather than only the nearest.

geocode_confidence
integer | null

Geocoding confidence score (0–100).

geocode_precision
integer | null

Geocoding precision level (0-100).

hurricane_basin
string | null

Filter historical hurricane track results by basin (e.g. 'Atlantic', 'Gulf').

Minimum string length: 1
hurricane_name
string | null

Filter historical hurricane track results by storm name (e.g. 'Katrina').

Minimum string length: 1
hurricane_season
integer | null

Filter historical hurricane tracks by the season the storm is assigned to (e.g. 2005). A storm forming in late November may carry track points into the following calendar year.

hurricane_year
integer | null

Filter historical hurricane tracks by the calendar year of the individual track point (e.g. 2005). Use hurricane_season to filter by the storm's assigned season instead.

include_raw_request
boolean

If true, include the raw request sent to the datasource for non cache hits. Does not support all datasources.

include_raw_response
boolean

If true, include the datasource's original response.

insured_business_name
string | null

Business name of the insured.

Minimum string length: 1
insured_name
string | null

Name of the insured.

Minimum string length: 1
latitude
number<double> | null

Latitude (decimal degrees). Either supplied directly, or derived from address by a geocoding source (e.g. PG). Required upstream input for hazard and risk datasources.

lightbox_assessment_id
string | null

Lightbox assessment identifier.

Minimum string length: 1
lightbox_parcel_id
string | null

Lightbox parcel identifier.

Minimum string length: 1
lightbox_parcel_wkt
string | null

Lightbox parcel boundary geometry in WKT format.

Minimum string length: 1
limits__bi_limit
number<double> | null

Business Interruption coverage limit (USD).

limits__bpp_limit
number<double> | null

Business Personal Property (contents) coverage limit (USD).

limits__building_limit
number<double> | null

Building coverage limit (USD).

limits__signs_and_other_limit
number<double> | null

Signs and other structures coverage limit (USD).

longitude
number<double> | null

Longitude (decimal degrees). Either supplied directly, or derived from address by a geocoding source (e.g. PG). Required upstream input for hazard and risk datasources.

model_code
string | null

Catastrophe model code. Omit to use the default model.

Minimum string length: 1
occupancy__code_air
string | null

AIR occupancy code.

Minimum string length: 1
occupancy__code_atc
string | null

ATC/RMS occupancy code.

Minimum string length: 1
occupancy__desc_ping
enum<string> | null

Occupancy classification using Ping's taxonomy.

Available options:
Commercial - Construction/Erection Risks,
Commercial - Entertainment and Recreation,
Commercial - General Commercial,
Commercial - Golf Courses,
Commercial - Health Care Services,
Commercial - Inland Transit Cargo,
Commercial - Parking,
Commercial - Personal and Repair Services,
Commercial - Professional, Technical, and Business Services,
Commercial - Retail Trade,
Commercial - Wholesale Trade,
Education - Primary and Secondary Schools,
Education - Universities, Colleges, and Technical Schools,
Government - Government - Emergency Services,
Government - Government - General Services,
Industrial - Chemical Processing,
Industrial - Construction,
Industrial - Construction/Erection Risks,
Industrial - Food and Drug Processing,
Industrial - General Industrial,
Industrial - Heavy Fabrication and Assembly,
Industrial - High-Technology,
Industrial - Light Fabrication and Assembly,
Industrial - Metal and Minerals Processing,
Industrial - Mining,
Industrial - Petroleum,
Industrial Facility - Agriculture Systems - General,
Industrial Facility - Airport Systems - General,
Industrial Facility - Apparel and Finished Products from Fabrics,
Industrial Facility - Automotive Manufacturing,
Industrial Facility - Biological Products (Except Diagnostic) Medicinals/Botanicals/Biomedical,
Industrial Facility - Business Systems - General,
Industrial Facility - Cement Plants/Cement Mills,
Industrial Facility - Chemical Processing - General,
Industrial Facility - Chlorine Plants,
Industrial Facility - Chlorohydrin Plants,
Industrial Facility - Coal Mining,
Industrial Facility - Communication Systems - General,
Industrial Facility - Computer Storage Devices,
Industrial Facility - Electric Substations,
Industrial Facility - Electron Tubes,
Industrial Facility - Electronic Computer Devices,
Industrial Facility - Electronic and Other Electrical Equipment (Except Computer Equipment),
Industrial Facility - Fabricated Metal Products,
Industrial Facility - Ferry Systems,
Industrial Facility - Fertilizer Plants,
Industrial Facility - Food and Drug Processing - General,
Industrial Facility - Food and Kindred Products,
Industrial Facility - Furniture and Fixtures,
Industrial Facility - Gas Processing Systems - General,
Industrial Facility - General Building/Construction Contractors,
Industrial Facility - Heavy Constructions,
Industrial Facility - Heavy Fabrication and Assembly - General,
Industrial Facility - High-Technology - General,
Industrial Facility - Hydro-Electric Power Systems - General,
Industrial Facility - Industrial and Commercial Machinery and Equipment,
Industrial Facility - Leather and Leather Products,
Industrial Facility - Light Fabrication and Assembly - General,
Industrial Facility - Light Hydrocarbon or Aromatics Plants,
Industrial Facility - Lumber and Wood Products (Except Furniture),
Industrial Facility - Measuring, Analyzing, and Controlling Instruments,
Industrial Facility - Metal Mining,
Industrial Facility - Metal and Minerals Processing - General,
Industrial Facility - Mining - General,
Industrial Facility - Mining Operations,
Industrial Facility - Mining/Quarrying - Non-Metallic Mineral (Except Fuels),
Industrial Facility - Miscellaneous Manufacturing Industries,
Industrial Facility - Nuclear Power Systems - General,
Industrial Facility - Oil Refinery Systems - General,
Industrial Facility - Other Chemical and Allied Products,
Industrial Facility - Pharmaceutical Plants,
Industrial Facility - Photographic, Medical, and Optical Goods,
Industrial Facility - Plastics Plants,
Industrial Facility - Port Systems,
Industrial Facility - Potable Water Systems - General,
Industrial Facility - Primary Metal Industry,
Industrial Facility - Print/Publishing and Allied Industries,
Industrial Facility - Printed Circuit Boards,
Industrial Facility - Pulp/Paper and Allied Products Manufacturing,
Industrial Facility - Rubber and Miscellaneous Plastics Products,
Industrial Facility - Semi-Conductor and Related Devices,
Industrial Facility - Smelters,
Industrial Facility - Special Trade Contractors,
Industrial Facility - Steel Mills,
Industrial Facility - Stone/Clay/Glass/Ceramics Products,
Industrial Facility - Textile Mill Products,
Industrial Facility - Thermo-Electric Power Systems - General,
Industrial Facility - Tire Manufacturers,
Industrial Facility - Tobacco Products,
Industrial Facility - Transportation Equipment Assembly,
Industrial Facility - Unknown Industrial Facility,
Industrial Facility - Vinyl Plants,
Industrial Facility - Waste Water Treatment Systems - General,
Industrial Facility - Watches and Clocks,
Industrial Facility - Wineries,
Mercantile - Automotive Repair Shops and Car Washes,
Mercantile - Gasoline Stations,
Miscellaneous - Agriculture,
Miscellaneous - At Destination Retail,
Miscellaneous - At Destination in Warehouse,
Miscellaneous - Communication,
Miscellaneous - Construction/Erection Risks,
Miscellaneous - Containerized Inside Warehouse,
Miscellaneous - Containerized Stacked Outside,
Miscellaneous - Designated Facilities / Vaults,
Miscellaneous - Flood Control,
Miscellaneous - Forestry,
Miscellaneous - Gas Tanks,
Miscellaneous - Greenhouses,
Miscellaneous - Inside Warehouse At Port,
Miscellaneous - Liquid Tanks,
Miscellaneous - Museums, Institutions, Public Buildings,
Miscellaneous - Open Lot or Stockpiled Outside,
Miscellaneous - Retail & Private Buildings,
Miscellaneous - Silo,
Offshore - Drilling,
Offshore - Gas Production Only,
Offshore - No Production,
Offshore - Oil Production Only,
Offshore - Oil and Gas Production,
Offshore - Pipelines,
Offshore - Ready Stacked,
Offshore - Unknown,
Offshore - Waiting on Location,
Offshore - Workover,
Religion and Non-Profit - Churches,
Religion and Non-Profit - Religion and Non-Profit,
Residential - Apartments/Condominiums,
Residential - Construction/Erection Risks,
Residential - Damageable Land,
Residential - General Residential,
Residential - Group Institutional Housing,
Residential - Permanent Dwelling: Multi-Family,
Residential - Permanent Dwelling: Single-Family,
Residential - Temporary Lodging,
Residential - Terraced Housing,
Restaurants - Restaurants,
Transportation - Air,
Transportation - Aircraft Hangars,
Transportation - Aircraft at Ramps or Boarding Gates,
Transportation - Highway,
Transportation - Railroad,
Transportation - Sea and Inland Waterways,
Unknown,
Utilities - Electrical Utilities,
Utilities - Natural Gas,
Utilities - Sanitary Sewer,
Utilities - Telephone and Telegraph,
Utilities - Water Utilities,
null
Minimum string length: 1
occupancy__type_desc
string | null

Occupancy type description.

Minimum string length: 1
postal_code
string | null

ZIP or postal code.

Minimum string length: 1
site_name
string | null

Site or location name.

Minimum string length: 1
state
string | null

State as supplied (full name or abbreviation). See also state_code and state_name for normalized forms.

Minimum string length: 1
state_code
string | null

Two-letter U.S. state abbreviation (e.g. 'CA').

Minimum string length: 1
state_name
string | null

Full U.S. state name (e.g. 'California').

Minimum string length: 1
timeout
number<double>
default:10

Seconds before giving up.

Response

id
string<uuid>
required

Request ID

location_data
object
required