Pulse API
  1. Introduction
Pulse API
  • Introduction
    • Introduction
    • Getting Started
    • Basic concepts
  • Services
    • Backoffice
      • Authentication
        • Generate Access Token
        • Generate Refresh Token
      • Authorization
        • Rotate Key (User)
        • Register Application
        • List (Application)
        • Rotate Key (Application)
        • Revoke Key (Application)
        • Activate Key (Application)
      • Usage
        • Check limits
        • Check usage
    • Domains
      • Valuation
        • Valuation
      • Indicators
        • Indicators
      • Cadastral
        • Cadastral by portal id
        • Cadastral by Reference
      • Comparables
        • Search comparables
      • Mortgage
        • Pre-approval
      • Location
        • Suggest cadastral
  1. Introduction

Basic concepts

Environments#

We maintain three distinct environments: DEV, PRE (UAT), and PRO.
Important! Remember that each environment utilizes unique access tokens.
Development (DEV): This environment is private, exclusively accessible by Accumin.
Pre-Production (PRE/UAT): Access to the PRE/UAT environment is facilitated through the subdomain https://api-pre.urbandataanalytics.com.
Requested modifications are initially implemented and tested within the UAT environment.
Production (PRO): The PRO environment can be accessed via the https://api.urbandataanalytics.com subdomain.
Updates to production are scheduled to occur on specific, predefined dates, at predetermined times, incorporating changes that have been thoroughly tested and approved in the UAT environment.

Enums#

Comparison Type
0: Listing not active (Unpublished)
1: Listing active (Published)
2: Closing (Sold)
3: Appraisal
Vendor Type
0: Unknown
1: Particular
2: Agency
3: Bank
Activity Status
0: Not Active
1: Active
Duplication Status
0: Not Duplicated
1: Duplicated
Operation Type
0: Rent
1: Sale
Category id (area in sqm)
0: All
1: < 70
2: >= 70 area < 100
3: >= 100 area < 140
4: >= 140 area < 180
5: >= 180 area < 250
6: >= 250 area < 2000
7: > 2000
Typology
0: Unknown
1: Residential
2: Office
5: Local
6: Industrial Space
7: Garage
8: Land
11: Storage
12: Building
Property Type
0: Unknown
1: Penthouse
2: Duplex
3: Detached house or Villa
4: Flat
5: Semi-detached house
6: Terraced house
7: Study
8: Rustic property
Property Sub-Typology
0: Unknown
1: Single-family housing
2: Collective housing
Construction Type
0: Unknown
1: New construction
2: Second hand
3: Urban
4: Developable
5: Non-developable
Building Status
0: Unknown
1: Good condition
2: Partial reform
5: Total reform
6: Brand new
Space Distribution
0: Unknown
1: Diaphanous
4: Separated by screens
5: Partitioned
Similarity Index
0: Low
1: Medium
2: High
Boundary Type
10: Country (ie. "España")
11: Region (ie. "Comunidad Autonoma de Madrid" )
12: Province (ie. "Madrid")
13: Municipality (ie. "Madrid")
14: District (ie. "Chamberi")
15: Neighborhood (ie. "Almagro")
Country Codes
es: Spain
pt: Portugal
it: Italy
gr: Greece
uk: United Kingdom
mx: Mexico
pl: Poland

Cadastral Reference Schema#

Using iframes#

This guide provides steps for integrating an iframe into your frontend, which requires an access token for authentication.

Step 1: Generating an Access Token#

Before loading the iframe, you must generate an access token. This token acts as a key to authenticate and establish a secure communication channel.
Important! For security reasons, it is recommended to generate the access token in your backend.

Step 2: Embedding the Iframe#

After obtaining the access token, you need to embed the iframe into your frontend.

Syntax:#

Replace YOUR_IFRAME_URL with the actual URL of the iframe and YOUR_ACCESS_TOKEN with the token generated in Step 1.

Step 3: Listening to Events#

To capture and handle user interactions within the iframe, set up event listeners in your frontend code.

Key Events to Listen For:#

Event 1: [Description of Event 1]
Event 2: [Description of Event 2]
Event 3: [Description of Event 3]
Replace [Description of Event 1, 2, 3...] with the actual descriptions of the specific events you want to capture.

Adding Event Listeners:#

Use JavaScript to add event listeners to these specific events. Here's an example for adding a listener to Event 1:
Replace 'event1' and the handling code with the appropriate event name and your specific handling logic.

Example (JavaScript):#

Remember that generatedAccessToken must contain your previously generated token.
Follow these steps to ensure a secure and functional integration of the iframe into your application.
Modified at 2025-11-19 16:26:32
Previous
Getting Started
Next
Services
Built with