API Documentation

Complete reference for integrating with PropLoop

Authentication

All authenticated endpoints require a Bearer token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

Tokens are issued during user signup and can be retrieved via the login endpoint.

API Endpoints

Properties

GET

/properties

List all properties

Params: city, property_type, minPrice, maxPrice, limit, skip

GET

/properties/:id

Get property details

POST

/properties

Create new property

Requires Auth

Agents

GET

/agents

List agents

GET

/agents/:id

Get agent profile

GET

/agents/profile

Get current user profile

Requires Auth

Leads

GET

/leads

List leads

Requires Auth

POST

/leads

Create new lead

PUT

/leads/:id

Update lead status

Requires Auth

Viewing Requests

POST

/viewing-requests

Schedule property viewing

GET

/viewing-requests

List viewing requests

Requires Auth

Payments

POST

/checkout

Create checkout session

GET

/checkout/:session_id

Get checkout status

Co-Corretagem

GET

/co-corretagem

List opportunities

POST

/co-corretagem

Create opportunity

Requires Auth

POST

/co-corretagem/:id/interest

Express interest

Requires Auth

Code Examples

JavaScript/Fetch

// List properties with filters
fetch('https://api.proploop.com/properties?city=São Paulo&minPrice=400000&maxPrice=800000')
  .then(res => res.json())
  .then(data => console.debug(data))

Webhooks

PropLoop sends real-time notifications for important events:

property.created

When a property is listed

viewing.requested

When a viewing is requested

payment.completed

When payment is successful

lead.created

When a new lead is generated

Rate Limiting

Limit: 100 requests per minute per IP

Headers:

X-RateLimit-Limit: Total requests allowed
X-RateLimit-Remaining: Requests remaining
X-RateLimit-Reset: Timestamp when limit resets

Error Handling

Standard HTTP status codes are used:

200

Success

201

Created

400

Bad Request

401

Unauthorized

404

Not Found

429

Rate Limited