curl --request GET \
--url https://api.vepler.com/v1/v1/property/sources/{sourceIds} \
--header 'x-api-key: <api-key>'{
"success": true,
"result": [
{
"propertyId": "prop_123abc",
"locationId": "loc_456def",
"address": {
"displayAddress": "123 Example Street, London SW1A 1AA",
"postcode": "SW1A 1AA",
"streetName": "Example Street",
"streetNumber": "123",
"locality": "Westminster",
"town": "London",
"county": "Greater London",
"postcodeNoSpace": "SW1A1AA",
"outcode": "SW1A",
"incode": "1AA",
"country": "GB"
},
"spatial": {
"lat": 51.5074,
"lng": -0.1278,
"boundary": "<unknown>"
},
"classificationCode": "RD06",
"propertyType": "terraced",
"propertySubType": "Victorian terrace",
"roomDetails": {
"beds": 3,
"baths": 2,
"receptions": 1
},
"pricing": {
"currentSalePrice": 50000000,
"currentRentPrice": 250000,
"estimatedSaleValue": 52000000,
"estimatedRentValue": 260000,
"pricePerSqFt": 850,
"currency": "GBP"
},
"marketStatus": {
"forSale": "live",
"forRent": "unavailable",
"listingDate": "2024-01-15T00:00:00Z",
"soldDate": "2024-03-20T00:00:00Z",
"daysOnMarket": 65
},
"epc": {
"currentEnergyRating": "C",
"potentialEnergyRating": "B",
"currentEnergyEfficiency": 69,
"potentialEnergyEfficiency": 83,
"validFrom": "2023-06-15",
"validTo": "2033-06-14"
},
"saleHistory": [
{
"date": "2023-06-15",
"price": 45000000,
"propertyType": "terraced",
"newBuild": false
}
],
"tenure": {
"type": "freehold",
"leaseYearsRemaining": 95,
"groundRent": 25000,
"serviceCharge": 180000
},
"councilTax": {
"taxBand": "D",
"annualCharge": 180000,
"localAuthority": "Westminster City Council"
},
"tags": {
"newBuild": false,
"chainFree": true,
"auction": false,
"sharedOwnership": false,
"retirement": false,
"cashBuyersOnly": false,
"investment": false
},
"floorAreaSqM": 85,
"plotSizeSqM": 120,
"yearBuilt": 1890,
"lastUpdated": "2024-01-15T10:30:00Z"
}
],
"totalSize": 150,
"size": 25,
"hasMore": true,
"nextOffset": 25
}Retrieve property data using comma-separated source identifiers (e.g., provider-a::123)
curl --request GET \
--url https://api.vepler.com/v1/v1/property/sources/{sourceIds} \
--header 'x-api-key: <api-key>'{
"success": true,
"result": [
{
"propertyId": "prop_123abc",
"locationId": "loc_456def",
"address": {
"displayAddress": "123 Example Street, London SW1A 1AA",
"postcode": "SW1A 1AA",
"streetName": "Example Street",
"streetNumber": "123",
"locality": "Westminster",
"town": "London",
"county": "Greater London",
"postcodeNoSpace": "SW1A1AA",
"outcode": "SW1A",
"incode": "1AA",
"country": "GB"
},
"spatial": {
"lat": 51.5074,
"lng": -0.1278,
"boundary": "<unknown>"
},
"classificationCode": "RD06",
"propertyType": "terraced",
"propertySubType": "Victorian terrace",
"roomDetails": {
"beds": 3,
"baths": 2,
"receptions": 1
},
"pricing": {
"currentSalePrice": 50000000,
"currentRentPrice": 250000,
"estimatedSaleValue": 52000000,
"estimatedRentValue": 260000,
"pricePerSqFt": 850,
"currency": "GBP"
},
"marketStatus": {
"forSale": "live",
"forRent": "unavailable",
"listingDate": "2024-01-15T00:00:00Z",
"soldDate": "2024-03-20T00:00:00Z",
"daysOnMarket": 65
},
"epc": {
"currentEnergyRating": "C",
"potentialEnergyRating": "B",
"currentEnergyEfficiency": 69,
"potentialEnergyEfficiency": 83,
"validFrom": "2023-06-15",
"validTo": "2033-06-14"
},
"saleHistory": [
{
"date": "2023-06-15",
"price": 45000000,
"propertyType": "terraced",
"newBuild": false
}
],
"tenure": {
"type": "freehold",
"leaseYearsRemaining": 95,
"groundRent": 25000,
"serviceCharge": 180000
},
"councilTax": {
"taxBand": "D",
"annualCharge": 180000,
"localAuthority": "Westminster City Council"
},
"tags": {
"newBuild": false,
"chainFree": true,
"auction": false,
"sharedOwnership": false,
"retirement": false,
"cashBuyersOnly": false,
"investment": false
},
"floorAreaSqM": 85,
"plotSizeSqM": 120,
"yearBuilt": 1890,
"lastUpdated": "2024-01-15T10:30:00Z"
}
],
"totalSize": 150,
"size": 25,
"hasMore": true,
"nextOffset": 25
}API Key authentication for Vepler API. Get your API key from the Vepler dashboard.
Comma-separated list of source IDs (e.g., provider-a::123, provider-b::456)
Maximum number of results to return
Number of results to skip
Comma-separated list of attributes to include
Property data successfully retrieved
Array of property data objects
Show child attributes
Total number of properties matching the query
150
Number of properties returned in this response
25
Indicates if more results are available
true
Offset to use for next page of results
25
Was this page helpful?