Appearance
propertydb-website
9 endpoints.
GET /api/v1/propertydb-website/auctions
Website Public Auctions
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
province | query | no | ||
city | query | no | ||
area | query | no | ||
property_type | query | no | ||
sheriff | query | no | ||
creditor | query | no | ||
q | query | no | ||
min_beds | query | no | ||
min_baths | query | no | ||
garage | query | no | boolean | |
min_reserve | query | no | ||
max_reserve | query | no | ||
no_reserve | query | no | boolean | |
min_extent | query | no | ||
date_from | query | no | ||
date_to | query | no | ||
ends | query | no | ||
kind | query | no | string | |
source | query | no | ||
vendor | query | no | ||
sort | query | no | string | |
page | query | no | integer | |
per_page | query | no | integer | |
authorization | header | no |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/propertydb-website/facets
Website Public Facets
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
kind | query | no | string | |
authorization | header | no |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/propertydb-website/auctions/{listing_id}
Website Public Auction
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
listing_id | path | yes | integer | |
authorization | header | no |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/propertydb-website/auctions/{listing_id}/area-sales
Website Public Auction Area Sales
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
listing_id | path | yes | integer | |
refresh | query | no | boolean | |
authorization | header | no |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/propertydb-website/samples
Website Samples
The free samples with every figure, best first, for the teaser rows on propertydb.co.za/auctions and /property-auctions (see _pdb_sample_ids).
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
kind | query | no | string | |
authorization | header | no |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/propertydb-website/me
Website Me
Who the renderer's visitor is: signed in or not, and their area plan.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
authorization | header | no |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/propertydb-website/me/city
Website Me City
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
authorization | header | no |
Request body
json
{
"properties": {
"city": {
"type": "string",
"title": "City"
}
},
"type": "object",
"required": [
"city"
],
"title": "_CityIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/propertydb-website/auctions/{listing_id}/photo
Website Photo
The auction's Street View photo (services/photos), or 404 for none.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
listing_id | path | yes | integer |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/propertydb-website/auctions/{listing_id}/location
Website Location
Where the auction is, for the auction page's "Open map" (owner, 2026-10-02: "add both"). Geocoded on request, never stored (Mapbox's temporary-geocoding terms). precision is exact / street / area — the page pins only an exact match. token is the estate's PUBLIC Mapbox token, the kind Mapbox issues for browsers (restrict it to propertydb.co.za in the Mapbox account).
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
listing_id | path | yes | integer |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}