---
title: "Get rent index values"
url: "https://real-estate-agency.apim.eu/apis/market-valuation/versions/3b18507e-d857-48a4-a3bc-b79b2eb2cfa4/operations/getRentIndex"
---

> Full API specification: https://real-estate-agency.apim.eu/apis/market-valuation/versions/3b18507e-d857-48a4-a3bc-b79b2eb2cfa4.md

# Get rent index values

`GET` `/rent-index`

Operation ID: `getRentIndex`

Typical comparable rent for the area, based on aggregated market rent data.

## Query parameters

- `postal_code` (string, required)
- `living_area_sqm` (number, float, required)
- `year_built` (integer, optional)

## Responses

- `200` - Rent index values
- `404` - Record not found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Market Valuation
  version: 1.0.0
servers:
  - url: https://api.realestateagency.example/v1
    description: Production
  - url: https://sandbox.api.realestateagency.example/v1
    description: Sandbox
paths:
  /rent-index:
    get:
      tags:
        - Rent Index
      summary: Get rent index values
      description: Typical comparable rent for the area, based on aggregated market
        rent data.
      operationId: getRentIndex
      parameters:
        - name: postal_code
          in: query
          required: true
          schema:
            type: string
            example: "10001"
        - name: living_area_sqm
          in: query
          required: true
          schema:
            type: number
            format: float
            example: 86.5
        - name: year_built
          in: query
          schema:
            type: integer
            example: 1908
      responses:
        "200":
          description: Rent index values
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RentIndexValue"
              example:
                city: Springfield
                as_of: 2025-01-01
                net_rent_per_sqm_eur:
                  low: 9.4
                  average: 11.8
                  high: 14.6
                range_note: Values apply to a typical residential location without adjustments.
        "404":
          $ref: "#/components/responses/NotFound"
security:
  - apiKey: []
components:
  schemas:
    RentIndexValue:
      type: object
      properties:
        city:
          type: string
          example: Springfield
        as_of:
          type: string
          format: date
          example: 2025-01-01
        net_rent_per_sqm_eur:
          type: object
          properties:
            low:
              type: number
              format: float
              example: 9.4
            average:
              type: number
              format: float
              example: 11.8
            high:
              type: number
              format: float
              example: 14.6
        range_note:
          type: string
          example: Values apply to a typical residential location without adjustments.
    Error:
      type: object
      description: Uniform error format across all Real Estate Agency APIs.
      required:
        - code
        - message
      properties:
        code:
          type: string
          example: validation_failed
        message:
          type: string
          example: Too few comparable sales are available for this location.
        details:
          type: array
          items:
            $ref: "#/components/schemas/ErrorDetail"
    ErrorDetail:
      type: object
      properties:
        field:
          type: string
          example: basis.comparables_count
        reason:
          type: string
          example: missing
  responses:
    NotFound:
      description: Record not found
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: |
        Every call carries an API key in the `apikey` header. You generate the
        key in the Real Estate portal under "My Apps"; it's shown exactly once.

        Each key has the scopes it's allowed to use attached to it. If one is
        missing, the API responds with `403` and `code: "scope_missing"`; the
        missing scope is in `details[].field`.
```