Search
K
Listing Creation

Listing Creation

1.0.0OAS 3.0

Turns structured property data into a finished listing - as a PDF and as a
web view - and publishes it to the channels you choose.

A listing always references exactly one property from Property
Management. Standalone listings without a property are intentionally
not supported, so mandatory disclosures and history stay maintained in a
single place.

Workflow

  1. POST /listings starts the generation. The response carries status: "in_progress".
  2. Once the document is ready, the status changes to completed. We recommend
    subscribing to the listing.completed event instead of polling.
  3. GET /listings/{listingId}/pdf returns the document.
  4. POST /listings/{listingId}/publish puts it live on the chosen channels.

Mandatory disclosures

Before publication the API checks the disclosures required by law - most
importantly the energy-certificate figures and the commission statement.
If something is missing, the API responds with 422 and
code: "mandatory_disclosure_missing".

API Base URL
  • Server 1:https://api.realestateagency.example/v1

    Production

  • Server 2:https://sandbox.api.realestateagency.example/v1

    Sandbox - data is reset nightly

Security
apiKey (apiKey)

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.

Additional Information
Contact API Support - Real Estate Agency (api-support@realestateagency.example)

For demonstration purposes only License

Listings

Generate, retrieve and publish

List listings

Returns the agency’s listings, optionally filtered by property and status.

get

Query Parameters

property_idstring

Only listings for this property.

Example:prop_8f2c1a

statusstring

Lifecycle of a listing.

Allowed values:in_progresscompletedpublishedwithdrawnfailed

Example:completed

limitinteger

Default:25

>= 1<= 100

cursorstring

Cursor from page.next_cursor of the previous response.

Response

application/json

Results list

dataarray[object]
Show Child Parameters
pageobject

Cursor-based pagination.

Show Child Parameters
get/listings
 
application/json