API Reference

{
  "data": {
    // Response data here
  }
}

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Property with ID p_0x000123 not found",
    "details": {
      "resource": "property",
      "id": "p_0x000123"
    },
    "request_id": "req_abc123",
    "timestamp": "2024-01-01T12:00:00Z"
  }
}

const response = await vepler.property.list({
  limit: 20,
  cursor: "eyJpZCI6MTIzfQ"
});

// Response includes:
{
  "data": [...],
  "pagination": {
    "hasMore": true,
    "nextCursor": "eyJpZCI6MTQzfQ",
    "totalCount": 150
  }
}

const properties = await vepler.property.query({
  filters: {
    propertyType: "flat",
    bedrooms: { min: 2, max: 4 },
    price: { max: 500000 },
    location: {
      radius: 2000, // meters
      lat: 51.5074,
      lng: -0.1278
    }
  },
  sort: "price:asc"
});

const property = await vepler.property.get('UK-123', {
  fields: ['id', 'address', 'price', 'bedrooms']
});

X-RateLimit-Limit: 50
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1640995200

const response = await fetch('https://api.vepler.com/v1/property', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'Idempotency-Key': 'unique-request-id-123'
  },
  body: JSON.stringify(data)
});

const webhook = await vepler.webhooks.create({
  url: 'https://yourapp.com/webhooks/vepler',
  events: ['property.updated', 'listing.created'],
  secret: 'whsec_abc123'
});

import { Vepler } from 'vepler-sdk';

const vepler = new Vepler({
  apiKey: process.env.VEPLER_TEST_KEY,
  baseURL: 'https://sandbox.api.vepler.com'
});

// Sandbox data is reset daily
const testProperty = await vepler.property.get('p_0xTEST123456789');