Deals

Dismiss Deals

Hide deals from this user's searches: deals_search, search_profiles_run and the search-profile mails leave them out from now on, and so does the Leverage app, where the same list is called "Kein Interesse". Use it for listings the user rejected, so a daily search stops showing them. Takes deal_id values from deals_search. A dismissed deal is also removed from the user's saved deals. Undo with deals_restore. Free.

RESTPOST /api/v1/deals/dismiss

Extract Deal from Document

Upload a document (base64) for deal extraction (same limits as documents_upload). Optional persist_listing (default true), extract_document_figures (default true). Returns job_id with `progress` while running; poll jobs_get. Resubmitting an identical file may return status completed immediately with deal_id and document_id. To turn the deal into a property, call properties_create({ deal_id }). Costs 2 API credits.

RESTPOST /api/v1/deals/extract/document/jobs

Restore Dismissed Deals

Undo deals_dismiss: the deals show up in searches again. Returns the ids that were dismissed and are restored now; an id that was not dismissed is skipped. A deal the dismissal took out of the saved deals stays unsaved. Free.

RESTPOST /api/v1/deals/restore

Search Deals

Geo search active deals. A new query costs 1 API credit; page on with next_cursor, free within an hour of the paid first page (a page without one pays like a new query); count_only is free. Filtering or sorting on a market value or on cashflow or return on equity (the market criteria, rental_yield_gross_market, cashflow_year_one_min, return_on_equity_year_one_min and their order_by keys, also through the profile) needs a plan that shows market values; otherwise the call answers plan_upgrade_required, unless drop_gated_criteria leaves them out. Location takes coordinates, a postcode, a city name, a structured address, free text, or `area` (one or more drawn areas as a GeoJSON MultiPolygon); no need to geocode first ('Zurich'/'Zürich', Swiss 4-digit postcodes and 'Gerechtigkeitsgasse 19, 8001 Zürich' all resolve); radius_km defaults to 10. The response echoes resolved_location (precision address|street|postcode|city|area, label, source) and warnings: check precision before calling a hit exact. criteria takes any check of the search-profile check catalog as {check_type, threshold, params}, percentages as 0-1 fractions: price, area, rooms, units, year built, condition, energy class, exclusions, amenities, market comparisons and the modelled year-one metrics (yield, cashflow, return on equity, factor, fix-and-flip margins). sale_price, living_area, land_area, number_of_rooms, number_of_units, rental_yield_gross_actual (the year-one yield floor), rental_yield_gross_market and purchase_price_factor (a ceiling) are shorthands for eight of them. property_types is a list; empty is every type. Exclusions and the energy class bound keep listings that never stated the fact, so a hit does not prove the fact is absent: when one is a hard knock-out, check the listing itself. Every requirement, range and metric floor drops a listing whose fact is unknown. Pass search_profile_id (search_profiles_list) to add every check of a saved search profile: a check set on both sides keeps the stricter bound, property_types is yours when non-empty (else the profile's), and its assumptions model the metrics. Criteria that exclude each other return no items and a criteria_conflict warning naming the fields; a metric criterion the search cannot model (a fix-and-flip margin without a fix_and_flip profile) carries a criteria_unmodelled warning. The modelled metrics (rental_yield_gross_year_one, cashflow_monthly, return_on_equity_year_one, purchase_price_factor, and with a fix-and-flip profile fixflip_profit, fixflip_margin_pct, the best-case pair and total_investment_costs_per_sqm) are year one of the property created from the listing with the profile's assumptions, else the user's defaults; they need a stated rent. rental_yield_gross_actual (IST) is non-null only where a source read the rent off the listing, rental_yield_gross_market (SOLL) comes from the market rent estimate. market_discount_pct is positive when the asking price is below the market value median. Every metric is an order_by key; desc is the highest first, rows without the metric sort last. Set include_total for a capped approximate total. count_only: true sizes a search without running it ('how many are there in X?'): it returns count, capped, resolved_location and warnings, no items. The count is capped at 1000, so capped=true means 'over 1000'; it is a close upper bound that does not subtract listings a liveness re-check drops or deals the user dismissed. Deals dismissed with deals_dismiss (or marked 'Kein Interesse' in the app) never appear in items. Criteria that read listing prose (condition, tenancy, the legal exclusions, building year, unit count, rent and costs) also start a background extraction for the listings returned, so the next search filters on more of them.

RESTPOST /api/v1/deals/searchcount_only is its own route: POST /api/v1/deals/search/count.

Extract Deal from Text

Submit raw text/HTML for deal extraction. Returns job_id; poll jobs_get until completed; the result contains deal_id when successful. To turn the deal into a property, call properties_create({ deal_id }). Costs 1 API credit.

RESTPOST /api/v1/deals/extract/text/jobs

Extract Deal from URL

Extract a deal from a listing link (ImmoScout24, Immowelt, Kleinanzeigen and other public listing pages): Leverage fetches the page, so pass the URL instead of copying the listing text. Returns job_id; poll jobs_get until completed; the result contains deal_id. To turn the deal into a property, call properties_create({ deal_id }). A page that cannot be fetched or has no text fails at once with page_scrape_failed or page_content_empty and costs nothing: then send the listing text to deals_text_extract. Inside a routine only ImmoScout24, Immowelt, Immonet, Kleinanzeigen and Wohnungsbörse pages are fetched; another host fails with 403 url_not_a_listing_portal. Costs 2 API credits; a page the model judges not to be a listing fails the job and is charged.

RESTPOST /api/v1/deals/extract/url/jobs