Skip to main content

Base URL

All API requests should be made to:
https://api.vepler.com/v1

Authentication

All requests require the x-api-key header. See the authentication guide for details.
HeaderValueRequired
x-api-keyYour API keyYes
Content-Typeapplication/jsonFor POST requests

Response Format

Success Response

Successful responses return a JSON object. The exact shape depends on the endpoint — refer to each endpoint’s documentation for details.
{
  "success": true,
  "result": [ ... ],
  "totalSize": 150,
  "size": 25,
  "hasMore": true,
  "nextOffset": 25
}

Error Response

{
  "error": {
    "code": "authentication_required",
    "message": "Invalid or missing API key"
  }
}

Pagination

List endpoints use offset-based pagination with limit and offset parameters:
// First page
const page1 = await fetch('https://api.vepler.com/v1/property/query', {
  method: 'POST',
  headers: { 'x-api-key': 'YOUR_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ area: [...], query: [...], limit: 25, offset: 0 })
});

// Next page
const page2 = await fetch('https://api.vepler.com/v1/property/query', {
  method: 'POST',
  headers: { 'x-api-key': 'YOUR_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ area: [...], query: [...], limit: 25, offset: 25 })
});
Paginated responses include:
FieldDescription
totalSize / totalTotal number of matching records
size / limitNumber of records returned in this page
hasMoreWhether more records exist
nextOffset / offsetOffset for the next page

Status Codes

CodeDescription
200Success
400Bad Request — invalid parameters
401Unauthorised — invalid or missing API key
403Forbidden — insufficient permissions
404Not Found — resource does not exist
422Unprocessable Entity — validation failed
429Too Many Requests — usage limit exceeded
500Internal Server Error
503Service Unavailable

Versioning

The API uses URL versioning. The current version is v1. Breaking changes will result in a new version.

Available Endpoints

Interactive API Explorer

Explore and test the API interactively:

Support

For API support: hello@vepler.com