SPsprift
Property

Returns property map image, satellite image and street view image.

Changed on

Get property map and satellite with title plan polygon and Google street view images as base64 encoded string.

Images are Base64 encoded strings by default; pass imageFormat=url to get a presigned URL per image instead (SPR-8237).

get/property/{propertyID}/maps

Request

  • Base URL
    https://sprift.com/dashboard/api/v1
  • Auth
    HTTP basic

Path parameters

propertyIDinteger required

Property ID

Query parameters

imageFormat'base64' | 'url'

How the images are returned. base64 (default): data URIs embedded in the JSON, about 4.5 MB per answer. url: one presigned S3 URL per image, valid for 6 days, a few hundred bytes per answer (SPR-8237).

refresh'1'

Set to 1 to render the images again instead of serving the copies kept for a day (SPR-8237).

Headers

SPRIFT-API-KEYstring required

Sprift API Key

Response

Map, Satellite and Street View Images

statusboolean
propertyMapWithPolygonstring

OS map with the property polygon, rendered once per property and day. A base64 data URI, or a presigned URL valid 6 days when imageFormat=url.

propertySatelliteImagestring

Google satellite image with the polygon drawn, fetched once per property and day. A base64 data URI, or a presigned URL valid 6 days when imageFormat=url.

propertyStreetViewImagestring

Google Street View image. A base64 data URI, or with imageFormat=url the presigned S3 URL (valid 6 days), or the public no-street-view placeholder image URL when Google has no panorama for the property.

Changes

  • b92eb6075c18Revision changes
    • info

      added the new optional query request parameter imageFormat

    • info

      added the new optional query request parameter refresh