Properate logo
API docs by Redocly

Properate API (1.0.5)

Download OpenAPI specification:Download

Properate's Backend API. View our Seed documentation for more information. See our Seed Type Definition for details on seed properties

Seed Creation

Create a new Seed

Create a new empty Seed from an address

Authorizations:
api_key
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

Content type
application/json
{
  • "address": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "payload": { }
}

Create a new Seed with coordinates

Create a new empty Seed with coordinates instead of an address

Authorizations:
api_key
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

Content type
application/json
{
  • "coords": {
    }
}

Response samples

Content type
application/json
{
  • "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:
api_key
query Parameters
key
required
string

API Key

Request Body schema: application/json

The seed to be simulated.

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "status": "success",
  • "payload": { }
}

Retrofit Costs

Automatically ensures proper costing for retrofit using before & after seeds.

Authorizations:
api_key
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

Content type
application/json
{
  • "before": { },
  • "after": { }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "payload": { }
}

Simulation

Generate Run Token

Generates a run token for your seed. Put the return value in seed.meta.token before simulation

Authorizations:
api_key
query Parameters
key
required
string

API Key

Request Body schema: application/json

The seed to be simulated.

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "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:
api_key
query Parameters
key
required
string

API Key

Request Body schema: application/json

The seed to be simulated.

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "status": "success",
  • "payload": { }
}

Entity Search

Searches entities from the Material Database. Can also be passed an entity ID to return a specific entity.

Authorizations:
api_key
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

Content type
application/json
{
  • "type": "wall",
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "payload": { }
}

Convert a Seed to a HOT2000 file

Convert a Seed to a HOT2000 file.

Authorizations:
api_key
query Parameters
key
required
string

API Key

Request Body schema: application/json

The seed to be simulated.

object

Responses

Request samples

Content type
application/json
{ }