### Response Sample: Get Demand Summary

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Example JSON response for the Get Demand Summary endpoint. It includes relative and absolute metrics for price, area, bedrooms, and conservation status.

```json
{
  "price_relative": {
    "x": "1102145.3784",
    "y": 0.5994
  },
  "price_absolute": {
    "x": "179454.0141",
    "y": 21.1293
  },
  "price_m2_relative": {
    "x": "1434.62",
    "y": 1
  },
  "price_m2_absolute": {
    "x": "4270.1942",
    "y": 40.0529
  },
  "area_relative": {
    "x": "208.8624",
    "y": 0.5585
  },
  "area_absolute": {
    "x": "59.8408",
    "y": 25.9184
  },
  "bedrooms_relative": {
    "x": "5",
    "y": 0.5556
  },
  "bedrooms_absolute": {
    "x": "1",
    "y": 24
  },
  "conservation_relative": {
    "x": "Obra nueva",
    "y": 0.4444
  },
  "conservation_absolute": {
    "x": "Bueno ",
    "y": 27
  }
}
```

--------------------------------

### Request Sample: Get Demand Summary Payload

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Example JSON payload for fetching a demand summary. Requires postal code and period, with optional parameters for operation, property type, and new construction.

```json
{
  "postal_code": [
    "28012"
  ],
  "operation": "buy",
  "property_type": [
    "flat",
    "house"
  ],
  "new_construction": [
    0,
    1
  ],
  "period": "1_month"
}
```

--------------------------------

### Get PBSA Bedrooms Metrics Request Payload Example

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This JSON payload demonstrates how to request bedrooms summary metrics. It specifies aggregation, bedroom counts, coordinates, postal code, and price range.

```json
{
  "aggregation": "postal_code",
  "bedrooms": [
    "0",
    "1",
    "2",
    "3",
    "4",
    "5",
    "6",
    "7+"
  ],
  "coordinates": [ ],
  "postal_code": [
    "28001"
  ],
  "price_m2_range": {
    "min_price_m2": 0,
    "max_price_m2": 70
  }
}
```

--------------------------------

### Get Province Market Metrics Request Payload Example (JSON)

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This snippet demonstrates the JSON payload required for the 'Get Province Market Metrics' endpoint. It includes the province name and a date range.

```json
{
  "province": "string",
  "date_range": {
    "start_date": "2020-03-01T00:00:00",
    "end_date": "2025-11-19T00:00:00"
  }
}
```

--------------------------------

### Get PBSA Bedrooms Metrics Response Sample

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

A successful response for the Get PBSA Bedrooms Metrics endpoint, providing price and supply data for the requested criteria.

```json
{
  "price": 689.2977,
  "supply": 131
}
```

--------------------------------

### Request Sample: Get PBSA Summary Payload

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Example JSON payload for fetching a PBSA (Purpose Built Student Accommodation) summary. It requires postal code and optionally accepts coordinates and PBSA types.

```json
{
  "postal_code": [
    "28001"
  ],
  "pbsa_type": [
    "modern_standard",
    "religious",
    "public",
    "others",
    "student_residences",
    "pipeline"
  ],
  "coordinates": [ ]
}
```

--------------------------------

### Get Province Comparables Request Payload Example (JSON)

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This snippet shows the JSON payload for the 'Get Province Comparables' endpoint, which requires only the province name.

```json
{
  "province": "string"
}
```

--------------------------------

### Secured Endpoint

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

An example of a secured endpoint that requires authentication.

```APIDOC
## POST /public/secured-endpoint

### Description
An endpoint protected by authentication.

### Method
POST

### Endpoint
/public/secured-endpoint

### Authorization
Requires a valid OAuth2 Bearer token.

### Response
#### Success Response (200)
Returns null or a success indicator upon successful access.
```

--------------------------------

### Get Province Market Metrics Response Sample (JSON)

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This snippet illustrates the JSON response for the 'Get Province Market Metrics' endpoint. It contains market data including buy and rent prices, and yield information.

```json
{
  "data": {
    "market": [
      {
        "date": "string",
        "buy_price": 0,
        "buy_price_m2": 0,
        "rent_price": 0,
        "rent_price_m2": 0,
        "yield_data": 0
      }
    ]
  }
}
```

--------------------------------

### GET /public/user/portfolio

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Retrieves the user's portfolio data with pagination. Requires OAuth2 authorization.

```APIDOC
## GET /public/user/portfolio

### Description
Retrieves the user's portfolio data with pagination. Requires OAuth2 authorization.

### Method
GET

### Endpoint
https://apiv2.atlas-reanalytics.com/public/user/portfolio

### Parameters

#### Query Parameters
- **limit** (integer) - The maximum number of results to return. Between 1 and 100. Default: 20.
- **offset** (integer) - The number of results to skip. Must be >= 0. Default: 0.

#### Request Body

### Request Example

### Response
#### Success Response (200)
- **data** (array) - An array of portfolio items, each with detailed property information including user details.
- **total** (integer) - The total number of items in the portfolio.

#### Response Example
```json
{
  "data": [
    {
      "id": 0,
      "address": "string",
      "property_type": "house",
      "construction_type": 0,
      "area": 0,
      "bedrooms": 0,
      "bathrooms": 0,
      "garage": true,
      "lift": true,
      "storage": true,
      "terrace": true,
      "air_conditioned": true,
      "pool": true,
      "garden": true,
      "sports": true,
      "conservation": 2,
      "price_buy": 0,
      "latitude": 0,
      "longitude": 0,
      "postal_code": "string",
      "price_rent": 0,
      "valued": false,
      "user": {
        "name": "string",
        "lastname": "string",
        "email": "string"
      },
      "valuation_date": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0
}
```
```

--------------------------------

### POST /valuation/

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Get a property valuation based on the provided cadastre reference.

```APIDOC
## POST /valuation/

### Description
Get a valuation based on the provided cadastre reference.

### Method
POST

### Endpoint
/public/valuation/

### Parameters
#### Request Body
- **cadastre_reference** (string) - Required - The cadastre reference required to calculate the valuation. Max length: 20 characters.

### Request Example
```json
{
  "cadastre_reference": "0863905VK4706D0010LW"
}
```

### Response
#### Success Response (200)
- **valuation_buy** (object) - Valuation details for buying.
  - **prediction_formatted** (string) - Formatted predicted value.
  - **prediction** (number) - Predicted value.
  - **prediction_m2** (number) - Predicted value per square meter.
  - **postal_code** (string) - Postal code.
- **valuation_rent** (object) - Valuation details for renting.
  - **prediction_formatted** (string) - Formatted predicted value.
  - **prediction** (number) - Predicted value.
  - **prediction_m2** (number) - Predicted value per square meter.
  - **postal_code** (string) - Postal code.

#### Response Example
```json
{
  "valuation_buy": {
    "prediction_formatted": "659,682€",
    "prediction": 659681.85,
    "prediction_m2": 8795.758,
    "postal_code": "28010"
  },
  "valuation_rent": {
    "prediction_formatted": "659,682€",
    "prediction": 659681.85,
    "prediction_m2": 8795.758,
    "postal_code": "28010"
  }
}
```

#### Error Responses
- **401**: Unauthorized
- **403**: Forbidden
- **404**: Not found
- **422**: Validation Error
```

--------------------------------

### POST /public/comparable/idealista/estimated_price_data

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Get idealista data with estimated rent price based on various property attributes.

```APIDOC
## POST /public/comparable/idealista/estimated_price_data

### Description
Retrieves comparable data from Idealista, including estimated rent prices, based on detailed property specifications.

### Method
POST

### Endpoint
https://apiv2.atlas-reanalytics.com/public/comparable/idealista/estimated_price_data

### Request Body
- **zone_type** (string) - Required - The type of zone ('neighbourhood', 'province', 'municipality', 'district').
- **neighbourhood** (string) - Optional - The specific neighbourhood name.
- **district** (string) - Optional - The specific district name.
- **municipality** (string) - Optional - The specific municipality name.
- **province** (string) - Optional - The specific province name.
- **price_buy_range** (object) - Required - Price range for buying property.
  - **min_price** (number) - Minimum price.
  - **max_price** (number) - Maximum price.
- **estimated_price_rent_range** (object) - Required - Price range for estimated rent.
  - **min_price** (number) - Minimum price.
  - **max_price** (number) - Maximum price.
- **size_range** (object) - Required - Size range of the property.
  - **min_size** (number) - Minimum size in square meters.
  - **max_size** (number) - Maximum size in square meters.
- **limit** (integer) - Optional - The maximum number of results to return. Defaults to 10. (1-100)
- **offset** (integer) - Optional - The number of results to skip. Defaults to 0.
- **bedrooms** (array of integers) - Optional - List of desired number of bedrooms. Defaults to [1, 2, 3, 4, 5].
- **bathrooms** (array of integers) - Optional - List of desired number of bathrooms. Defaults to [1, 2, 3, 4, 5].
- **new_construction** (array of integers) - Optional - Filter by new construction status (0 for no, 1 for yes). Defaults to [0, 1].
- **property_type** (string) - Optional - The type of property ('flat', 'house'). Defaults to 'flat'.
- **sort** (object) - Optional - Sorting options.
  - **sort_by** (string) - Field to sort by (e.g., 'price').
  - **sort_order** (string) - Sort order ('asc' or 'desc').
- **features** (array of strings) - Optional - List of desired features (e.g., 'attic', 'swimming_pool').
- **list_ids** (array of strings) - Optional - Filter by a list of property IDs.
- **illegally_occupied** (boolean) - Optional - Filter by illegally occupied status.

### Request Example
```json
{
  "zone_type": "neighbourhood",
  "neighbourhood": "Lavapiés-Embajadores",
  "price_buy_range": {
    "min_price": 0,
    "max_price": 6000000
  },
  "estimated_price_rent_range": {
    "min_price": 0,
    "max_price": 6000000
  },
  "size_range": {
    "min_size": 0,
    "max_size": 500
  },
  "limit": 10,
  "offset": 0,
  "bedrooms": [
    1,
    2,
    3,
    4,
    5
  ],
  "bathrooms": [
    1,
    2,
    3,
    4,
    5
  ],
  "new_construction": [
    0,
    1
  ],
  "property_type": "flat",
  "sort": {
    "sort_by": "price",
    "sort_order": "asc"
  },
  "features": [
    "attic",
    "swimming_pool"
  ],
  "illegally_occupied": false
}
```

### Responses
#### Success Response (200)
- **data** (array) - A list of comparable property data.
#### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not found
- **422** - Validation Error

### Response Example (200)
```json
{
  "data": [
    {
      "id": "property_id_1",
      "estimated_rent_price": 1200,
      "size": 75,
      "bedrooms": 3,
      "bathrooms": 2
    },
    {
      "id": "property_id_2",
      "estimated_rent_price": 950,
      "size": 60,
      "bedrooms": 2,
      "bathrooms": 1
    }
  ]
}
```
```

--------------------------------

### POST /api/users

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Creates a new user with the provided details.

```APIDOC
## POST /api/users

### Description
Creates a new user with the provided details.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Request Body
- **email** (string) - Required - User's email address.
- **name** (string) - Required - User's first name.
- **last_name** (string) - Required - User's last name.
- **phone_number** (string) - Optional - User's phone number.

### Request Example
```json
{
  "email": "string",
  "name": "string",
  "last_name": "string",
  "phone_number": "string"
}
```

### Response
#### Success Response (200)
- **user_id** (integer) - The unique identifier for the created user.
- **email** (string) - The user's email address.
- **created_at** (string) - The timestamp when the user was created (ISO 8601 format).
- **tier** (string) - The user's subscription tier.
- **is_admin** (boolean) - Indicates if the user has administrative privileges.
- **company_id** (integer) - The identifier of the company the user belongs to.
- **company** (string) - The name of the company the user belongs to.
- **nombre** (string) - User's first name (Spanish).
- **apellido** (string) - User's last name (Spanish).
- **auth0_id** (string) - The authentication ID from Auth0.
- **telefono** (string) - User's phone number (Spanish).
- **colores** (string) - Additional color information associated with the user.
- **idioma** (string) - The user's preferred language.
- **activo** (string) - Indicates if the user account is active.

#### Response Example
```json
{
  "user_id": 0,
  "email": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "tier": "string",
  "is_admin": true,
  "company_id": 0,
  "company": "string",
  "nombre": "string",
  "apellido": "string",
  "auth0_id": "string",
  "telefono": "string",
  "colores": "string",
  "idioma": "string",
  "activo": "string"
}
```

#### Error Response (422)
- Validation Error: Returned if the request body does not meet the schema requirements.
```

--------------------------------

### GET /open_data/static/market Response Sample (JSON)

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This JSON response is obtained from the /open_data/static/market endpoint. It presents static market data, showing supply by number of bedrooms, along with textual summaries in English and another language.

```json
{
  "data": [
    {
      "bedrooms": "string",
      "supply": 0
    }
  ],
  "text": "string",
  "text_en": "string"
}
```

--------------------------------

### Python SDK for API v2 Atlas-reanalytics

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Example of how to interact with the API v2 Atlas-reanalytics using Python. This snippet demonstrates constructing a request payload and making a POST request to the comparable data endpoint.

```python
import requests

api_url = "https://apiv2.atlas-reanalytics.com/public/v3/comparable/data"
headers = {
    "Content-Type": "application/json"
}

payload = {
    "aggregation": "postal_code",
    "input": ["19001"],
    "operation": "buy",
    "date_range": {
        "start_date": "2023-11-19T12:17:00",
        "end_date": "2025-11-19T12:17:00"
    },
    "price_range": {
        "min_price": 0,
        "max_price": 6000000
    },
    "size_range": {
        "min_size": 0,
        "max_size": 500
    },
    "property_type": ["flat", "house"],
    "new_construction": [0, 1],
    "bedrooms": [0, 1, 2, 3, "4+"],
    "bathrooms": [0, 1, 2, 3, "4+"],
    "limit": 10,
    "offset": 0
}

response = requests.post(api_url, json=payload, headers=headers)

if response.status_code == 200:
    print("Success:", response.json())
elif response.status_code == 401:
    print("Unauthorized")
elif response.status_code == 403:
    print("Forbidden")
elif response.status_code == 404:
    print("Not Found")
elif response.status_code == 422:
    print("Validation Error:", response.json())
else:
    print("Error:", response.status_code)
```

--------------------------------

### POST /public/user/create_limited_user

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Creates a new limited user account with basic contact information.

```APIDOC
## POST /public/user/create_limited_user

### Description
Creates a new user account with restricted permissions, requiring essential contact details.

### Method
POST

### Endpoint
https://apiv2.atlas-reanalytics.com/public/user/create_limited_user

### Parameters
#### Request Body
- **email** (string) - Required - The email address for the new user.
- **name** (string) - Required - The first name of the new user.
- **last_name** (string) - Required - The last name of the new user.
- **phone_number** (string) - Required - The phone number for the new user.

### Response
#### Success Response (200)
Indicates successful creation of the limited user account.
```

--------------------------------

### POST Request Sample for General Market Metrics

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This snippet demonstrates a sample JSON payload for the POST /market/metrics/general endpoint. It includes parameters like postal_code, operation, property_type, and various filters for property characteristics.

```json
{
  "postal_code": [
    "28001"
  ],
  "operation": "buy",
  "property_type": [
    "flat"
  ],
  "new_construction": [
    0,
    1
  ],
  "attic": [
    0,
    1
  ],
  "duplex": [
    0,
    1
  ],
  "ground_floor": [
    0,
    1
  ],
  "garage": [
    0,
    1
  ],
  "swimming_pool": [
    0,
    1
  ],
  "storage": [
    0,
    1
  ],
  "bedrooms": [
    0,
    1,
    2,
    3,
    "4+"
  ],
  "bathrooms": [
    0,
    1,
    2,
    3,
    "4+"
  ],
  "area": [
    0,
    500
  ],
  "aggregation": "postal_code",
  "coordinates": [ ]
}
```

--------------------------------

### Get PBSA Bedrooms Price Trend Request Payload Example

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This JSON payload illustrates a request for PBSA bedrooms price trends. It includes parameters for aggregation, bedrooms, coordinates, historical data, postal code, price range, property type, and trend type.

```json
{
  "postal_code": [
    "48010"
  ],
  "coordinates": [ ],
  "bedrooms": [
    "0",
    "1",
    "2",
    "3"
  ],
  "aggregation": "postal_code",
  "price_m2_range": {
    "min_price_m2": 0,
    "max_price_m2": 70
  },
  "property_type": [
    "room"
  ],
  "type": "comparison",
  "historical_aggregation": "month",
  "historical_range": "2022-07-01,2025-02-28"
}
```

--------------------------------

### Request Sample for Portfolio Creation (JSON Array)

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This JSON array represents the payload for creating or updating multiple properties in a user's portfolio. Each object within the array defines a property with its attributes.

```json
[
  {
    "id": 0,
    "address": "string",
    "property_type": "house",
    "construction_type": 0,
    "area": 0,
    "bedrooms": 0,
    "bathrooms": 0,
    "garage": true,
    "lift": true,
    "storage": true,
    "terrace": true,
    "air_conditioned": true,
    "pool": true,
    "garden": true,
    "sports": true,
    "conservation": 2,
    "price_buy": 0,
    "latitude": 0,
    "longitude": 0,
    "postal_code": "string",
    "price_rent": 0,
    "valued": false,
    "user": {
      "name": "string",
      "lastname": "string",
      "email": "string"
    },
    "valuation_date": "2019-08-24T14:15:22Z"
  }
]
```

--------------------------------

### Get Comparable Districts - API Request

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Retrieves a list of comparable districts based on a provided input string. This GET request can be filtered by limit and offset.

```HTTP
GET /public/comparable/zones/districts?input_string=Sol, Madrid&limit=10&offset=0

```

--------------------------------

### User Response Sample (JSON)

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This snippet illustrates a successful JSON response when retrieving user data. It includes user identification, contact information, account status, and company details.

```json
{
  "user_id": 0,
  "email": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "tier": "string",
  "is_admin": true,
  "company_id": 0,
  "company": "string",
  "nombre": "string",
  "apellido": "string",
  "auth0_id": "string",
  "telefono": "string",
  "colores": "string",
  "idioma": "string",
  "activo": "string"
}
```

--------------------------------

### Get Province List Response Sample (JSON)

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This snippet shows the expected JSON response for the 'Get Province List' endpoint. It returns a list of province names as strings.

```json
{
  "provinces": [
    "string"
  ]
}
```

--------------------------------

### Get Comparable Neighbourhoods - API Request

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Retrieves a list of comparable neighbourhoods based on search criteria. This GET request is useful for finding specific neighbourhoods within a larger area.

```HTTP
GET /public/comparable/zones/neighbourhoods?input_string=Lavapiés-Embajadores&limit=10&offset=0

```

--------------------------------

### Get Province Demand Metrics Response Sample (JSON)

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This snippet illustrates the JSON response for the 'Get Province Demand Metrics' endpoint, providing demand data such as absorption and vacancy rates.

```json
{
  "data": {
    "market": [
      {
        "date": "string",
        "absorption_buy": 0,
        "absorption_rent": 0,
        "vacancy_rate_buy": 0,
        "vacancy_rate_rent": 0
      }
    ]
  }
}
```

--------------------------------

### POST Request Sample for Absorption Metrics

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This snippet provides a sample JSON payload for the POST /market/metrics/absortion endpoint. It includes essential parameters like postal_code, operation, property_type, new_construction, and bedrooms to retrieve absorption metrics.

```json
{
  "postal_code": [
    "28001"
  ],
  "operation": "buy",
  "property_type": [
    "flat"
  ],
  "new_construction": [
    0,
    1
  ],
  "bedrooms": [
    0,
    1,
    2,
    3,
    "4+"
  ]
}
```

--------------------------------

### Get Province Demographics Metrics Response Sample (JSON)

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This snippet illustrates the JSON response for the 'Get Province Demographics Metrics' endpoint, including market and demographic data like household income and population density.

```json
{
  "data": {
    "market": [
      {
        "date": "string",
        "effort_rate": 0,
        "years_to_pay": 0
      }
    ],
    "demographics": {
      "date": "string",
      "household_income": 0,
      "percent_people_renting": 0,
      "population_density": 0,
      "one_people_households": 0,
      "two_people_households": 0,
      "people_average_age": 0,
      "percent_age_20_30": 0,
      "unemployment": 0,
      "high_education_people": 0,
      "empty_households": 0,
      "population": 0
    }
  }
}
```

--------------------------------

### Successful Response Sample for General Market Metrics

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This snippet shows a successful (200 OK) response from the POST /market/metrics/general endpoint. It returns an array of objects, each containing the title, variable, value, variation, and format of a market metric.

```json
[
  {
    "title": "Average price",
    "variable": "price",
    "value": 100000,
    "variation": 1.64,
    "format": "currency"
  }
]
```

--------------------------------

### Get Comparable Data Request Sample (JSON)

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This JSON payload demonstrates how to request comparable real estate data from the API. It includes essential parameters such as aggregation, input, operation, date range, price range, size range, property type, new construction, bedrooms, bathrooms, and pagination limits.

```JSON
{
  "aggregation": "postal_code",
  "input": [
    "19001"
  ],
  "operation": "buy",
  "date_range": {
    "start_date": "2023-11-19T12:17:00",
    "end_date": "2025-11-19T12:17:00"
  },
  "price_range": {
    "min_price": 0,
    "max_price": 6000000
  },
  "size_range": {
    "min_size": 0,
    "max_size": 500
  },
  "property_type": [
    "flat",
    "house"
  ],
  "new_construction": [
    0,
    1
  ],
  "bedrooms": [
    0,
    1,
    2,
    3,
    "4+"
  ],
  "bathrooms": [
    0,
    1,
    2,
    3,
    "4+"
  ],
  "limit": 10,
  "offset": 0
}
```

--------------------------------

### Get GDP Trend Request Sample (JSON)

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Sample JSON payload for the 'Get GDP Trend' endpoint. This requires specifying aggregation level, historical aggregation, date range, postal code, and data type.

```json
{
  "aggregation": "postal_code",
  "historical_aggregation": "year",
  "historical_range": "2000-01-01,2024-08-01",
  "postal_code": [
    "28001"
  ],
  "type": "comparison"
}
```

--------------------------------

### POST /public/market/retail/metrics/general

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Retrieves general retail metrics for real estate markets.

```APIDOC
## POST /public/market/retail/metrics/general

### Description
Get the retail general metrics of the market. This endpoint returns market retail general metrics for the provided inputs.

### Method
POST

### Endpoint
https://apiv2.atlas-reanalytics.com/public/market/retail/metrics/general

### Parameters
#### Query Parameters
- **postal_code** (Array of strings) - Required - The postal code for which to obtain the general metrics.
- **operation** (string) - Optional - The operation type. Defaults to "buy". Enum: "buy", "rent"
- **property_type** (Array of strings) - Optional - The property type. Defaults to ["flat", "house"]. Items Enum: "flat", "house", "premises", "room"
- **new_construction** (Array of integers) - Optional - The new construction type. Defaults to [0, 1]. Items Enum: 0, 1
- **bedrooms** (Array) - Optional - The number of bedrooms. Defaults to [0, 1, 2, 3, "4+"]. Items: integer or string
- **area** (Array of integers) - Optional - The area of the property. Defaults to [0, 500].
- **aggregation** (string) - Optional - The aggregation type. Defaults to "postal_code". Enum: "postal_code", "municipality", "polygon"
- **coordinates** (Array of any) - Optional - The coordinates of the polygon to obtain the general metrics.

### Request Example
```json
{
  "postal_code": [
    "28001"
  ],
  "operation": "buy",
  "property_type": [
    "premises"
  ],
  "new_construction": [
    0,
    1
  ],
  "bedrooms": [
    0,
    1,
    2,
    3,
    "4+"
  ],
  "aggregation": "postal_code",
  "coordinates": []
}
```

### Response
#### Success Response (200)
Returns an array of metric objects, each with a title, variable, value, variation, and format.

#### Response Example
```json
[
  {
    "title": "Average price",
    "variable": "price",
    "value": 100000,
    "variation": 1.64,
    "format": "currency"
  }
]
```

#### Error Responses
- **401**: Unauthorized
- **403**: Forbidden
- **404**: Not found
- **422**: Validation Error
```

--------------------------------

### Get Market Trends Asking Closing Data (GET)

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Retrieves the asking and closing price trends for a given postal code. Requires OAuth2 authentication. Returns a JSON array of objects containing 'x_value', 'Asking', and 'Closing' data.

```json
[
  {
    "x_value": 2012,
    "Asking": 2423.6667,
    "Closing": 2002.9652
  }
]
```

--------------------------------

### Get Price Intervals Charts

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Retrieves the price intervals chart of the market. This endpoint allows users to get market price intervals for the provided inputs, including filtering by postal code, operation, property type, and various property features.

```APIDOC
## GET /public/market/charts/price_intervals

### Description
Retrieves the price intervals chart of the market. This endpoint allows users to get market price intervals for the provided inputs, including filtering by postal code, operation, property type, and various property features.

### Method
GET

### Endpoint
https://apiv2.atlas-reanalytics.com/public/market/charts/price_intervals

### Parameters
#### Query Parameters
- **postal_code** (string) - Required - The postal code for which to obtain the bedrooms supply chart.
- **operation** (string) - Optional - The operation type. Defaults to "buy".
- **property_type** (Array of strings) - Optional - The property type. Defaults to ["flat", "house"].
- **new_construction** (Array of integers) - Optional - The new construction type. Defaults to [0, 1].
- **attic** (Array of integers) - Optional - If it is an attic. Defaults to [0, 1].
- **duplex** (Array of integers) - Optional - If it is a duplex. Defaults to [0, 1].
- **ground_floor** (Array of integers) - Optional - If it is a ground floor. Defaults to [0, 1].
- **garage** (Array of integers) - Optional - If it has a garage. Defaults to [0, 1].
- **swimming_pool** (Array of integers) - Optional - If it has a swimming pool. Defaults to [0, 1].
- **storage** (Array of integers) - Optional - If it has a storage. Defaults to [0, 1].
- **bedrooms** (Array) - Optional - The number of bedrooms. Defaults to [0, 1, 2, 3, "4+"].
- **bathrooms** (Array) - Optional - The number of bathrooms. Defaults to [0, 1, 2, 3, "4+"].
- **area** (Array of integers) - Optional - The area of the property. Defaults to [0, 500].
- **aggregation** (string) - Optional - The aggregation type. Defaults to "postal_code".

### Response
#### Success Response (200)
Successful Response

#### Response Example
```json
null
```

### Error Handling
- **401**: Unauthorized
- **403**: Forbidden
- **404**: Not found
- **422**: Validation Error

### Authorization
Ensure that the current user is authorized to access this endpoint. (OAuth2PasswordBearer)
```

--------------------------------

### POST /public/user/portfolio

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Adds a new property to the user's portfolio. It accepts an array of property objects, each containing detailed information about the property.

```APIDOC
## POST /public/user/portfolio

### Description
Adds a new property to the user's portfolio. Accepts an array of property objects.

### Method
POST

### Endpoint
https://apiv2.atlas-reanalytics.com/public/user/portfolio

### Parameters
#### Request Body
- **address** (string) - Required - Address of the property
- **property_type** (string) - Optional - Type of property. Defaults to "flat". Enum: "house", "flat"
- **construction_type** (integer) - Optional - Type of construction. 0 for second hand, 1 for new. Defaults to 0.
- **area** (integer) - Required - Area of the property
- **bedrooms** (integer) - Required - Number of bedrooms
- **bathrooms** (integer) - Required - Number of bathrooms
- **garage** (boolean) - Required - Indicates if the property has a garage
- **lift** (boolean) - Required - Indicates if the property has a lift
- **storage** (boolean) - Required - Indicates if the property has storage
- **terrace** (boolean) - Required - Indicates if the property has a terrace
- **air_conditioned** (boolean) - Required - Indicates if the property is air-conditioned
- **pool** (boolean) - Required - Indicates if the property has a pool
- **garden** (boolean) - Required - Indicates if the property has a garden
- **sports** (boolean) - Required - Indicates if the property has sports facilities
- **conservation** (integer) - Optional - Property condition. 2: to reform, 3: regular, 4: good, 5: new/renovated. Defaults to 3.
- **price_buy** (number) - Optional - Purchase price of the property
- **latitude** (number) - Required - Latitude coordinate of the property
- **longitude** (number) - Required - Longitude coordinate of the property
- **postal_code** (string) - Optional - Postal code of the property
- **price_rent** (number) - Optional - Rental price of the property
- **valued** (boolean) - Optional - Indicates if the property has been valued. Defaults to false.
- **user** (object) - Optional - User details associated with the property
  - **name** (string) - Required - User's name
  - **lastname** (string) - Required - User's last name
  - **email** (string) - Required - User's email
- **valuation_date** (string) - Optional - Date of valuation in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ)

### Request Example
```json
[
  {
    "id": 0,
    "address": "string",
    "property_type": "house",
    "construction_type": 0,
    "area": 0,
    "bedrooms": 0,
    "bathrooms": 0,
    "garage": true,
    "lift": true,
    "storage": true,
    "terrace": true,
    "air_conditioned": true,
    "pool": true,
    "garden": true,
    "sports": true,
    "conservation": 2,
    "price_buy": 0,
    "latitude": 0,
    "longitude": 0,
    "postal_code": "string",
    "price_rent": 0,
    "valued": false,
    "user": {
      "name": "string",
      "lastname": "string",
      "email": "string"
    },
    "valuation_date": "2019-08-24T14:15:22Z"
  }
]
```

### Response
#### Success Response (200)
Returns an array of the created property objects.
#### Response Example
```json
{
  "data": [
    {
      "id": 0,
      "address": "string",
      "property_type": "house",
      "construction_type": 0,
      "area": 0,
      "bedrooms": 0,
      "bathrooms": 0,
      "garage": true,
      "lift": true,
      "storage": true,
      "terrace": true,
      "air_conditioned": true,
      "pool": true,
      "garden": true,
      "sports": true,
      "conservation": 2,
      "price_buy": 0,
      "latitude": 0,
      "longitude": 0,
      "postal_code": "string",
      "price_rent": 0,
      "valued": false,
      "user": {
        "name": "string",
        "lastname": "string",
        "email": "string"
      },
      "valuation_date": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0
}
```
```

--------------------------------

### GET /market/charts/supply_trends - Get Supply Trends Charts

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Retrieves market supply trends charts. Requires authorization. Parameters include postal code, operation, property type, construction details, number of rooms, area, and aggregation method. The endpoint returns market supply trends based on the provided criteria.

```http
GET https://apiv2.atlas-reanalytics.com/public/market/charts/price_trends?postal_code=28001&operation=buy&property_type=flat&new_construction=0&attic=0&duplex=0&ground_floor=0&garage=0&swimming_pool=0&storage=0&bedrooms=0&bathrooms=0&area=500 HTTP/1.1
Host: apiv2.atlas-reanalytics.com
Authorization: Bearer YOUR_ACCESS_TOKEN
```

--------------------------------

### Get Price M2 Trends Chart Endpoint Description

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Provides details for the 'Get Price M2 Trends Charts' endpoint, which retrieves market price per square meter trends. It outlines the required and optional parameters, their types, default values, and possible enumerations. Authorization is required to access this endpoint.

```markdown
## Get Price M2 Trends Charts 
Get the price m2 trends chart of the market.
  * `postal_code`: The postal code for which to obtain the bedrooms supply chart.
  * `operation`: The operation type. Defaults to "buy".
  * `property_type`: The property type. Defaults to ["flat", "house"].
  * `new_construction`: The new construction type. Defaults to [0, 1].
  * `attic`: If it is an attic. Defaults to [0, 1].
  * `duplex`: If it is a duplex. Defaults to [0, 1].
  * `ground_floor`: If it is a ground floor. Defaults to [0, 1].
  * `garage`: If it has a garage. Defaults to [0, 1].
  * `swimming_pool`: If it has a swimming pool. Defaults to [0, 1].
  * `storage`: If it has a storage. Defaults to [0, 1].
  * `bedrooms`: The number of bedrooms. Defaults to [0, 1, 2, 3, "4+"].
  * `bathrooms`: The number of bathrooms. Defaults to [0, 1, 2, 3, "4+"].
  * `area`: The area of the property. Defaults to [0, 500].
  * `aggregation`: The aggregation type. Defaults to "postal_code".


This endpoint returns market price m2 trends chart for the provided inputs.
### Authorization
Ensure that the current user is authorized to access this endpoint.
##### Authorizations:
_OAuth2PasswordBearer_
```

--------------------------------

### POST /public/market/pbsa/metrics/provision_rate

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Retrieves the PBSA provision rate overview for a given postal code or coordinates. It allows filtering by PBSA type.

```APIDOC
## POST /public/market/pbsa/metrics/provision_rate

### Description
Get the pbsa provision rate overview. This endpoint returns market pbsa provision rate overview for the provided inputs.

### Method
POST

### Endpoint
/public/market/pbsa/metrics/provision_rate

### Parameters
#### Request Body
- **postal_code** (array of strings) - Required - The postal code for which to obtain residences metrics.
- **coordinates** (array of any) - Optional - The coordinates of the polygon to obtain residences metrics.
- **pbsa_type** (array of strings) - Optional - The pbsa type to obtain residences metrics. Default: ["modern_standard", "religious", "public", "others", "student_residences", "pipeline"]. Items Enum: "modern_standard", "religious", "public", "others", "student_residences", "pipeline".

### Request Example
```json
{
  "postal_code": [
    "28001"
  ],
  "pbsa_type": [
    "modern_standard",
    "religious",
    "public",
    "others",
    "student_residences",
    "pipeline"
  ],
  "coordinates": [ ]
}
```

### Response
#### Success Response (200)
This endpoint returns a provision rate overview, the specific schema for the success response is not detailed in the provided text but would typically include metrics related to accommodation availability and demand.

#### Response Example
(Response example not provided in the input text.)

#### Error Responses
- **401**: Unauthorized
- **403**: Forbidden
- **404**: Not found
- **422**: Validation Error
```

--------------------------------

### GET /market_place/province_list

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

Retrieves a list of all available provinces.

```APIDOC
## GET /market_place/province_list

### Description
Retrieves a list of all available provinces.

### Method
GET

### Endpoint
/public/market_place/province_list

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **provinces** (array of strings) - A list of province names.

#### Response Example
```json
{
  "provinces": [
    "string"
  ]
}
```
```

--------------------------------

### Get Comparable Assets Data Request

Source: https://apiv2.atlas-reanalytics.com/public/redocs/index

This snippet shows a sample JSON payload for the POST request to the /comparable/assets/data endpoint. It includes parameters for asset class, aggregation, input data, operation type, price range, size range, property type, new construction, bedrooms, bathrooms, limit, and offset.

```json
{
  "asset_class": "residentials",
  "aggregation": "postal_code",
  "input": [
    "19001"
  ],
  "operation": "buy",
  "price_range": {
    "min_price": 0,
    "max_price": 6000000
  },
  "size_range": {
    "min_size": 0,
    "max_size": 500
  },
  "property_type": "flat",
  "new_construction": [
    0,
    1
  ],
  "bedrooms": [
    0,
    1,
    2,
    3,
    4
  ],
  "bathrooms": [
    0,
    1,
    2,
    3,
    4
  ],
  "limit": 10,
  "offset": 0
}
```