> ## Documentation Index
> Fetch the complete documentation index at: https://realtycrawl.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Flooding and planning context

> Read literal source flooding and planning codes from your saved observation. No verified hazard, insurance, legal-use or planning determination. Missing data is unavailable.

Read Zimmo’s literal flood and planning codes from your account’s saved observation. Each entry preserves its source type, reported status and any source destination code. verification remains source\_reported\_unverified.

This is not an official hazard map, insurance assessment, legal opinion or permission to develop. A cadastral-income figure belongs to property facts and is not a tax bill. One credit per successful retained read; no fresh source request or retention renewal. Missing sections return SOURCE\_DATA\_UNAVAILABLE.


## OpenAPI

````yaml GET /v1/listings/{listing_id}/risk
openapi: 3.1.0
info:
  title: RealtyCrawl API
  version: 0.1.0
  description: >-
    Unified real estate API with source-specific operations, markets and access
    requirements. Check current capabilities before source requests.
    Documentation-backed beta contracts require explicit configuration and do
    not establish fresh live source acceptance.
servers:
  - url: https://realtycrawl.dev
security:
  - ApiKeyAuth: []
externalDocs:
  url: https://realtycrawl.dev/docs
paths:
  /v1/listings/{listing_id}/risk:
    get:
      tags:
        - listings
      summary: Flooding and planning context
      description: >-
        Read literal source flooding and planning codes from your saved
        observation. No verified hazard, insurance, legal-use or planning
        determination. Missing data is unavailable.
      operationId: getListingRisk
      parameters:
        - name: listing_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: fields
          in: query
          description: >-
            Response-only comma-separated field paths relative to data items; up
            to 32 paths. Source requests and billing are unchanged.
          schema:
            type: string
            maxLength: 4127
        - name: format
          in: query
          description: >-
            Response-only export format. JSON retains the envelope; CSV/NDJSON
            contain data records, with request/credit metadata in headers.
            Errors stay JSON.
          schema:
            type: string
            enum:
              - json
              - csv
              - ndjson
            default: json
      responses:
        '200':
          description: Source observation; inspect meta for evidence and completeness.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getListingRiskResponse'
            text/csv:
              schema:
                type: string
                description: Data rows only; request, row count and credits are in headers.
            application/x-ndjson:
              schema:
                type: string
                description: One JSON data item per line; metadata is in headers.
        default:
          description: Typed error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    getListingRiskResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ListingRisk'
        meta:
          $ref: '#/components/schemas/Meta'
      required:
        - data
        - meta
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            details:
              type: array
              items:
                $ref: '#/components/schemas/SourceOutcome'
          required:
            - code
            - message
            - retryable
          additionalProperties: false
        request_id:
          type: string
      required:
        - error
        - request_id
      additionalProperties: false
    ListingRisk:
      type: object
      properties:
        flooding:
          type: array
          maxItems: 50
          items:
            type: object
            properties:
              source_type:
                type: string
                maxLength: 100
              source_status:
                type: string
                maxLength: 100
              source:
                $ref: '#/components/schemas/Source'
            required:
              - source_type
              - source_status
              - source
            additionalProperties: false
        planning:
          type: array
          maxItems: 50
          items:
            type: object
            properties:
              source_type:
                type: string
                maxLength: 100
              source_status:
                anyOf:
                  - type: string
                    maxLength: 100
                  - type: 'null'
              source_destination:
                anyOf:
                  - type: string
                    maxLength: 100
                  - type: 'null'
              source:
                $ref: '#/components/schemas/Source'
            required:
              - source_type
              - source_status
              - source_destination
              - source
            additionalProperties: false
        verification:
          const: source_reported_unverified
        origin:
          const: source_reported
        completeness:
          const: unknown
        source:
          $ref: '#/components/schemas/Source'
      required:
        - flooding
        - planning
        - verification
        - origin
        - completeness
        - source
      additionalProperties: false
    Meta:
      type: object
      properties:
        request_id:
          type: string
        schema_version:
          type: string
        generated_at:
          type: string
          format: date-time
        completeness:
          type: string
          enum:
            - complete
            - partial
            - unknown
        sources:
          type: array
          items:
            $ref: '#/components/schemas/SourceOutcome'
        warnings:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              message:
                type: string
              field:
                type: string
            required:
              - code
              - message
            additionalProperties: false
        pagination:
          type: object
          properties:
            next_cursor:
              anyOf:
                - type: string
                - type: 'null'
            has_more:
              type: boolean
            returned:
              type: integer
            total:
              anyOf:
                - type: integer
                - type: 'null'
            total_relation:
              type: string
              enum:
                - exact
                - lower_bound
                - unknown
          required:
            - next_cursor
            - has_more
            - returned
            - total
            - total_relation
          additionalProperties: false
        property_groups:
          type: array
          items:
            $ref: '#/components/schemas/PropertyGroup'
      required:
        - request_id
        - schema_version
        - generated_at
        - completeness
        - sources
      additionalProperties: false
    SourceOutcome:
      type: object
      properties:
        platform:
          type: string
        provider:
          anyOf:
            - type: string
            - type: 'null'
        status:
          type: string
          enum:
            - success
            - partial
            - failed
            - unsupported
        error_code:
          anyOf:
            - type: string
            - type: 'null'
        truncated:
          type: boolean
        observed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
      required:
        - platform
        - status
      additionalProperties: false
    Source:
      type: object
      properties:
        platform:
          type: string
        country:
          type: string
        native_id:
          anyOf:
            - type: string
            - type: 'null'
        url:
          anyOf:
            - type: string
              format: uri
            - type: 'null'
        provider:
          type: string
        observed_at:
          type: string
          format: date-time
        source_updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        access_class:
          type: string
          enum:
            - public_portal
            - licensed_feed
            - public_record
            - modeled
        retrieved_at:
          type: string
          format: date-time
      required:
        - platform
        - provider
        - observed_at
        - access_class
      additionalProperties: false
    PropertyGroup:
      type: object
      properties:
        property_id:
          anyOf:
            - type: string
            - type: 'null'
        listing_ids:
          type: array
          items:
            type: string
        match_method:
          type: string
        confidence:
          anyOf:
            - type: number
            - type: 'null'
        status:
          type: string
          enum:
            - matched
            - ambiguous
      required:
        - property_id
        - listing_ids
        - match_method
        - status
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.