Market Data

Market Data - Get Market Data

HTTP Request

POST /api/market-data

📋 Description: Submits market data for analysis within the Nakisa Portfolio Management Suite, enabling enhanced portfolio and asset analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

MarketDataKey

true

Request body containing market data related to portfolio assets, including analytics and real estate property metrics.

Body Parameters

1{
2  "city": "string",
3  "usage": "string",
4  "buildingType": "string",
5  "propertyType": "string"
6}

Responses

Status

Meaning

Description

Schema

200

OK

OK

MarketDataDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "city": "string",
10  "usage": "string",
11  "buildingType": "string",
12  "propertyType": "string",
13  "category": "string",
14  "avgAskingRent": "string",
15  "rentUnit": "string",
16  "qoqChange": "string",
17  "quarter": "string",
18  "explanation": "string",
19  "explanationFr": "string",
20  "sources": [
21    {
22      "name": "string",
23      "url": "string"
24    }
25  ]
26}

Market Data - Generate Market Data

HTTP Request

POST /api/market-data/refresh

📋 Description: Initiates a refresh of market data for portfolios and assets within the Nakisa Portfolio Management Suite, ensuring that analytics related to real estate properties are up-to-date and accurate.

Parameters

Name

In

Type

Required

Description

body

body

MarketDataKey

true

Request body containing the market data refresh parameters, including portfolio identifiers and asset details, to facilitate updated analytics for real estate properties.

Body Parameters

1{
2  "city": "string",
3  "usage": "string",
4  "buildingType": "string",
5  "propertyType": "string"
6}

Responses

Status

Meaning

Description

Schema

200

OK

OK

MarketDataDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "city": "string",
10  "usage": "string",
11  "buildingType": "string",
12  "propertyType": "string",
13  "category": "string",
14  "avgAskingRent": "string",
15  "rentUnit": "string",
16  "qoqChange": "string",
17  "quarter": "string",
18  "explanation": "string",
19  "explanationFr": "string",
20  "sources": [
21    {
22      "name": "string",
23      "url": "string"
24    }
25  ]
26}