onOffice

Consume onOffice API

Actions10

Overview

This node integrates with the onOffice API to perform real estate searches. Specifically, for the Search resource and Estate operation, it allows users to search for real estate listings using either simple keyword-based queries or advanced criteria such as price range, location, estate type, and status.

Common scenarios include:

  • Quickly finding estates matching a keyword (e.g., "garden apartment").
  • Performing detailed filtered searches by specifying minimum/maximum price, city, postal code, estate type (apartment, house, commercial, land), and status (active, sold, reserved).
  • Limiting the number of results returned to manage data volume.

Practical example:

  • A real estate agent wants to find all active apartments in Berlin priced between €200,000 and €500,000. They would use the advanced search criteria to specify these filters and retrieve matching listings.

Properties

Name Meaning
Search Type Type of search to perform:
- Simple: Search with simple keywords
- Advanced: Search with detailed criteria
Keywords Keywords to search for (used only if Search Type is Simple)
Search Criteria Advanced search filters including:
- Minimum Price (number, ≥0)
- Maximum Price (number, ≥0)
- City (string)
- Postal Code (string)
- Estate Type: Apartment, House, Commercial, Land
- Status: Active, Inactive, Sold, Reserved
Limit Maximum number of results to return (minimum 1, default 50)

Output

The node outputs an array of JSON objects representing real estate listings that match the search criteria. Each item contains fields such as:

  • Id
  • kaufpreis (purchase price)
  • warmmiete (warm rent)
  • kaltmiete (cold rent)
  • objektart (object type)
  • objekttyp (object subtype)
  • vermarktungsart (marketing type)
  • wohnflaeche (living area)
  • nutzflaeche (usable area)
  • grundstuecksflaeche (plot area)
  • plz (postal code)
  • ort (city)
  • strasse (street)
  • hausnummer (house number)
  • objekttitel (title)
  • objektnr_extern (external object number)
  • lage (location description)

If no records are found, the raw API response is output instead. The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the onOffice API.
  • The node uses HMAC SHA256 signing for request authentication, requiring both an API token and secret.
  • HTTP POST requests are made to https://api.onoffice.de/api/stable/api.php with JSON payloads.

Troubleshooting

  • No credentials provided: The node will throw an error if the required API authentication token and secret are missing. Ensure credentials are configured properly.
  • Invalid resource or operation: If an unsupported combination of resource and operation is selected, an error is thrown. Verify that "Search" resource and "Estate" operation are chosen correctly.
  • API Error: If the API returns a non-200 status code, the node throws an error with the message from the API. Check API limits, credentials, and request parameters.
  • Empty results: If no estates match the criteria, the node outputs the raw API response. Adjust search filters or increase the limit to get results.
  • Limit value: Setting the limit below 1 may cause errors; ensure it is at least 1.

Links and References

Discussion