GET assets/geo-clustered

Returns the list of clustered asset geo coordinates

Request

URL ( doesn't require authentication )

https://api.crexi.com/assets/geo-clustered?term={term}&types=types[0]&types=types[1]&statuses=statuses[0]&statuses=statuses[1]&tradingStatuses=tradingStatuses[0]&tradingStatuses=tradingStatuses[1]&askingPriceMin={askingPriceMin}&askingPriceMax={askingPriceMax}&capRateMin={capRateMin}&capRateMax={capRateMax}&brokerIds=brokerIds[0]&brokerIds=brokerIds[1]&hasBrokerCoOp={hasBrokerCoOp}&country={country}&brokerOrBrokerage={brokerOrBrokerage}&states=states[0]&states=states[1]&counties=counties[0]&counties=counties[1]&cities=cities[0]&cities=cities[1]&zips=zips[0]&zips=zips[1]&sqFtMin={sqFtMin}&sqFtMax={sqFtMax}&unitType={unitType}&unitMin={unitMin}&unitMax={unitMax}&leaseTypes=leaseTypes[0]&leaseTypes=leaseTypes[1]&tenancies=tenancies[0]&tenancies=tenancies[1]&tenantCredits=tenantCredits[0]&tenantCredits=tenantCredits[1]&remainingTermMin={remainingTermMin}&remainingTermMax={remainingTermMax}&geometry={geometry}&classes=classes[0]&classes=classes[1]&includeUnpriced={includeUnpriced}&occupancyMin={occupancyMin}&occupancyMax={occupancyMax}&acreageMin={acreageMin}&acreageMax={acreageMax}&latitudeMin={latitudeMin}&latitudeMax={latitudeMax}&longitudeMin={longitudeMin}&longitudeMax={longitudeMax}&zoom={zoom}&radius={radius}&mapWidth={mapWidth}&mapHeight={mapHeight}&activationPeriod={activationPeriod}&activationDateMin={activationDateMin}&activationDateMax={activationDateMax}&pricePerSqFtMin={pricePerSqFtMin}&pricePerSqFtMax={pricePerSqFtMax}&updatedSince={updatedSince}&isInOpportunityZone={isInOpportunityZone}

Parameters

acreageMax

decimal number

Optional

acreageMin

decimal number

Optional

activationDateMax

date

Max date of activation

Optional

activationDateMin

date

Min date of activation

Optional

activationPeriod

string

Activation period

Optional

Possible values are: 'TwentyFourHours', 'SevenDays', 'TwoWeeks', 'OneMonth', 'ThreeMonths', 'SixMonths', 'TwelveMonths', 'Custom'

askingPriceMax

decimal number

Maximum asking price

Optional

askingPriceMin

decimal number

Minimum asking price

Optional

brokerIds

Collection of integer

Array of broker ids

Optional

brokerOrBrokerage

string

BrokerOrBrokerage

Optional

capRateMax

decimal number

Maximum cap rate

Optional

capRateMin

decimal number

Minimum cap rate

Optional

cities

Collection of string

Cities

Optional

classes

Collection of string

Classes

Optional

Possible values are: 'A', 'B', 'C', 'D'

counties

Collection of string

Counties

Optional

country

string

Country

Optional

geometry

GeometryParameters

Polygons and Circles spatial filters. JSON object.

Optional

JSON: {"Polygons":[{"Coordinates":[{"Lt":41.849923,"Lg":-119.915771},{"Lt":38.973076,"Lg":-119.915771},{"Lt":35.99223,"Lg":-115.982666},{"Lt":36.098826,"Lg":-114.071045},{"Lt":41.882649,"Lg":-114.0271},{"Lt":41.849923,"Lg":-119.915771}]}],"Circles":[{"Coordinates":{"Lt":34.052234,"Lg":-118.243685},"Radius":0.34567}]}

hasBrokerCoOp

boolean

Has broker coop

Optional

includeUnpriced

boolean

Include Unpriced

Optional

isInOpportunityZone

boolean

Filters assets by their Opportunity Zone membership

Optional

latitudeMax

decimal number

Optional

latitudeMin

decimal number

Optional

leaseTypes

Collection of string

Lease types

Optional

Possible values are: 'Net', 'Absolute Net', 'Gross', 'Modified', 'Ground'

longitudeMax

decimal number

Optional

longitudeMin

decimal number

Optional

mapHeight

integer

Optional

mapWidth

integer

Optional

occupancyMax

decimal number

Optional

occupancyMin

decimal number

Optional

pricePerSqFtMax

decimal number

Maximum of price per square footage

Optional

pricePerSqFtMin

decimal number

Minimum of price per square footage

Optional

radius

unsigned integer

Optional

Default value is 40

remainingTermMax

integer

Maximum remaining term

Optional

remainingTermMin

integer

Minimum remaining term

Optional

sqFtMax

integer

Maximum square footage

Optional

sqFtMin

integer

Minimum square footage

Optional

states

Collection of string

States

Optional

statuses

Collection of string

Statuses

Optional

Possible values are: 'Under Contract', 'Active Listings', 'Contract Pending'

tenancies

Collection of string

Tenancies

Optional

Possible values are: 'Vacant', 'Single', 'Multi'

tenantCredits

Collection of string

Tenant credits

Optional

Possible values are: 'Credit Rated', 'Franchisee', 'Corporate Guarantee', 'No Credit Rating'

term

string

Asset search term

Optional

tradingStatuses

Collection of string

TradingStatuses

Optional

Possible values are: 'Best & Final', 'Call for Offers', 'Auction'

types

Collection of string

List of asset type names

Optional

Possible values are: 'Other', 'Multifamily', 'Retail', 'Office', 'Industrial', 'Self Storage', 'Mobile Home Park', 'Mixed Use', 'Hospitality', 'Land', 'Senior/Assisted Living', 'Development Site', 'Student Housing', 'Special Purpose', 'Medical Office', 'Note/Loan', 'Single Family Rental Portfolio'

unitMax

integer

Maximum unit value

Optional

unitMin

integer

Minimum unit value

Optional

unitType

string

Unit type

Optional

Possible values are: 'Units', 'Keys', 'Beds', 'Pads', 'Pumps'

updatedSince

date

Only return assets updated since the specified date

Optional

zips

Collection of string

Zips

Optional

zoom

unsigned integer

Optional

Response

Details

Returns an HTTP 200 OK and asset locations with clusters info if operation was successful. Returns 400 Bad Request and an error message otherwise.

Data fields

Assets

Collection of AssetGeoData

Center

GeoData

Clusters

Collection of GeoClusterData

Zoom

unsigned integer

Example

JSON

{
  "Assets": [
    {
      "AssetId": 10,
      "Latitude": 160.0,
      "Longitude": 90.0
    },
    {
      "AssetId": 10,
      "Latitude": 160.0,
      "Longitude": 90.0
    },
    {
      "AssetId": 10,
      "Latitude": 160.0,
      "Longitude": 90.0
    }
  ],
  "Center": {
    "Latitude": 160.0,
    "Longitude": 90.0
  },
  "Clusters": [
    {
      "Boundaries": {
        "LatitudeMax": 47.9,
        "LatitudeMin": 47.6550196,
        "LongitudeMax": -121.054332,
        "LongitudeMin": -122.6799419
      },
      "ClusterSize": 13,
      "Latitude": 130.0,
      "Longitude": 60.0
    },
    {
      "Boundaries": {
        "LatitudeMax": 47.9,
        "LatitudeMin": 47.6550196,
        "LongitudeMax": -121.054332,
        "LongitudeMin": -122.6799419
      },
      "ClusterSize": 1,
      "Latitude": 160.0,
      "Longitude": 90.0
    }
  ],
  "Zoom": 5
}