Contents
View as Markdown

Account and jobs

3 tools. Generated from the MCP server: names, inputs and prices match the code.

Get Calculation Defaults

Get, per strategy (buy_and_hold, fix_and_flip), the numbers a new calculation of it starts from when properties_create names no search_profile_id: financing (interest_rate, repayment_rate, loan_amount_percentage) and the assumptions, plus default_strategy, the one imports, routines and the search use. Rates and shares are 0-1 fractions. source is user when the person set them, app when these are the app defaults.

Inputs

No inputs.

RESTGET /api/v1/me/calculation-defaults

Update Calculation Defaults

Change the numbers a new calculation of one strategy starts from: calculation_strategy names it, send only the fields to change; is_default true makes it the default strategy. A fix_and_flip entry reuses some buy and hold fields (see each field). Existing calculations keep their numbers. Call calculation_defaults_get first and confirm the change with the person.

Inputs

NameTypeRequiredDescription
interest_ratenumbernoLoan interest rate, a 0-1 fraction (0.042 = 4.2 %).
repayment_ratenumbernoInitial repayment rate, a 0-1 fraction. Stored as 0 for fix_and_flip.
loan_amount_percentagenumbernoLoan as a share of the purchase price, a 0-1.3 fraction (1 = 100 %).
buyhold_building_sharenumbernoBuilding share of the purchase costs for depreciation, a 0-1 fraction.
purchase_price_discountnumbernoExpected discount on the asking price, a 0-1 fraction.
estimated_rent_net_per_sqmnumbernoNet cold rent, EUR per m² and month.
estimated_operating_costs_per_sqmnumbernoOperating costs, EUR per m² and month. fix_and_flip: electricity, EUR per m² and month.
estimated_operating_costs_transferable_per_sqmnumbernoOperating costs passed on to tenants, EUR per m² and month. fix_and_flip: heating, EUR per m² and month.
maintenance_reserve_per_sqmnumbernoMaintenance reserve, EUR per m² and month. fix_and_flip: renovation cost, EUR per m².
imputed_rental_lossnumbernoRent loss allowance, a 0-1 fraction. fix_and_flip: loan processing fee, a 0-1 fraction.
buyhold_estimated_rental_increasenumbernoYearly rent increase, a 0-1 fraction.
buyhold_estimated_market_value_increasenumbernoYearly market value increase, a 0-1 fraction.
buyhold_estimated_cost_increasenumbernoYearly cost increase, a 0-1 fraction.
fixflip_target_selling_price_per_sqmnumbernoFix and flip: target selling price, EUR per m².
fixflip_target_rent_net_per_sqmnumbernoFix and flip: target net cold rent after renovation, EUR per m² and month.
fixflip_project_duration_in_monthsintegernoFix and flip: project duration in months.
fixflip_operating_costs_per_sqmnumbernoFix and flip: operating costs during the project, EUR per m² and month.
calculation_strategystringyesWhich strategy's defaults to change. A fix_and_flip row reuses some buy and hold fields, see each field.Values:buy_and_holdfix_and_flip
is_defaultbooleannotrue makes this the default strategy: the one imports, routines and the search calculate with when nothing else says.

RESTPATCH /api/v1/me/calculation-defaults

Get Job

The one poll for every async job: pass the job_id a tool returned as `id` and call again until status is completed or failed; `progress` shows the stage while it runs, `error` says why it failed. type says which job it is and what `result` holds when completed. expose_extraction (job_id from deals_url_extract / deals_text_extract / deals_document_extract): result.deal_id is the imported deal, turn it into a property with properties_create({ deal_id }). document_processing (job_id from documents_upload, documents_extract, a documents_patch reextract_job_id): result.document_id is the document, read its text and structured extraction with documents_get. due_diligence: read the report with due_diligence_report_get.

Inputs

NameTypeRequiredDescription
idstringyes

RESTGET /api/v1/jobs/{id}