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

# The vocabulary

> Types, subtypes, fields with their type and unit, amenities, and withdrawn codes. Public, without a key; labels follow `locale`, codes are never translated.



## OpenAPI

````yaml en/openapi.json GET /schema
openapi: 3.1.2
info:
  title: Housera API
  version: 1.0.0
  description: >-
    Publish and manage real estate listings on Housera from your CRM or
    application, with the same rules as the Housera form.
servers:
  - url: https://staging.housera.ro/api/v1
    description: 'Sandbox (staging): test data, the same rules as production.'
  - url: https://housera.ro/api/v1
    description: 'Production: real listings from housera.ro.'
security:
  - bearer: []
tags:
  - name: Your Listings
  - name: Photos
  - name: Events
  - name: Vocabulary
paths:
  /schema:
    get:
      tags:
        - Vocabulary
      summary: The vocabulary
      description: >-
        Types, subtypes, fields with their type and unit, amenities, and
        withdrawn codes. Public, without a key; labels follow `locale`, codes
        are never translated.
      operationId: v1.schema
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Vocabulary'
          description: Successful.
      security: []
components:
  schemas:
    Vocabulary:
      type: object
      title: Vocabulary
      properties:
        locale:
          type: string
          description: The language of the labels in the response.
        version:
          type: string
          description: >-
            The version of the vocabulary's shape. It changes only with an
            incompatible change to the shape; new codes appear without changing
            it.
        types:
          type: array
          items:
            type: object
          description: Property types, with allowed transactions and subtypes of each.
        transactions:
          type: array
          items:
            type: object
          description: >-
            Transactions, with `price_period` (what the price buys) and
            `available` (if the transaction is open now on the platform).
        currencies:
          type: array
          items:
            type: object
          description: The currencies accepted in `price_currency`.
        fields:
          type: object
          description: >-
            Each field of the listing: value type, unit, property types and
            transactions where they exist, allowed values.
        field_types:
          type: array
          items:
            type: object
          description: The types of values used in `fields`.
        units:
          type: array
          items:
            type: object
          description: The units used in `fields`.
        features:
          type: array
          items:
            type: object
          description: >-
            The catalog of amenities, with the group and property types to which
            each applies.
        levels:
          type: object
          description: The level codes, for `floor` and for label `floor` of the pictures.
        street_types:
          type: array
          items:
            type: object
          description: Street types (street, boulevard, road…), as a prefix of the address.
        photo_rooms:
          type: array
          items:
            type: object
          description: The room codes for the labels of the pictures.
        retired:
          type: array
          items:
            type: object
          description: The retired codes and their successors.
      required:
        - locale
        - version
        - types
        - transactions
        - currencies
        - fields
        - field_types
        - units
        - features
        - levels
        - street_types
        - photo_rooms
        - retired
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer <key>'

````

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