> ## 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.

# Property energy labels

> Read source-reported energy labels from your saved listing observation. Values are unverified source statements; no source refresh or independently verified energy certificate. Missing data is unavailable.

Read energy labels and explicit numeric observations actually retained with a supported source listing. EPC, DPE, GES, BER and other source labels keep their own rating system and literal class, including BER numeric suffixes and source letter case. Unknown measurement units and issue dates remain null. These are unverified source observations, not independently checked certificates.

One credit per successful retained read, with no source request or retention renewal. Missing sections return SOURCE\_DATA\_UNAVAILABLE; malformed retained data is rejected. Preserve each entry’s source and observation time. Documentation-backed mappings have offline contract evidence without new live acceptance.


## OpenAPI

````yaml GET /v1/listings/{listing_id}/energy
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}/energy:
    get:
      tags:
        - listings
      summary: Property energy labels
      description: >-
        Read source-reported energy labels from your saved listing observation.
        Values are unverified source statements; no source refresh or
        independently verified energy certificate. Missing data is unavailable.
      operationId: getListingEnergy
      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/getListingEnergyResponse'
            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:
    getListingEnergyResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ListingEnergy'
        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
    ListingEnergy:
      type: object
      properties:
        certificates:
          type: array
          minItems: 1
          maxItems: 20
          items:
            $ref: '#/components/schemas/ListingEnergyCertificate'
        origin:
          const: source_reported
        completeness:
          const: unknown
        source:
          $ref: '#/components/schemas/Source'
      required:
        - certificates
        - 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
    ListingEnergyCertificate:
      type: object
      properties:
        kind:
          type: string
          enum:
            - epc
            - dpe
            - ges
            - ber
            - source_energy_label
        rating:
          anyOf:
            - type: string
              maxLength: 80
            - type: 'null'
        value:
          anyOf:
            - type: number
              minimum: 0
              maximum: 1000000
            - type: 'null'
        unit:
          anyOf:
            - const: kWh/m2
            - type: 'null'
        issued_at:
          type: 'null'
        source:
          $ref: '#/components/schemas/Source'
      required:
        - kind
        - rating
        - value
        - unit
        - issued_at
        - source
      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.