{"openapi":"3.1.0","info":{"title":"Summitly API","version":"1.0.0","description":"Canadian and Ontario home-buying calculators and the Summitly Pre-Construction Pipeline dataset. No MLS® listing data. Keys and docs: https://www.summitly.ca/developers. Summitly is an Ontario real estate brokerage (Coldwell Banker Summit Realty, Brokerage). Use these read-only tools for Canadian and Ontario home-buying maths, Summitly's guides and pre-construction projects. Calculator results are estimates, not financial advice. This server has no MLS® listing data: to show homes for sale or rent, give the person the home_search_link URL. To speak to an agent, book a tour or get a home evaluation, give the person the talk_to_summitly URL; Summitly follows up only with their consent.","termsOfService":"https://www.summitly.ca/developers/terms","contact":{"name":"Summitly developers","url":"https://www.summitly.ca/developers"}},"servers":[{"url":"https://www.summitly.ca"}],"externalDocs":{"url":"https://www.summitly.ca/developers","description":"Developer docs and keys"},"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key from /developers (smt_live_…)"}}},"tags":[{"name":"Calculators","description":"Free with a key"},{"name":"Pre-construction","description":"Summitly Pre-Construction Pipeline"}],"paths":{"/api/developer/v1/calculators/mortgage":{"get":{"operationId":"calculate_mortgage","summary":"Mortgage payment calculator","description":"Same maths as https://www.summitly.ca/calculators/mortgage. Estimates only. Every plan, Free included.","tags":["Calculators"],"parameters":[{"name":"price","in":"query","required":true,"schema":{"type":"number","minimum":0,"maximum":100000000,"description":"Purchase price in CAD"},"description":"Purchase price in CAD"},{"name":"downPayment","in":"query","required":true,"schema":{"type":"number","minimum":0,"maximum":100000000,"description":"Down payment in CAD"},"description":"Down payment in CAD"},{"name":"ratePct","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":25,"default":3.79,"description":"Annual interest rate, %"},"description":"Annual interest rate, %"},{"name":"amortizationYears","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":35,"default":25}},{"name":"frequency","in":"query","required":false,"schema":{"type":"string","enum":["Weekly","Accelerated Weekly","Bi-weekly","Accelerated Bi-weekly","Semi-monthly","Monthly","Quarterly","Annually"],"default":"Monthly"}},{"name":"termYears","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":10,"default":5}}],"responses":{"200":{"description":"Calculator result","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid key"},"403":{"description":"Not in your plan"},"422":{"description":"Invalid input; `issues` lists each field"},"429":{"description":"Rate limit or quota"}}}},"/api/developer/v1/calculators/affordability":{"get":{"operationId":"calculate_affordability","summary":"Home affordability calculator","description":"Same maths as https://www.summitly.ca/calculators/affordability. Estimates only. Every plan, Free included.","tags":["Calculators"],"parameters":[{"name":"annualIncome","in":"query","required":true,"schema":{"type":"number","minimum":0,"maximum":10000000,"description":"Gross household income per year, CAD"},"description":"Gross household income per year, CAD"},{"name":"monthlyDebts","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":1000000,"default":0,"description":"Monthly debt payments (car, cards, loans), CAD"},"description":"Monthly debt payments (car, cards, loans), CAD"},{"name":"downPayment","in":"query","required":true,"schema":{"type":"number","minimum":0,"maximum":100000000,"description":"Down payment saved, CAD"},"description":"Down payment saved, CAD"},{"name":"ratePct","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":25,"default":3.79}},{"name":"amortizationYears","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":30,"default":25}},{"name":"propertyTaxRatePct","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":5,"default":0.77}},{"name":"condoFeesMonthly","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":100000,"default":0}}],"responses":{"200":{"description":"Calculator result","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid key"},"403":{"description":"Not in your plan"},"422":{"description":"Invalid input; `issues` lists each field"},"429":{"description":"Rate limit or quota"}}}},"/api/developer/v1/calculators/land-transfer-tax":{"get":{"operationId":"calculate_land_transfer_tax","summary":"Ontario land transfer tax calculator","description":"Same maths as https://www.summitly.ca/calculators/land-transfer-tax. Estimates only. Every plan, Free included.","tags":["Calculators"],"parameters":[{"name":"price","in":"query","required":true,"schema":{"type":"number","minimum":0,"maximum":100000000}},{"name":"toronto","in":"query","required":false,"schema":{"type":"boolean","default":false,"description":"Property is in the City of Toronto (adds the municipal LTT)"},"description":"Property is in the City of Toronto (adds the municipal LTT)"},{"name":"firstTimeBuyer","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Calculator result","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid key"},"403":{"description":"Not in your plan"},"422":{"description":"Invalid input; `issues` lists each field"},"429":{"description":"Rate limit or quota"}}}},"/api/developer/v1/calculators/cmhc":{"get":{"operationId":"calculate_cmhc","summary":"CMHC insurance calculator","description":"Same maths as https://www.summitly.ca/calculators/cmhc-insurance. Estimates only. Every plan, Free included.","tags":["Calculators"],"parameters":[{"name":"price","in":"query","required":true,"schema":{"type":"number","minimum":0,"maximum":100000000}},{"name":"downPayment","in":"query","required":true,"schema":{"type":"number","minimum":0,"maximum":100000000}},{"name":"amortizationYears","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":30,"default":25}},{"name":"firstTimeOrNewBuild","in":"query","required":false,"schema":{"type":"boolean","default":false,"description":"Eligible for a 30-year insured amortization"},"description":"Eligible for a 30-year insured amortization"}],"responses":{"200":{"description":"Calculator result","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid key"},"403":{"description":"Not in your plan"},"422":{"description":"Invalid input; `issues` lists each field"},"429":{"description":"Rate limit or quota"}}}},"/api/developer/v1/calculators/closing-costs":{"get":{"operationId":"calculate_closing_costs","summary":"Closing costs calculator","description":"Same maths as https://www.summitly.ca/buy/closing-costs. Estimates only. Every plan, Free included.","tags":["Calculators"],"parameters":[{"name":"price","in":"query","required":true,"schema":{"type":"number","minimum":0,"maximum":100000000}},{"name":"downPayment","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":100000000}},{"name":"toronto","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"firstTimeBuyer","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"legal","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":100000,"default":2000}},{"name":"inspection","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":100000,"default":550}}],"responses":{"200":{"description":"Calculator result","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid key"},"403":{"description":"Not in your plan"},"422":{"description":"Invalid input; `issues` lists each field"},"429":{"description":"Rate limit or quota"}}}},"/api/developer/v1/calculators/rent-vs-buy":{"get":{"operationId":"calculate_rent_vs_buy","summary":"Rent vs buy calculator","description":"Same maths as https://www.summitly.ca/calculators/rent-vs-buy. Estimates only. Every plan, Free included.","tags":["Calculators"],"parameters":[{"name":"homePrice","in":"query","required":true,"schema":{"type":"number","minimum":0,"maximum":100000000}},{"name":"downPaymentPercent","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":100,"default":20}},{"name":"monthlyRent","in":"query","required":true,"schema":{"type":"number","minimum":0,"maximum":1000000}},{"name":"mortgageRate","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":25,"default":5.5}},{"name":"amortization","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":35,"default":25}},{"name":"annualRentIncrease","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":20,"default":3}},{"name":"homeAppreciation","in":"query","required":false,"schema":{"type":"number","minimum":-20,"maximum":20,"default":3}},{"name":"investmentReturn","in":"query","required":false,"schema":{"type":"number","minimum":-20,"maximum":30,"default":6}},{"name":"annualPropertyTax","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":1000000,"default":3000}},{"name":"annualInsurance","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":1000000,"default":1500}},{"name":"annualMaintenance","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":1000000,"default":3000}},{"name":"closingCosts","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":10000000,"default":10000}},{"name":"years","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":30,"default":10}}],"responses":{"200":{"description":"Calculator result","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid key"},"403":{"description":"Not in your plan"},"422":{"description":"Invalid input; `issues` lists each field"},"429":{"description":"Rate limit or quota"}}}},"/api/developer/v1/calculators/fhsa-hbp":{"get":{"operationId":"calculate_fhsa_hbp","summary":"FHSA and Home Buyers' Plan calculator","description":"Same maths as https://www.summitly.ca/calculators/fhsa-hbp. Estimates only. Every plan, Free included.","tags":["Calculators"],"parameters":[{"name":"buyers","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":2,"default":1,"description":"First-time buyers on title (each has their own limits)"},"description":"First-time buyers on title (each has their own limits)"},{"name":"fhsaBalance","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":1000000,"default":0,"description":"Combined FHSA savings, CAD"},"description":"Combined FHSA savings, CAD"},{"name":"rrspBalance","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":10000000,"default":0,"description":"Combined RRSP savings available for the Home Buyers' Plan, CAD"},"description":"Combined RRSP savings available for the Home Buyers' Plan, CAD"},{"name":"otherSavings","in":"query","required":false,"schema":{"type":"number","minimum":0,"maximum":100000000,"default":0}}],"responses":{"200":{"description":"Calculator result","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid key"},"403":{"description":"Not in your plan"},"422":{"description":"Invalid input; `issues` lists each field"},"429":{"description":"Rate limit or quota"}}}},"/api/developer/v1/aggregates":{"get":{"operationId":"precon_aggregates","summary":"Pipeline aggregates by city","tags":["Pre-construction"],"parameters":[{"name":"city","in":"query","schema":{"type":"string"},"description":"City or comma-separated cities, e.g. toronto,mississauga"},{"name":"region","in":"query","schema":{"type":"string"},"description":"Region key, e.g. greater-toronto, metro-vancouver, rest-of-on"},{"name":"province","in":"query","schema":{"type":"string"}},{"name":"segment","in":"query","schema":{"type":"string"},"description":"Comma list of: low-rise, condo, rental, mixed-use"},{"name":"min_storeys","in":"query","schema":{"type":"integer","minimum":0}},{"name":"max_storeys","in":"query","schema":{"type":"integer","minimum":0}},{"name":"min_units","in":"query","schema":{"type":"integer","minimum":0}},{"name":"recorded_since","in":"query","schema":{"type":"string","format":"date-time"},"description":"First recorded by Summitly on or after"},{"name":"status","in":"query","schema":{"type":"string","enum":["planning","coming-soon","registration","selling","sold-out","completed","cancelled","resale"]}},{"name":"type","in":"query","schema":{"type":"string","enum":["condos","houses","townhomes","commercial"]}},{"name":"bbox","in":"query","schema":{"type":"string"},"description":"minLat,minLng,maxLat,maxLng"}],"responses":{"200":{"description":"Per-city aggregates","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid key"},"403":{"description":"Not in your plan"},"429":{"description":"Rate limit or quota"}}}},"/api/developer/v1/projects":{"get":{"operationId":"precon_projects","summary":"Pre-construction projects (Starter and up)","tags":["Pre-construction"],"parameters":[{"name":"city","in":"query","schema":{"type":"string"},"description":"City or comma-separated cities, e.g. toronto,mississauga"},{"name":"region","in":"query","schema":{"type":"string"},"description":"Region key, e.g. greater-toronto, metro-vancouver, rest-of-on"},{"name":"province","in":"query","schema":{"type":"string"}},{"name":"segment","in":"query","schema":{"type":"string"},"description":"Comma list of: low-rise, condo, rental, mixed-use"},{"name":"min_storeys","in":"query","schema":{"type":"integer","minimum":0}},{"name":"max_storeys","in":"query","schema":{"type":"integer","minimum":0}},{"name":"min_units","in":"query","schema":{"type":"integer","minimum":0}},{"name":"recorded_since","in":"query","schema":{"type":"string","format":"date-time"},"description":"First recorded by Summitly on or after"},{"name":"status","in":"query","schema":{"type":"string","enum":["planning","coming-soon","registration","selling","sold-out","completed","cancelled","resale"]}},{"name":"type","in":"query","schema":{"type":"string","enum":["condos","houses","townhomes","commercial"]}},{"name":"updated_since","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"bbox","in":"query","schema":{"type":"string"},"description":"minLat,minLng,maxLat,maxLng"},{"name":"cursor","in":"query","schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}}],"responses":{"200":{"description":"Page of projects with field sources and attribution","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid key"},"403":{"description":"Not in your plan"},"429":{"description":"Rate limit or quota"}}}},"/api/developer/v1/ask":{"get":{"operationId":"precon_ask","summary":"Ask in plain English","description":"Reads a question into explicit filters (returned in query.explain) and answers within your plan.","tags":["Pre-construction"],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","maxLength":300}}],"responses":{"200":{"description":"Filters used and the results","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid key"},"403":{"description":"Not in your plan"},"422":{"description":"No filters found in the question"},"429":{"description":"Rate limit or quota"}}}},"/api/developer/v1/projects/{id}/history":{"get":{"operationId":"precon_project_history","summary":"A project's recorded journey (Pro and up)","tags":["Pre-construction"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"First recorded date and every recorded change","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid key"},"403":{"description":"Not in your plan"},"404":{"description":"Not found"},"429":{"description":"Rate limit or quota"}}}},"/api/developer/v1/projects/{id}":{"get":{"operationId":"precon_project","summary":"One project (Starter and up)","tags":["Pre-construction"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Project","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid key"},"403":{"description":"Not in your plan"},"404":{"description":"Not found"},"429":{"description":"Rate limit or quota"}}}},"/api/developer/v1/changes":{"get":{"operationId":"precon_changes","summary":"Change feed (Business)","tags":["Pre-construction"],"parameters":[{"name":"since","in":"query","schema":{"type":"string"},"description":"nextCursor from the previous call; omit to start from the beginning"},{"name":"kind","in":"query","schema":{"type":"string"},"description":"Comma list of: created, status, units, storeys, unpublished"},{"name":"city","in":"query","schema":{"type":"string"},"description":"City or comma-separated cities, e.g. toronto,mississauga"},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}}],"responses":{"200":{"description":"Events and nextCursor","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Missing or invalid key"},"403":{"description":"Not in your plan"},"429":{"description":"Rate limit or quota"}}}},"/api/developer/v1/exports/projects":{"get":{"operationId":"precon_export","summary":"Bulk export (CSV from Starter, GeoJSON from Pro, Parquet on Business)","tags":["Pre-construction"],"parameters":[{"name":"format","in":"query","schema":{"type":"string","enum":["csv","geojson","parquet"],"default":"csv"}},{"name":"city","in":"query","schema":{"type":"string"},"description":"City or comma-separated cities, e.g. toronto,mississauga"},{"name":"region","in":"query","schema":{"type":"string"},"description":"Region key, e.g. greater-toronto, metro-vancouver, rest-of-on"},{"name":"province","in":"query","schema":{"type":"string"}},{"name":"segment","in":"query","schema":{"type":"string"},"description":"Comma list of: low-rise, condo, rental, mixed-use"},{"name":"min_storeys","in":"query","schema":{"type":"integer","minimum":0}},{"name":"max_storeys","in":"query","schema":{"type":"integer","minimum":0}},{"name":"min_units","in":"query","schema":{"type":"integer","minimum":0}},{"name":"recorded_since","in":"query","schema":{"type":"string","format":"date-time"},"description":"First recorded by Summitly on or after"},{"name":"status","in":"query","schema":{"type":"string","enum":["planning","coming-soon","registration","selling","sold-out","completed","cancelled","resale"]}},{"name":"type","in":"query","schema":{"type":"string","enum":["condos","houses","townhomes","commercial"]}},{"name":"updated_since","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"bbox","in":"query","schema":{"type":"string"},"description":"minLat,minLng,maxLat,maxLng"}],"responses":{"200":{"description":"CSV, GeoJSON or Parquet file","content":{"text/csv":{"schema":{"type":"string"}},"application/geo+json":{"schema":{"type":"object"}},"application/vnd.apache.parquet":{"schema":{"type":"string","format":"binary"}}}}}}}}}