> ## Documentation Index > Fetch the complete documentation index at: https://docs.pingintel.com/llms.txt > Use this file to discover all available pages before exploring further. # Enhance Location > Request data from multiple sources for a single location, synchronously. ## OpenAPI ````yaml https://data-api-staging.sovfixer.com/api/schema/?format=json get /api/v1/enhance openapi: 3.0.3 info: title: Ping.Data API version: v1.0 description: > ### Ping.Data API This API provides convenient, efficient access to bulk location data from many sources. The typical usage flow is: * POST to `/api/v1/bulk_enhance`. The POST body should look like this: ``` { "locations": [ { "id": "user-id1", "address": "1212 Ping Data Lane, Pingville, FL", "sources": ["PG", "PH"], ... }, ... ], "timeout": 60.0, } ``` * Poll GET `/api/v1/bulk_enhance/{id}`, passing the `id` given by the previous response until `response.request.status` is `COMPLETE` or `FAILED`. * Download the data as JSON from `/api/v1/sov/{id}/output/{filename}`. The exact url comes from the response to the above query, in `response.result.outputs[].url`. Output JSON Example: ``` { "user-id1": { "GG": { "is_success": true, "error_message": null, "confidence": 80, "status_code": 200, "fetch_time": 4.754, "street_number": "1212", "route": "Ping Data Ln", "location_type": "ROOFTOP", "latitude": 28.xxx, "longitude": -81.xxx, "formatted_address": "1212 Ping Data Lane, Pingville, FL, USA", "place_id": "xxx-yyy", "address_line_1": "1212 Ping Data Lane", "address_line_2": "", "city": "Pingville", "postal_code": "00010", "county": "Pingville", "state": "FL", "country": "US" }, "HH": { "is_success": true, "error_message": null, "confidence": null, "status_code": null, "latitude": 28.xxx, "longitude": -81.xxx, "geocode_type": "ADDRESS", "google_maps_link": "https://www.google.com/maps/search/?api=1&query=28.xxx,-81.xxx", "fema_flood_zone": "X", "elevation": null, "bldg_year_built": 2009, ... more attributes ... } }, ... more buildings ... } ``` contact: email: support@pingintel.com name: Ping Intel url: https://www.pingintel.com servers: - url: https://data-api.sovfixer.com description: Ping.Data API - url: https://data-api-staging.sovfixer.com description: Ping.Data API (staging) security: [] paths: /api/v1/enhance: get: tags: - Enhance summary: Enhance Location description: Request data from multiple sources for a single location, synchronously. operationId: api_v1_enhance_location parameters: - in: query name: sources schema: type: array items: type: string enum: - PG - PH - LB description: >- Specify any desired third-party data sources to include for this location. required: true - in: query name: address schema: type: string nullable: true description: Street address in any standard format. - in: query name: address_line_1 schema: type: string nullable: true minLength: 1 description: Street address line 1. - in: query name: address_line_2 schema: type: string nullable: true minLength: 1 description: Street address line 2, e.g. suite, unit, or floor. - in: query name: architectural_style schema: type: string nullable: true minLength: 1 description: >- Architectural style of the building (e.g. 'Victorian', 'Ranch', 'Contemporary'). - in: query name: bldg_name schema: type: string nullable: true minLength: 1 description: Building name (e.g. 'Empire State Building'). - in: query name: check_cache schema: type: boolean default: true description: >- If false, bypass the cache and force a fresh fetch from all datasources. - in: query name: city schema: type: string nullable: true minLength: 1 description: City name. - in: query name: company_ein schema: type: string nullable: true minLength: 1 description: Company Employer Identification Number (EIN). - in: query name: company_name schema: type: string nullable: true minLength: 1 description: Company name. - in: query name: company_website schema: type: string nullable: true minLength: 1 description: Company website URL. - in: query name: const__bldg_area schema: type: integer nullable: true description: Building usable area (sq ft). - in: query name: const__bldg_year_built schema: type: integer nullable: true description: Year the building was constructed. - in: query name: const__code_air schema: type: string nullable: true minLength: 1 description: AIR construction code. - in: query name: const__code_rms schema: type: string nullable: true minLength: 1 description: RMS construction code. - in: query name: const__desc_ping schema: enum: - 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 type: string x-spec-enum-id: 5114c8bf5c13930f nullable: true minLength: 1 description: Construction type using Ping's taxonomy. - in: query name: const__num_stories schema: type: number format: double nullable: true description: Number of above-grade floors. - in: query name: const__num_stories_below_gnd schema: type: integer nullable: true description: Number of below-grade floors. - in: query name: const__roof_covering schema: type: string nullable: true minLength: 1 description: >- Roof covering material type (e.g. 'Tile', 'Metal', 'Asphalt Shingle'). - in: query name: const__wall_type schema: type: string nullable: true minLength: 1 description: Exterior wall type (e.g. 'Masonry', 'Frame', 'Concrete'). - in: query name: country schema: type: string nullable: true minLength: 1 description: Country name or ISO code. - in: query name: county schema: type: string nullable: true minLength: 1 description: County name. - in: query name: deductible_amount schema: type: number format: double nullable: true description: Primary deductible amount (USD). - in: query name: deductible_amount2 schema: type: number format: double nullable: true description: Secondary deductible amount (USD). - in: query name: deductible_amount3 schema: type: number format: double nullable: true description: Tertiary deductible amount (USD). - in: query name: deductible_type schema: type: integer nullable: true description: 'Deductible type: 1=Building, 2=Contents, 3=Business Interruption.' - in: query name: delegate_to schema: type: string nullable: true minLength: 1 description: >- If set, delegate this request to another user (requires delegation permissions). - in: query name: dtc_include_coastline_within_miles schema: type: number format: double nullable: true description: >- Distance-to-coast: include coastlines within this many miles of the location. - in: query name: dtc_return_connected_coastlines schema: type: boolean nullable: true description: >- Distance-to-coast: if true, return all connected coastlines rather than only the nearest. - in: query name: geocode_confidence schema: type: integer nullable: true description: Geocoding confidence score (0–100). - in: query name: geocode_precision schema: type: integer nullable: true description: Geocoding precision level (0-100). - in: query name: hurricane_basin schema: type: string nullable: true minLength: 1 description: >- Filter historical hurricane track results by basin (e.g. 'Atlantic', 'Gulf'). - in: query name: hurricane_name schema: type: string nullable: true minLength: 1 description: >- Filter historical hurricane track results by storm name (e.g. 'Katrina'). - in: query name: hurricane_season schema: type: integer nullable: true description: >- 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. - in: query name: hurricane_year schema: type: integer nullable: true description: >- 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. - in: query name: include_raw_response schema: type: boolean description: If true, include the datasource's original response. - in: query name: insured_business_name schema: type: string nullable: true minLength: 1 description: Business name of the insured. - in: query name: insured_name schema: type: string nullable: true minLength: 1 description: Name of the insured. - in: query name: latitude schema: type: number format: double nullable: true description: >- 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. - in: query name: lightbox_assessment_id schema: type: string nullable: true minLength: 1 description: Lightbox assessment identifier. - in: query name: lightbox_parcel_id schema: type: string nullable: true minLength: 1 description: Lightbox parcel identifier. - in: query name: lightbox_parcel_wkt schema: type: string nullable: true minLength: 1 description: Lightbox parcel boundary geometry in WKT format. - in: query name: limits__bi_limit schema: type: number format: double nullable: true description: Business Interruption coverage limit (USD). - in: query name: limits__bpp_limit schema: type: number format: double nullable: true description: Business Personal Property (contents) coverage limit (USD). - in: query name: limits__building_limit schema: type: number format: double nullable: true description: Building coverage limit (USD). - in: query name: limits__signs_and_other_limit schema: type: number format: double nullable: true description: Signs and other structures coverage limit (USD). - in: query name: longitude schema: type: number format: double nullable: true description: >- 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. - in: query name: model_code schema: type: string nullable: true minLength: 1 description: Catastrophe model code. Omit to use the default model. - in: query name: occupancy__code_air schema: type: string nullable: true minLength: 1 description: AIR occupancy code. - in: query name: occupancy__code_atc schema: type: string nullable: true minLength: 1 description: ATC/RMS occupancy code. - in: query name: occupancy__desc_ping schema: enum: - 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 type: string x-spec-enum-id: 9b5d4f804759cae7 nullable: true minLength: 1 description: Occupancy classification using Ping's taxonomy. - in: query name: occupancy__type_desc schema: type: string nullable: true minLength: 1 description: Occupancy type description. - in: query name: postal_code schema: type: string nullable: true minLength: 1 description: ZIP or postal code. - in: query name: site_name schema: type: string nullable: true minLength: 1 description: Site or location name. - in: query name: state schema: type: string nullable: true minLength: 1 description: >- State as supplied (full name or abbreviation). See also state_code and state_name for normalized forms. - in: query name: state_code schema: type: string nullable: true minLength: 1 description: Two-letter U.S. state abbreviation (e.g. 'CA'). - in: query name: state_name schema: type: string nullable: true minLength: 1 description: Full U.S. state name (e.g. 'California'). - in: query name: timeout schema: type: number format: double default: 10 description: Seconds before giving up. responses: '200': content: application/json: schema: $ref: '#/components/schemas/Response' examples: Example1: value: id: 33a4b502-5474-11f1-928b-0242ac110012 location_data: PG: address_line_1: 1600 Pennsylvania Ave address_line_2: '' candidate_countries: - US city: Washington confidence: 98 constructed_address: null consulted_datasources: - AZG - EG - GG country: US country_subdivision_code: DC country_subdivision_name: District of Columbia county: District of Columbia error_message: null fetch_time: 0 formatted_address: 1600 Pennsylvania Ave NW, Washington, DC, 20500, USA is_cache_hit: true is_success: true latitude: 38.897675 location_type: ROOFTOP longitude: -77.036547 match_confidence: 1 match_level: point postal_code: '20500' precision: 100 precision_confidences: '{"100": [99], "90": [97]}' route: Pennsylvania Ave source_desc: EG state: DC state_code: DC state_name: District of Columbia status_code: 200 street_number: '1600' used_point_coordinates_from_input: false version: '2.1' PH: aais_classification: P1 assault_grade: A avln_riskr: Not Applicable avln_risks: null avln_riskv: null burglary_grade: A burn_probability: 0 cfld_riskr: Relatively Moderate cfld_risks: 93.14694479331622 cfld_riskv: 28861.34047527059 confidence: null consulted_datasources: - PFF - PSZ - DTC - FNRI - PUSDAW - EC - DTFH - DTFST - DTFS county: District of Columbia cwav_riskr: Very Low cwav_risks: 42.67587879941017 cwav_riskv: 51.76375998598555 distance_to_coast_closest_point_latitude: null distance_to_coast_closest_point_longitude: null distance_to_coast_connected_lines: null distance_to_coast_feet: null distance_to_coast_miles: null distance_to_fire_hydrant_feet: 145 distance_to_fire_station_feet: 2777 distance_to_florida_sinkhole_feet: null drgt_riskr: No Rating drgt_risks: 0 drgt_riskv: 0 elevation_meters: null erqk_riskr: Relatively Low erqk_risks: 74.49103362983399 erqk_riskv: 65439.643970069046 error_message: null fema_flood_zone: X fema_flood_zone_dfirm_id: '110001' fema_flood_zone_subtype: AREA OF MINIMAL FLOOD HAZARD fema_flood_zone_version_date: '2024-03-04' fema_flood_zone_version_id: 1.1.1.0 fetch_time: 0.919 fire_hydrant_closest_point_latitude: 38.897979 fire_hydrant_closest_point_longitude: -77.036221 fire_hydrant_point: POINT (-77.03622138 38.8979795) fire_station_closest_point_latitude: 38.903346 fire_station_closest_point_longitude: -77.03002 fire_station_extra_data: address: 1018 13th Street Northwest city: Washington full_address: 1018 13th Street Northwest Washington DC 20005 geometry: POINT(-77.0300200223059 38.9033462309023) latitude: 38.9033462309 longitude: -77.0300200223 name: District of Columbia Fire and EMS Engine Company 16 state: DC volunteer: false zip_code: '20005' fire_station_point: POINT (-77.030020022 38.903346231) florida_sinkhole_closest_point_latitude: null florida_sinkhole_closest_point_longitude: null florida_sinkhole_extra_data: null florida_sinkhole_point: null hail_riskr: Very Low hail_risks: 21.493126575655236 hail_riskv: 175.3525372135981 hrcn_riskr: Relatively Moderate hrcn_risks: 70.88903691540284 hrcn_riskv: 177441.96190580144 hwav_riskr: Relatively Low hwav_risks: 18.542786471959282 hwav_riskv: 537.0330751774717 is_cache_hit: null is_success: true istm_riskr: Very Low istm_risks: 4.525830420864049 istm_riskv: 114.67997797816908 larceny_grade: A lnds_riskr: Relatively High lnds_risks: 99.00256211642734 lnds_riskv: 34903.01678905775 ltng_riskr: Very Low ltng_risks: 4.693339722089123 ltng_riskv: 221.9407465941976 murder_grade: A ping_fire_protection_class: 1 rape_grade: A resolution_meters: null rfld_riskr: Very High rfld_risks: 99.01893164629215 rfld_riskv: 1583302.1451594916 risk_ratng: Relatively High risk_score: 87.1676259335014 risk_value: 2004190.7924202646 robbery_grade: A slosh_zone_category: null slosh_zone_value: null state: District of Columbia status_code: 200 swnd_riskr: Relatively Moderate swnd_risks: 71.81182514389003 swnd_riskv: 27310.199975305975 total_crime_grade: A trnd_riskr: Relatively Moderate trnd_risks: 56.88531608238596 trnd_riskv: 84720.29673737474 tsun_riskr: Insufficient Data tsun_risks: null tsun_riskv: null vehicle_theft_grade: A vlcn_riskr: Not Applicable vlcn_risks: null vlcn_riskv: null wfir_riskr: Relatively Low wfir_risks: 65.47115064453219 wfir_riskv: 1028.003435515304 wntw_riskr: Very Low wntw_risks: 21.510964182086287 wntw_riskv: 83.41387542867878 summary: >- 1600 Pennsylvania Avenue (Requesting Ping Geocoding and Ping Hazard) description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse401' description: '' security: - tokenAuth: [] components: schemas: Response: type: object properties: id: type: string format: uuid description: Request ID location_data: $ref: '#/components/schemas/EnhanceResponse' required: - id - location_data ErrorResponse: type: object properties: id: type: string format: uuid description: Request ID message: type: string description: Server error message detail required: - id - message ErrorResponse401: type: object properties: id: type: string format: uuid description: Request ID message: type: string description: Authorization error message required: - id - message EnhanceResponse: type: object properties: PG: $ref: '#/components/schemas/PingGeoData' PH: $ref: '#/components/schemas/PingHazardData' required: - PG - PH PingGeoData: type: object properties: address_line_1: type: string nullable: true description: Primary street address line of the location (e.g., '123 Main St'). address_line_2: type: string nullable: true description: Secondary address information of the location (e.g., Apt. 33) candidate_countries: type: array items: type: string nullable: true city: type: string nullable: true description: City where the property is located (e.g., 'Miami'). confidence: type: integer nullable: true description: >- Confidence score indicating the reliability of the returned data for the given location. constructed_address: type: string nullable: true description: >- The fully assembled address string built from the individual address components. consulted_datasources: type: array items: type: string nullable: true description: List of data source codes used to generate the address result. country: type: string nullable: true description: Country where the property is located (e.g., 'US'). country_subdivision_code: type: string nullable: true description: Abbreviated code for the state/province (e.g., 'FL'). country_subdivision_name: type: string nullable: true description: Full name of the state/province (e.g., 'Florida'). county: type: string nullable: true description: County or equivalent region for the location (e.g., 'Miami-Dade'). error_message: type: string nullable: true description: Message returned when a request fails. fetch_time: type: number format: double nullable: true description: Time taken to retrieve the data, in seconds. formatted_address: type: string nullable: true description: Human-readable full address (e.g., '123 Main St, Miami, FL 33133'). is_cache_hit: type: boolean nullable: true description: >- Indicates whether the result was served from cache or freshly computed. is_success: type: boolean nullable: true description: Indicates whether the data retrieval was successful or not. latitude: type: number format: double nullable: true description: Latitude of the location. location_type: type: string nullable: true description: >- Indicates how precisely the coordinates represent the actual address (e.g., 'ROOFTOP') longitude: type: number format: double nullable: true description: Longitude of the location. match_confidence: type: number format: double nullable: true description: Confidence level of the address match (e.g., '0.57'). match_level: type: string nullable: true description: Level of detail matched in the address (e.g., 'street_imputed'). persist_for: type: string nullable: true description: >- Duration for which this result should be cached before requiring a fresh fetch. postal_code: type: string nullable: true description: Postal code (e.g., ZIP code in the US). precision: type: integer nullable: true description: Precision score of the geocoding. precision_confidences: type: object additionalProperties: {} nullable: true description: Map of precision scores to confidence values. raw_response: type: object additionalProperties: {} nullable: true description: The unprocessed response data from the datasource. route: type: string nullable: true description: Street name or route component of the address. source_desc: type: string nullable: true description: Source system that provided the geocoded data. state: type: string nullable: true description: State abbreviation (e.g., 'MA'). state_code: type: string nullable: true description: Alternate field for state abbreviation. state_name: type: string nullable: true description: Full state name. status_code: type: integer nullable: true description: >- HTTP status code indicating the result of the request. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status for reference. street_number: type: string nullable: true description: Street number component of the address. used_point_coordinates_from_input: type: boolean nullable: true description: >- Whether the geocoding result used latitude/longitude coordinates provided in the input rather than geocoding from an address. version: type: string nullable: true description: Data source version identifier (e.g., '2.1'). worker_name: type: string nullable: true description: Identifier of the worker process that handled this request. PingHazardData: type: object properties: aais_classification: type: string nullable: true description: >- Fire protection classification code and description from the AAIS system (e.g., 'P1, PROTECTED 1' indicates highest protection level). assault_grade: type: string nullable: true description: Crime grade for aggravated assault rate in the area. avln_riskr: type: string nullable: true description: Avalanche hazard risk rating label. avln_risks: type: number format: double nullable: true description: Avalanche hazard risk score (national percentile, 0-100). avln_riskv: type: number format: double nullable: true description: Expected annual loss in USD for avalanche hazards. burglary_grade: type: string nullable: true description: Crime grade for burglary rate in the area. burn_probability: type: number format: double nullable: true description: Annual probability of a wildfire burning the location. cfld_riskr: type: string nullable: true description: Coastal flood hazard risk rating label. cfld_risks: type: number format: double nullable: true description: Coastal flood hazard risk score (national percentile, 0-100). cfld_riskv: type: number format: double nullable: true description: Expected annual loss in USD for coastal flood hazards. confidence: type: integer nullable: true description: >- Confidence score indicating the reliability of the returned data for the given location. consulted_datasources: type: array items: type: string nullable: true description: >- List of data source codes used to generate the hazard and risk outputs for the location. county: type: string nullable: true description: Name of the county where the property is located. cwav_riskr: type: string nullable: true description: Cold wave hazard risk rating label. cwav_risks: type: number format: double nullable: true description: Cold wave hazard risk score (national percentile, 0-100). cwav_riskv: type: number format: double nullable: true description: Expected annual loss in USD for cold wave hazards. distance_to_coast_closest_point_latitude: type: number format: double nullable: true description: Latitude of the nearest point on the coast to the location. distance_to_coast_closest_point_longitude: type: number format: double nullable: true description: Longitude of the nearest point on the coast to the location. distance_to_coast_connected_lines: type: array items: type: string nullable: true description: >- WKT LineString connecting the location to the nearest point on the coast. distance_to_coast_feet: type: integer nullable: true description: Distance from the location to the coast, measured in feet. distance_to_coast_miles: type: number format: double nullable: true description: Distance from the location to the coast, measured in miles. distance_to_fire_hydrant_feet: type: integer nullable: true description: >- Distance from the location to the nearest fire hydrant, measured in feet. distance_to_fire_station_feet: type: integer nullable: true description: >- Distance from the location to the nearest fire station, measured in feet. distance_to_florida_sinkhole_feet: type: integer nullable: true description: >- Distance from the property to the nearest known Florida sinkhole, in feet. drgt_riskr: type: string nullable: true description: Drought hazard risk rating label. drgt_risks: type: number format: double nullable: true description: Drought hazard risk score (national percentile, 0-100). drgt_riskv: type: number format: double nullable: true description: Expected annual loss in USD for drought hazards. elevation_meters: type: number format: double nullable: true description: Elevation of the location above sea level, in meters. erqk_riskr: type: string nullable: true description: Earthquake hazard risk rating label. erqk_risks: type: number format: double nullable: true description: Earthquake hazard risk score (national percentile, 0-100). erqk_riskv: type: number format: double nullable: true description: Expected annual loss in USD for earthquake hazards. error_message: type: string nullable: true description: Message returned when a request fails. fema_flood_zone: type: string nullable: true description: FEMA flood zone designation indicating the level of flood risk. fema_flood_zone_dfirm_id: type: string nullable: true description: FEMA Digital Flood Insurance Rate Map (DFIRM) panel identifier. fema_flood_zone_subtype: type: string nullable: true description: >- Additional description on the features within the primary FEMA flood zone. fema_flood_zone_version_date: type: string format: date-time nullable: true description: Date of the FEMA flood zone data version used for this record. fema_flood_zone_version_id: type: string nullable: true description: Version identifier representing the specific FEMA flood zone data. fetch_time: type: number format: double nullable: true description: Time taken to retrieve the data, in seconds. fire_hydrant_closest_point_latitude: type: number format: double nullable: true description: Latitude of the closest fire hydrant to the property location. fire_hydrant_closest_point_longitude: type: number format: double nullable: true description: Longitude of the closest fire hydrant to the property location. fire_hydrant_point: type: string nullable: true description: >- Geographic point representing the nearest fire hydrant, in WKT format (e.g., POINT (longitude latitude)). fire_station_closest_point_latitude: type: number format: double nullable: true description: Latitude of the closest fire station to the property location. fire_station_closest_point_longitude: type: number format: double nullable: true description: Longitude of the closest fire station to the property location. fire_station_extra_data: allOf: - $ref: '#/components/schemas/FireStationExtraData' nullable: true fire_station_point: type: string nullable: true description: >- Geographic point representing the nearest fire station, in WKT format (e.g., POINT (longitude latitude)). florida_sinkhole_closest_point_latitude: type: number format: double nullable: true description: >- Latitude of the closest known sinkhole in Florida to the property location. florida_sinkhole_closest_point_longitude: type: number format: double nullable: true description: >- Longitude of the closest known sinkhole in Florida to the property location. florida_sinkhole_extra_data: type: object additionalProperties: {} nullable: true description: >- Extra data about the closest Florida sinkhole, including coordinates, event dates, geological characteristics, damage reports, and other sinkhole-specific data. florida_sinkhole_point: type: string nullable: true description: >- Geographic point representing the nearest known sinkhole in Florida, in WKT format (e.g., POINT (longitude latitude)). hail_riskr: type: string nullable: true description: Hail hazard risk rating label. hail_risks: type: number format: double nullable: true description: Hail hazard risk score (national percentile, 0-100). hail_riskv: type: number format: double nullable: true description: Expected annual loss in USD for hail hazards. hrcn_riskr: type: string nullable: true description: Hurricane hazard risk rating label. hrcn_risks: type: number format: double nullable: true description: Hurricane hazard risk score (national percentile, 0-100). hrcn_riskv: type: number format: double nullable: true description: Expected annual loss in USD for hurricane hazards. hwav_riskr: type: string nullable: true description: Heat wave hazard risk rating label. hwav_risks: type: number format: double nullable: true description: Heat wave hazard risk score (national percentile, 0-100). hwav_riskv: type: number format: double nullable: true description: Expected annual loss in USD for heat wave hazards. is_cache_hit: type: boolean nullable: true description: >- Indicates whether the result was served from cache or freshly computed. is_success: type: boolean nullable: true description: Indicates whether the data retrieval was successful or not. istm_riskr: type: string nullable: true description: Ice storm hazard risk rating label. istm_risks: type: number format: double nullable: true description: Ice storm hazard risk score (national percentile, 0-100). istm_riskv: type: number format: double nullable: true description: Expected annual loss in USD for ice storm hazards. larceny_grade: type: string nullable: true description: Crime grade for larceny/theft rate in the area. lnds_riskr: type: string nullable: true description: Landslide hazard risk rating label. lnds_risks: type: number format: double nullable: true description: Landslide hazard risk score (national percentile, 0-100). lnds_riskv: type: number format: double nullable: true description: Expected annual loss in USD for landslide hazards. ltng_riskr: type: string nullable: true description: Lightning hazard risk rating label. ltng_risks: type: number format: double nullable: true description: Lightning hazard risk score (national percentile, 0-100). ltng_riskv: type: number format: double nullable: true description: Expected annual loss in USD for lightning hazards. murder_grade: type: string nullable: true description: Crime grade for murder/homicide rate in the area. persist_for: type: string nullable: true description: >- Duration for which this result should be cached before requiring a fresh fetch. ping_fire_protection_class: type: integer nullable: true description: >- ISO/Ping Fire Protection Class (FPC) score; lower values indicate better fire protection. rape_grade: type: string nullable: true description: Crime grade for rape/sexual assault rate in the area. raw_response: type: object additionalProperties: {} nullable: true description: The unprocessed response data from the datasource. resolution_meters: type: number format: double nullable: true description: >- Size of each grid cell in the underlying risk data, in meters. Smaller values indicate higher spatial resolution. rfld_riskr: type: string nullable: true description: Riverine flood hazard risk rating label. rfld_risks: type: number format: double nullable: true description: Riverine flood hazard risk score (national percentile, 0-100). rfld_riskv: type: number format: double nullable: true description: Expected annual loss in USD for riverine flood hazards. risk_ratng: type: string nullable: true description: Overall risk rating label. risk_score: type: number format: double nullable: true description: >- FEMA's National Risk Index (NRI) composite score for the location, a national percentile indicating relative risk from natural hazards. risk_value: type: number format: double nullable: true description: >- Expected annual loss in USD used to derive the risk_score percentile. robbery_grade: type: string nullable: true description: Crime grade for robbery rate in the area. slosh_zone_category: type: integer nullable: true description: >- The SLOSH (Sea, Lake, and Overland Surges from Hurricanes) storm surge category assigned to this location. slosh_zone_value: type: number format: double nullable: true description: >- Estimated storm surge height in feet for the associated SLOSH category. state: type: string nullable: true description: The U.S. state where the location is found. status_code: type: integer nullable: true description: >- HTTP status code indicating the result of the request. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status for reference. swnd_riskr: type: string nullable: true description: Strong wind hazard risk rating label. swnd_risks: type: number format: double nullable: true description: Strong wind hazard risk score (national percentile, 0-100). swnd_riskv: type: number format: double nullable: true description: Expected annual loss in USD for strong wind hazards. total_crime_grade: type: string nullable: true description: Overall crime grade for the property area. trnd_riskr: type: string nullable: true description: Tornado hazard risk rating label. trnd_risks: type: number format: double nullable: true description: Tornado hazard risk score (national percentile, 0-100). trnd_riskv: type: number format: double nullable: true description: Expected annual loss in USD for tornado hazards. tsun_riskr: type: string nullable: true description: Tsunami hazard risk rating label. tsun_risks: type: number format: double nullable: true description: Tsunami hazard risk score (national percentile, 0-100). tsun_riskv: type: number format: double nullable: true description: Expected annual loss in USD for tsunami hazards. vehicle_theft_grade: type: string nullable: true description: Crime grade for motor vehicle theft rate in the area. vlcn_riskr: type: string nullable: true description: Volcanic activity hazard risk rating label. vlcn_risks: type: number format: double nullable: true description: Volcanic activity hazard risk score (national percentile, 0-100). vlcn_riskv: type: number format: double nullable: true description: Expected annual loss in USD for volcanic activity hazards. wfir_riskr: type: string nullable: true description: Wildfire hazard risk rating label. wfir_risks: type: number format: double nullable: true description: Wildfire hazard risk score (national percentile, 0-100). wfir_riskv: type: number format: double nullable: true description: Expected annual loss in USD for wildfire hazards. wntw_riskr: type: string nullable: true description: Winter weather hazard risk rating label. wntw_risks: type: number format: double nullable: true description: Winter weather hazard risk score (national percentile, 0-100). wntw_riskv: type: number format: double nullable: true description: Expected annual loss in USD for winter weather hazards. worker_name: type: string nullable: true description: Identifier of the worker process that handled this request. FireStationExtraData: type: object properties: address: type: string nullable: true description: Street address of the fire station. city: type: string nullable: true full_address: type: string nullable: true description: Single-line concatenation of address, city, state, and zip. geometry: type: string nullable: true description: WKT POINT geometry for the fire station location. latitude: type: number format: double nullable: true longitude: type: number format: double nullable: true name: type: string nullable: true description: Fire station name. state: type: string nullable: true description: Two-letter U.S. state code. volunteer: type: boolean nullable: true description: True if the station is staffed by volunteers. zip_code: type: string nullable: true securitySchemes: tokenAuth: type: apiKey in: header name: Authorization description: Token-based authentication with required prefix "Token" ````