> ## 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. # Fetch Building > Retrieve a specific building. ## OpenAPI ````yaml https://api-staging.sovfixer.com/api/schema/?format=json get /api/v1/building/{item_key} openapi: 3.0.3 info: title: Ping.Extraction API version: v1.0 description: >- ### Ping.Extraction API This API provides an asynchronous method for parsing Excel SOV documents using the Ping Intel SOV Fixer platform. The typical SOV Fixer usage flow is: * POST to `/api/v1/sov` * Poll GET `/api/v1/sov/{id}`, passing the `id` given by the previous response until `response.request.status` is `COMPLETE` or `FAILED`. Depending on load, number of buildings in the SOV, and 3rd party integrations, it may take anywhere from a few seconds to many minutes. * Download the parsed SOV 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`. API Usage Examples: [Python](/api/v1/sov-api-usage-example.py) | [.NET](/api/v1/sov-api-usage-example.cs) Client Libraries: [Python](https://pypi.org/project/pingintel-api/) #### Authorization Most endpoints are protected by Bearer authentication. Under each endpoint listed below, click into the `authorizations` section to see what is required for that endpoint. #### Output JSON Example: ```json { "id": "s-e-xxxxxxx", "source_filename": "My Example SOV.xls", "num_buildings": 26, "extra_data": { "insured_name": "Joe Insured", "... custom document-level data fields ...": "" }, "buildings": [ { "item_key": "i-s-e-xxxxxxx!Original SOV Sheet!7", "building_counter": 1, "sheet_name": "Original SOV Sheet", "sheet_row_number": 7, "parsing_sheet_name": "Original SOV Sheet", "location_code": { "value": "A-1", "confidence": 0.5, "comment": "Adjusted." }, "bldg_name": { "value": "Elementary School", "confidence": 0.7 }, "street": { "value": "1212 Mockingbird Lane", "confidence": 0.7 }, "city": { "value": "Tewksbury", "confidence": 0.5 }, "state": { "original": "Mass", "value": "MA", "confidence": 0.9 }, "zip": { "value": "01876", "original": 1876, "confidence": 0, "comment": "Please check." }, "... more building attributes ...": "", "external_data": { "PG": { "latitude": 42.6109, "longitude": -71.2342, "confidence": 0.9, "street": "1212 Mockingbird Ln", "city": "Tewksbury", "... rest of the data from the Ping Geocoding (PG) external data source ...": "" }, "... any other requested third party data sources ...": "" }, "extra": { "... columns that were not identified as a standard SOV field ...": "", "Unidentified Column": "123213", "Another Unidentified Column": "abc" } }, "... additional buildings ...": "" ] } ``` Complete JSON reference documentation can be found for each output type: [SOV](/docs/data/SOV/) | [Premium BDX](/docs/data/PREM_BDX/) | [Claim BDX](/docs/data/CLAIM_BDX/). Some notes about specific JSON output fields: * `limits__total_limit`: Contains the TIV if explicitly specified in the SOV. If not, it is summed from the fields `limits__building_limit` + `limits__bpp_limit` + `limits__bi_limit` + `limits__signs_and_other_limit`. * `limits__building_limit`: Building Limit is an aggregate of: * `limits__building_value` * `limits__location_limit` * `limits__blanket_limit` * `limits__building_only_limit` * `limits__real_property_limit` * `limits__structure_limit` * `limits__bpp_limit`: Business Personal Property (Contents) Limit is an aggregate of: * `limits__contents_value` * `limits__contents_limit` * `limits__bpp_value` * `limits__equip_limit` * `limits__personal_property_limit` * Any field identified as a limit field but not otherwise categorized. * `limits__bi_limit`: Business Interruption Limit is an aggregate of: * `limits__bi_value` * `limits__bi_income_limit` * `limits__business_interruption_limit` * `limits__time_element_limit` * `limits__signs_and_other_limit`: Signs and Other Structures Limit is an aggregate of: * `limits__signs_limit` * `limits__other_structures_limit` ### Ping Intel SOV History API This API provides a method for accessing historical SOV submissions including their revisions (SOV Updates) and the raw parsed output. The typical usage workflow is: * GET to `api/v1/sov/history?start={start_timestamp}` for a list of SOVIDs submitted between `start_timestamp` and now. * For each sovid: * GET to `api/v1/sov/history/{id}` to get information about the SOV or SOV Update. This includes any output we produced in servicing the request * GET to the the URL in the outputs dict to download the resource you need. contact: email: support@pingintel.com name: Ping Intel url: https://www.pingintel.com servers: - url: https://api.sovfixer.com description: Ping.Extraction API - url: https://api-staging.sovfixer.com description: Ping.Extraction API (staging) security: [] paths: /api/v1/building/{item_key}: get: tags: - Get SOV Data summary: Fetch Building description: Retrieve a specific building. operationId: building_retrieve parameters: - in: path name: item_key schema: type: string description: >- A unique identifier for the building. e.g. `i-s-ga-ping-xxxxxx!SOV!1` required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BuildingResponse' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/BuildingError403' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/BuildingError404' description: '' security: - tokenAuth: [] - cookieAuth: [] components: schemas: BuildingResponse: type: object properties: building_counter: type: integer description: Counter for the number of buildings. data: allOf: - $ref: '#/components/schemas/BuildingData' description: Data related to the building. external_data: allOf: - $ref: '#/components/schemas/BuildingExternalData' description: External data related to the building. integration_messages: allOf: - $ref: '#/components/schemas/IntegrationMessages' description: Messages related to the integration of data sources. integration_results: allOf: - $ref: '#/components/schemas/IntegrationResults' description: Results of data integration from various sources. item_key: type: string description: Unique key identifying the item. orig: allOf: - $ref: '#/components/schemas/OriginalData' description: Original data submitted. Cell-by-cell basis. parsing_sheet_name: type: string description: Name of the parsing sheet. parsing_sheet_row_number: type: integer description: Row number on the parsing sheet. ping_pli_url: type: string format: uri description: URL for ping PLI (Public Land Information). ping_viewer_url: type: string format: uri description: URL for the ping viewer. reliability: allOf: - $ref: '#/components/schemas/Reliability' description: Reliability metrics for the data. revision: type: integer description: Revision number of the building information. sheet_name: type: string description: Name of the sheet. sheet_row_number: type: integer description: Row number on the sheet. zones: allOf: - $ref: '#/components/schemas/Zoning' description: Zoning information for the building. required: - building_counter - data - external_data - integration_messages - integration_results - item_key - orig - parsing_sheet_name - parsing_sheet_row_number - ping_pli_url - ping_viewer_url - reliability - revision - sheet_name - sheet_row_number - zones BuildingError403: type: object properties: detail: type: string default: Invalid Token BuildingError404: type: object properties: detail: type: string default: Not Found BuildingData: type: object properties: : allOf: - $ref: '#/components/schemas/BuildingProperty' description: Country information. required: - BuildingExternalData: type: object properties: DTC: allOf: - $ref: '#/components/schemas/DistanceToCoastData' description: Data from the Ping Distance To Coast data source. DTFST: allOf: - $ref: '#/components/schemas/DistanceToFireStationData' description: Data from the Distance To Florida Sinkhole data source. LBFZ: allOf: - $ref: '#/components/schemas/LightboxFloodZoneData' description: Data from the Lightbox flood zone data source. PG|GG|EG|LBG|SM: allOf: - $ref: '#/components/schemas/GeocodingData' description: >- Data from a geocoding data source. (PG - Ping Geocoding, GG - Google Geocoding, EG - Esri Geocoding, LBG - Lightbox Geocoding, SM - Smarty Street Address) PO: allOf: - $ref: '#/components/schemas/PingOccupancyData' description: Data from the Ping Occupancy data source. RZR: allOf: - $ref: '#/components/schemas/RedzoneData' description: Data from the Redzone data source. T4D: allOf: - $ref: '#/components/schemas/Teren4dData' description: Data from the Teren4d data source. required: - DTC - DTFST - LBFZ - PG|GG|EG|LBG|SM - PO - RZR - T4D IntegrationMessages: type: object properties: : type: string description: Additional information about the integration from source. required: - IntegrationResults: type: object properties: : type: string description: >- Status of the integration from source. Options are the follow A (About to request), N (Not requested), C (Locally cached), R (Requested), G (Locally cached failure), F (Failed), S (Skipped). required: - OriginalData: type: object properties: : allOf: - $ref: '#/components/schemas/CellData' description: Information related to . required: - Reliability: type: object properties: Limit: type: string description: Reliability limit. Overall: type: string description: Overall reliability rating. required: - Limit - Overall Zoning: type: object properties: EQ: type: string description: Zoning information for EQ (e.g., 'AllOther'). HU: type: string description: Zoning information for HU (e.g., 'Tier1'). IF: type: string description: Zoning information for IF (e.g., 'AllOther'). SCS: type: string description: Zoning information for SCS (e.g., 'AllOther'). TE: type: string description: Zoning information for TE (e.g., 'AllOther'). WF: type: string description: Zoning information for WF (e.g., 'AllOther'). required: - EQ - HU - IF - SCS - TE - WF BuildingProperty: type: object properties: comment: type: string description: Additional comments about the data. confidence: type: number format: double description: Confidence level in the data. original: type: string description: Original value of the data. source: type: array items: $ref: '#/components/schemas/BuildingSource' description: Sources for the data. units: type: string nullable: true description: Unit of measurement for the data. value: type: string description: The value of the data. required: - comment - confidence - original - source - units - value DistanceToCoastData: type: object properties: closest_point_latitude: type: number format: double description: Latitude of the closest point to the coast. closest_point_longitude: type: number format: double description: Longitude of the closest point to the coast. confidence: type: number format: double nullable: true description: Confidence level of the data (nullable). connected_lines: type: array items: type: string description: List of connected lines. distance_to_coast_feet: type: number format: double description: Distance to the coast in feet. distance_to_coast_miles: type: number format: double description: Distance to the coast in miles. status_code: type: integer description: The status code of the data. required: - closest_point_latitude - closest_point_longitude - confidence - connected_lines - distance_to_coast_feet - distance_to_coast_miles - status_code DistanceToFireStationData: type: object properties: closest_point_latitude: type: number format: double description: Latitude of the closest point. closest_point_longitude: type: number format: double description: Longitude of the closest point. confidence: type: number format: double nullable: true description: Confidence level of the data (nullable). distance_to_fire_station_feet: type: number format: double description: Distance to the nearest fire station in feet. extra_data: allOf: - $ref: '#/components/schemas/FireStationExtraData' description: Additional data associated with the fire station. point: type: string description: Geographical point in 'POINT (longitude latitude)' format. status_code: type: integer description: The status code of the data. required: - closest_point_latitude - closest_point_longitude - confidence - distance_to_fire_station_feet - extra_data - point - status_code LightboxFloodZoneData: type: object properties: address_line_1: type: string nullable: true description: First line of the address (nullable). all_zones: type: array items: type: string description: List of all zones. city: type: string nullable: true description: City name (nullable). confidence: type: number format: double description: Confidence level of the data. country: type: string nullable: true description: Country name (nullable). dfirm_id: type: string description: DFIRM ID. effective_date: type: string description: Effective date of the data. fips_code: type: string description: FIPS code. is_in_100_year: type: boolean description: Indicates if in 100-year flood zone. is_sfha: type: boolean description: Indicates if in Special Flood Hazard Area. latitude: type: number format: double description: Latitude coordinate. longitude: type: number format: double description: Longitude coordinate. panel_effective_date: type: string description: Panel's effective date. panel_firm_id: type: string description: Panel firm ID. panel_id: type: string description: Panel ID. panel_source_citation: type: string description: Panel's source citation. parcel_id: type: string nullable: true description: Parcel ID (nullable). postal_code: type: string nullable: true description: Postal code (nullable). postal_code_ext: type: string nullable: true description: Extended postal code (nullable). precision_code: type: string nullable: true description: Precision code (nullable). source_citation: type: string nullable: true description: Source citation (nullable). state: type: string nullable: true description: State name (nullable). status_code: type: integer description: The status code of the data. study_type: type: string nullable: true description: Study type (nullable). zone: type: string description: Zone identifier. required: - address_line_1 - all_zones - city - confidence - country - dfirm_id - effective_date - fips_code - is_in_100_year - is_sfha - latitude - longitude - panel_effective_date - panel_firm_id - panel_id - panel_source_citation - parcel_id - postal_code - postal_code_ext - precision_code - source_citation - state - status_code - study_type - zone GeocodingData: type: object properties: address_line_1: type: string description: The first line of the address. address_line_2: type: string description: The second line of the address. city: type: string description: The city where the address is located. confidence: type: integer description: The confidence level of the address data. consulted_datasources: type: array items: type: string description: List of consulted data sources. (PG only) country: type: string description: The country where the address is located. county: type: string description: The county where the address is located. formatted_address: type: string description: The formatted address. latitude: type: number format: double description: The latitude coordinate of the address. location_type: type: string description: The location type of the address. longitude: type: number format: double description: The longitude coordinate of the address. postal_code: type: string description: The postal code of the address. precision: type: integer description: The precision of the address data. route: type: string description: The route or street name. source_desc: type: string description: Description of the data source. state: type: string description: The state where the address is located. status_code: type: integer description: The status code of the address data. street_number: type: string description: The street number of the address. required: - address_line_1 - address_line_2 - city - confidence - consulted_datasources - country - county - formatted_address - latitude - location_type - longitude - postal_code - precision - route - source_desc - state - status_code - street_number PingOccupancyData: type: object properties: confidence: type: number format: double nullable: true description: Confidence level of the data (nullable). occupancy_type: type: string description: The type of occupancy (e.g., Residential - Apartments/Condominiums). occupancy_type_probability: type: number format: double description: The probability associated with the occupancy type. status_code: type: integer description: The status code of the data. required: - confidence - occupancy_type - occupancy_type_probability - status_code RedzoneData: type: object properties: confidence: type: number format: double nullable: true description: Confidence level of the data (nullable). dist_to_higher_hazard: type: number format: double nullable: true description: Distance to higher hazard area (nullable). fire_history_data: type: array items: $ref: '#/components/schemas/FireHistory' description: Array of fire history data. fire_station_prox_class: type: string description: Fire station proximity classification. fire_station_prox_score: type: integer description: Fire station proximity score. frequency_class: type: string description: Frequency classification. frequency_score: type: integer description: Frequency score. job_id: type: number format: double nullable: true description: Job identifier (nullable). large_fire_class: type: string nullable: true description: Class for large fires (nullable). large_fire_score: type: number format: double nullable: true description: Score for large fires (nullable). latitude: type: string description: Latitude coordinate. longitude: type: string description: Longitude coordinate. loss_type: type: string nullable: true description: Type of loss (nullable). map_image_overall: type: string nullable: true description: Overall map image (nullable). map_image_satellite: type: string nullable: true description: Satellite map image (nullable). model_type: type: string description: Type of model used. overall_class: type: string description: Overall classification of the data. overall_score: type: integer description: Overall score. past_fire_class: type: string description: Past fire classification. past_fire_score: type: integer description: Past fire score. redzone_uid: type: integer description: Unique identifier for the redzone. severity_class: type: string description: Severity classification. severity_score: type: integer description: Severity score. status_code: type: integer description: The status code of the data. required: - confidence - dist_to_higher_hazard - fire_history_data - fire_station_prox_class - fire_station_prox_score - frequency_class - frequency_score - job_id - large_fire_class - large_fire_score - latitude - longitude - loss_type - map_image_overall - map_image_satellite - model_type - overall_class - overall_score - past_fire_class - past_fire_score - redzone_uid - severity_class - severity_score - status_code Teren4dData: type: object properties: climate_average_class: type: integer description: Average climate classification. climate_evapotranspiration_class: type: integer description: Climate evapotranspiration classification. climate_percipitation_annual_class: type: integer description: Annual climate precipitation classification. climate_percipitation_summer_class: type: integer description: Summer climate precipitation classification. climate_temperature_class: type: integer description: Climate temperature classification. climate_vapor_pressure_deficit_class: type: integer description: Climate vapor pressure deficit classification. climate_wind_class: type: integer description: Climate wind classification. confidence: type: number format: double nullable: true description: Confidence level of the data (nullable). fuels_average_class: type: integer description: Average class of fuels. fuels_fuel_height_class: type: integer description: Fuel height classification for fuels. fuels_land_use_class: type: integer description: Land use classification for fuels. latitude: type: number format: double description: Latitude coordinate. longitude: type: number format: double description: Longitude coordinate. status_code: type: integer description: The status code of the data. topography_average_class: type: integer description: Average topography classification. topography_curvature_class: type: integer description: Topography curvature classification. topography_elevation_class: type: integer description: Topography elevation classification. topography_slope_class: type: integer description: Topography slope classification. topography_soil_moisture_class: type: integer description: Topography soil moisture classification. topography_solar_factor_class: type: integer description: Topography solar factor classification. topography_wetness_class: type: integer description: Topography wetness classification. wildfire_hazard_score: type: integer description: Wildfire hazard score. required: - climate_average_class - climate_evapotranspiration_class - climate_percipitation_annual_class - climate_percipitation_summer_class - climate_temperature_class - climate_vapor_pressure_deficit_class - climate_wind_class - confidence - fuels_average_class - fuels_fuel_height_class - fuels_land_use_class - latitude - longitude - status_code - topography_average_class - topography_curvature_class - topography_elevation_class - topography_slope_class - topography_soil_moisture_class - topography_solar_factor_class - topography_wetness_class - wildfire_hazard_score CellData: type: object properties: fmt: type: string description: Format of the value (e.g., 'mm/dd/yyyy'). formula: type: string nullable: true description: A formula associated with the data (nullable). label: type: string description: The label or description (e.g., 'Named Insured'). val: type: string description: The value (e.g., 'The Metropolitan Condominium Association'). required: - fmt - formula - label - val BuildingSource: type: object properties: cell: type: string description: Cell reference in the source data. external: type: string description: External source reference. required: - cell - external FireStationExtraData: type: object properties: address: type: string description: Address of the fire station. addressbuildingname: type: string nullable: true description: Building name of the address (nullable). admintype: type: string description: Admin type. city: type: string description: City name. complex_id: type: string nullable: true description: Complex ID (nullable). data_security: type: string description: Data security level. distribution_policy: type: string description: Distribution policy. fcode: type: string description: Fire station code. foot_id: type: string nullable: true description: Foot ID (nullable). ftype: type: string description: Type of fire station. globalid: type: string description: Global ID. gnis_id: type: string description: GNIS ID. islandmark: type: string description: Island mark. loaddate: type: string description: Data load date. name: type: string description: Name of the fire station. objectid: type: string description: Object ID. permanent_identifier: type: string description: Permanent identifier. pointlocationtype: type: string description: Point location type. source_datadesc: type: string description: Description of data source. source_datasetid: type: string description: Dataset ID of the source. source_featureid: type: string nullable: true description: Feature ID of the source (nullable). source_originator: type: string description: Originator of the source data. state: type: string description: State. zipcode: type: string description: Zipcode. required: - address - addressbuildingname - admintype - city - complex_id - data_security - distribution_policy - fcode - foot_id - ftype - globalid - gnis_id - islandmark - loaddate - name - objectid - permanent_identifier - pointlocationtype - source_datadesc - source_datasetid - source_featureid - source_originator - state - zipcode FireHistory: type: object properties: acres: type: number format: double description: Size of the fire in acres. dist: type: number format: double description: Distance of the fire. firename: type: string description: Name of the fire. fireyear: type: integer description: Year of the fire. required: - acres - dist - firename - fireyear securitySchemes: tokenAuth: type: apiKey in: header name: Authorization description: Token-based authentication with required prefix "Token" cookieAuth: type: apiKey in: cookie name: sessionid ````