Properate API (1.1.0)
Download OpenAPI specification:
Properate's Backend API. View our Seed documentation for more information. See our Seed Type Definition for details on seed properties
Create a new Seed
Create a new empty Seed from an address
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/json
String containing the address to create a new seed with. Address will be geocoded so it does not need to be exact. Address must be located within Canada
| address | string |
Responses
Request samples
- Payload
{- "address": "string"
}Response samples
- 200
{- "status": "success",
- "payload": { }
}Create a new Seed with coordinates
Create a new empty Seed with coordinates instead of an address
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/json
Object containing the lat lng coordinates to use for seed creation. Address will be reverse geocoded using the closest match.
object |
Responses
Request samples
- Payload
{- "coords": {
- "lat": 0,
- "lng": 0
}
}Response samples
- 200
{- "status": "success",
- "payload": { }
}Complete Seed
Automatically fill data for a given Seed.
Automatically selects entities & ACH if year built is provided in
seed.house.space.year.Automatically fills in windows if wall areas are provided.
Automatically selects climate zone if address is provided using
createSeedFromAddress
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/jsonrequired
The seed to be simulated.
Responses
Request samples
- Payload
{ }Response samples
- 200
{- "status": "success",
- "payload": { }
}Retrofit Costs
Automatically ensures proper costing for retrofit using before & after seeds.
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/json
Object containing before & after seed conditions.
| before | object Seed containing base condition of a home. |
| after | object Seed containing retrofit upgrades. |
Responses
Request samples
- Payload
{- "before": { },
- "after": { }
}Response samples
- 200
{- "status": "success",
- "payload": { }
}Generate Run Token
Generates a run token for your seed. Put the return value in seed.meta.token before simulation
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/jsonrequired
The seed to be simulated.
Responses
Request samples
- Payload
{ }Response samples
- 200
{- "status": "success",
- "payload": { }
}Run Simulations
Run simulations for a seed. Requires a run token in the seed. Returns an array of CherryPicked Saplings as defined in SeedV15 documentation.
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/jsonrequired
The seed to be simulated.
Responses
Request samples
- Payload
{ }Response samples
- 200
{- "status": "success",
- "payload": { }
}Entity Search
Searches entities from the Material Database. Can also be passed an entity ID to return a specific entity.
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/json
Search Query Object
| type | string Enum: "wall" "exposedFloor" "roof" "attic" "fWall" "slab" "windowAssembly" "bundle" "mech" "aux" "dhw" "hrv" "suppl" The entity type to search for |
| query | string Search string |
Responses
Request samples
- Payload
{- "type": "wall",
- "query": "string"
}Response samples
- 200
{- "status": "success",
- "payload": { }
}Bulk Entity Search
Searches for multiple entities from the Material Database. Can also be passed an entity ID to return a specific entity.
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/json
Search Query Object
| type | string Enum: "wall" "exposedFloor" "roof" "attic" "fWall" "slab" "windowAssembly" "bundle" "mech" "aux" "dhw" "hrv" "suppl" The entity type to search for |
| query | string Search string |
Responses
Request samples
- Payload
{- "type": "wall",
- "query": "string"
}Response samples
- 200
{- "status": "success",
- "payload": { }
}Convert a Seed to a HOT2000 file
Convert a Seed to a HOT2000 file.
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/jsonrequired
The seed to be converted.
Responses
Request samples
- Payload
{ }Response samples
- 200
{- "status": "success",
- "payload": { }
}Generates F280 outputs for a sapling
Generates F280 outputs for a sapling
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/jsonrequired
Contains the sapling to be used.
| sapling | object |
Responses
Request samples
- Payload
{- "sapling": { }
}Response samples
- 200
{- "status": "success",
- "payload": { }
}Create a Seedling from a Seed
Creates a Seedling which is a Seed that contains extra calculated values from the server.
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/jsonrequired
The seed to be simulated.
Responses
Request samples
- Payload
{ }Response samples
- 200
{- "status": "success",
- "payload": { }
}Generates F280 outputs for a seed
Generates F280 outputs for a seed
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/jsonrequired
Contains the seed to be used.
| sapling | object |
Responses
Request samples
- Payload
{- "sapling": { }
}Response samples
- 200
{- "status": "success",
- "payload": { }
}Retrieve an archetype
Returns the exact archetype match for a province, climate location, building type, and year.
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/jsonrequired
Exact-match archetype lookup fields.
| province required | string |
| location required | string |
| buildingType required | string |
| yearBuilt required | number |
Responses
Request samples
- Payload
{- "province": "string",
- "location": "string",
- "buildingType": "string",
- "yearBuilt": 0
}Response samples
- 200
{- "status": "success",
- "payload": { },
- "message": "string"
}Query archetypes
Returns all archetypes for a required year, optionally filtered by province, climate location, and building type.
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/jsonrequired
Archetype query fields.
| province | string |
| location | string |
| buildingType | string |
| yearBuilt required | number |
Responses
Request samples
- Payload
{- "province": "string",
- "location": "string",
- "buildingType": "string",
- "yearBuilt": 0
}Response samples
- 200
[- { }
]Find nearest climate location
Returns the nearest archetype climate station for a latitude and longitude.
Authorizations:
query Parameters
| key required | string API Key |
Request Body schema: application/jsonrequired
Coordinates used to find the nearest archetype climate station.
| latitude required | number |
| longitude required | number |
Responses
Request samples
- Payload
{- "latitude": 0,
- "longitude": 0
}Response samples
- 200
{- "location": "string",
- "place_name": "string",
- "province": "string",
- "status": "error",
- "message": "string"
}