Propalt API

Location Search

Endpoint:https://api.propalt.io

Address Lookup

GET

https://api.propalt.io

/location-search/address-lookup

Use for UK address lookup. Send keyword as a full postcode, outward code, local authority name, or free-text address. Set address to any truthy value to force full-text address search. Returns status and data; each result is an address, postcode, first_postcode, or authority item.

Address Lookup › query Parameters

keyword

string · maxLength: 200 · required

Search term. Determines the search strategy: full postcode (e.g. 'SW1A 1AA'), outward code (e.g. 'SW1A'), local authority name (e.g. 'BRISTOL'), or free-text address (e.g. '10 Downing Street'). Special characters other than letters, digits, spaces, commas, hyphens, apostrophes, and periods are stripped.

address

When present (any truthy value), forces Typesense full-text address search regardless of keyword format.

limit

Max results to return. Typesense default: 7; postcode suggestions default: 10.

Address Lookup › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Address Lookup › Responses

List of address, postcode, first_postcode, or authority results

Full response wrapper for address_lookup endpoint.

status

string · required

Always "OK" on success.

Example: OK

object[] · required

List of address, postcode, first_postcode, or authority results.

Example: {"0":{"lat":51.5034,"lng":-0.1276,"property_id":"12345","text":"10 Downing Street, Westminster, SW1A 2AA","type":"address"}}

GET/location-search/address-lookup

curl --request GET \
  --url 'https://api.propalt.io/location-search/address-lookup?keyword=%3Cstring%3E' \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "status": "OK",
  "data": [
    {
      "type": "address",
      "text": "10 Downing Street, Westminster, SW1A 2AA",
      "property_id": 0,
      "lat": 0,
      "lng": 0
    }
  ]
}

json

application/json

Street Lookup

POST

https://api.propalt.io

/location-search/street-lookup

Use for UK street or location search when the user provides query text. Returns up to 5 Google Places matches with formatted address, latitude and longitude, and the viewport converted to a closed WKT polygon.

Street Lookup › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Street Lookup › Request Body

Input for street_lookup endpoint.

query

string · minLength: 1 · maxLength: 200 · required

Street or location text to search in the UK via Google Places Text Search.

Example: london street

Street Lookup › Responses

Top Google Places street/location results with WKT viewport polygons

object[] · required

count

integer · required

POST/location-search/street-lookup

curl --request POST \
  --url https://api.propalt.io/location-search/street-lookup \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "london street"
}
'

shell

Example Request Body

{
  "query": "london street"
}

json

Example Responses

{
  "data": [
    {
      "query": "london street in UK",
      "address": "London St, London EC3M",
      "location": {
        "lat": 51.5118557,
        "lng": -0.0796838
      },
      "viewport": "POLYGON((-0.08099532585478048 51.5105157351916,-0.0782973652717764 51.5105157351916,-0.0782973652717764 51.5132136957746,-0.08099532585478048 51.5132136957746,-0.08099532585478048 51.5105157351916))"
    }
  ],
  "count": 0
}

json

application/json

Valuation Risk & Environmental

Address Lookup

GET

https://api.propalt.io

/location-search/address-lookup

Address Lookup › query Parameters

keyword

string · maxLength: 200 · required

address

When present (any truthy value), forces Typesense full-text address search regardless of keyword format.

limit

Max results to return. Typesense default: 7; postcode suggestions default: 10.

Address Lookup › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Address Lookup › Responses

List of address, postcode, first_postcode, or authority results

Full response wrapper for address_lookup endpoint.

status

string · required

Always "OK" on success.

Example: OK

object[] · required

List of address, postcode, first_postcode, or authority results.

Example: {"0":{"lat":51.5034,"lng":-0.1276,"property_id":"12345","text":"10 Downing Street, Westminster, SW1A 2AA","type":"address"}}

Street Lookup

POST

https://api.propalt.io

/location-search/street-lookup

Street Lookup › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Street Lookup › Request Body

Input for street_lookup endpoint.

query

string · minLength: 1 · maxLength: 200 · required

Street or location text to search in the UK via Google Places Text Search.

Example: london street

Street Lookup › Responses

Top Google Places street/location results with WKT viewport polygons

object[] · required

count

integer · required

curl --request POST \ --url https://api.propalt.io/location-search/street-lookup \ --header 'Authorization: <string>' \ --header 'Content-Type: application/json' \ --data ' { "query": "london street" } '

{ "data": [ { "query": "london street in UK", "address": "London St, London EC3M", "location": { "lat": 51.5118557, "lng": -0.0796838 }, "viewport": "POLYGON((-0.08099532585478048 51.5105157351916,-0.0782973652717764 51.5105157351916,-0.0782973652717764 51.5132136957746,-0.08099532585478048 51.5132136957746,-0.08099532585478048 51.5105157351916))" } ], "count": 0 }