DeskVal Property Valuation API

API Overview

The Property Valuation API provides endpoints for retrieving property attributes, submitting valuation requests, and checking valuation status. All endpoints return JSON responses.

Authentication

All endpoints on the DeskVal API require an API Key for access.

Your API key must be sent in the request headers as shown below:

If the API Key is missing, invalid, expired, or lacks access to the requested endpoint, the API will return a structured JSON error response.

Authentication Error Responses

Bad Request

{
  "error": "API key is missing. Please provide a valid API key in the request headers."
}

Unauthorized

{
  "error": "The provided API key is either invalid or expired. Please verify your key and try again."
}

Forbidden

{
  "error": "API key is inactive. Please activate this key or use a different valid API key."
}

Unauthorized

{
  "error": "Access denied: the provided API key does not have permission to use this API endpoint."
}

Rate Limit

All DeskVal API requests are subject to rate limiting

If the limit is exceeded, the API will return with 200 Too Many Requests response.

{
    "success": false,
    "msg": "Too many attempts. Please try again later."
}

Error Responses (Server & HTTP Errors)

Even if your request is valid, the API may return errors due to HTTP issues or server-side problems. The following are standard server error responses:

HTTP Errors Responses

Invalid Request Method

{
  "success": false,
  "message": "Invalid request method. Please verify the API documentation."
}

Internal Server Error

{
  "success": false,
  "message": "Internal Server Error. Please contact support if this persists."
}