Syndication Docs | SharpLaunch Docs

Introduction

Welcome to the SharpLaunch Syndication API! You can use this API to access the listings in our database.

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl --location  --request GET "https://app.sharplaunch.com/feed"
  --header 'X-APIKEY: yourapikey' \
  --header 'Content-Type: application/json' \

Make sure to replace yourapikey with your API key.

SharpLaunch Syndication uses API keys to allow access to the API. To obtain an API key please contact us.

SharpLaunch expects for the API key to be included in all API requests to the server in a header that looks like the following:

X-APIKEY: yourapikey

You must replace yourapikey with your API key.

The Listings Feed

# Sample feed response
{
    "items": [
        // items
    ],
    "total_items": 418,
    "current_page": 5,
    "total_pages": 21
}

GET https://app.sharplaunch.com/feed

Parameter	Description
items	Array of Listing Item
total_items	Total number of items (Integer)
current_page	Current page number (Integer)
total_pages	Total number of result pages (Integer)

Querystring Parameters

Please use the querystring parameters to get the next page of results or set the limit parameter.

GET https://app.sharplaunch.com/feed?page=5&limit=50

Parameter	Description
page	Page number
limit	Number of items per page (default 20, max 100)

curl "https://app.sharplaunch.com/feed?page=3"
  --header 'X-APIKEY: yourapikey' \
  --header 'Content-Type: application/json' \

Response:

{
	"items": [
		{
			"id": "10748",
			"url": "http://somber-mandolin.biz",
			"deal_room_url": null,
			"pdf_brochure_url": "http://smoggy-zone.org/pdf",
			"virtual_tour_url": null,
			"name": "179 Henderson Rapids",
			"description": "<p>Eum adipisci fugiat maiores laudantium cupiditate impedit beatae. Reprehenderit nisi velit. Quod nostrum vel fugiat. Labore quibusdam eius sint dolorum at<\/p>",
			"updated_at": "2023-07-28 16:36:50",
			"created_at": "2023-07-28 16:32:23",
			"highlights": [
				"Pariatur minima soluta.",
				"Qui sed consequatur asperiores quia possimus id accusantium.",
				"Nihil hic numquam dolorem laudantium.",
				"Aut quo suscipit.",
				"Eos repudiandae quos maxime.",
				"Alias corporis unde nihil tenetur dolore ab qui non.",
				"Debitis expedita ea consequuntur porro."
			],
			"address": "9167 Chadd Way",
			"city": "New Holden",
			"state": "IL",
			"zip": "14975-9496",
			"country": "United States",
			"coordinates": {
				"lat": -85.4944,
				"lng": 12.6419
			},
			"hero_image": "http://placeimg.com/640/480",
			"images": [],
			"availabilities": [],
			"documents": [
				{
					"name": "Property Flyer",
					"file_url": "http://aromatic-squash.com/pdf"
				}
			],
			"siteplan": [],
			"brokers": [
				{
					"name": "Jovani",
					"company": "Lockman Group",
					"position": "District Infrastructure Executive",
					"email": "Corine1@yahoo.com",
					"phone": "678-797-7921",
					"avatar": "https://cloudflare-ipfs.com/ipfs/Qmd3W5DuhgHirLHGVixi6V76LhCkZUz6pnFt5AJBiyvHye/avatar/303.jpg"
				}
			],
			"type": "office",
			"additional_types": [],
			"transaction": "lease",
			"surface": "960",
			"surface_unit": "sqft",
			"cap_rate": null,
			"year_built": null,
			"units": null,
			"sale_price": null,
			"sale_price_unit": null
		},
	],
	"total_items": 2013,
	"current_page": 3,
	"total_pages": 101
}

Options

Building type values

Those are the expected values for the building_type and additional_building_types options. Use the key value in the API.

Key	Value
office	Office
retail	Retail
industrial	Industrial
multifamily	Multifamily
hospitality	Hospitality
land	Land
mixed	Mixed-use
medical	Medical
self-storage	Self Storage
other	Other
special	Special
flex	Flex
farmranch	Farm & Ranch
residential	Residential

Unit type values

Key	Value
flex	Flex
hospitality	Hospitality
industrial	Industrial
lab	Lab
land	Land
medical	Medical
multifamily	Multifamily
office	Office
retail	Retail
restaurant	Restaurant
residential	Residential
special	Special Purpose

The Listing Object

# Sample feed item object
{
    "id": "1490",
    "url": "https://demo.sharplaunch.com",
    "deal_room_url": "https://demo.sharplaunch.com/signup",
    "pdf_brochure_url": "https://demo.sharplaunch.com/pdf",
    "virtual_tour_url": null,
    "name": "Intellicenter",
    "description": "Wasserman Capital Partners, as exclusive agent, is pleased to offer for sale the fee simple interest in Intellicenter (the “Property”), a three-story, 250,000 square foot, class A Silver LEED Certified building located in Atlanta's business district.",
    "updated_at": "2020-12-23 10:40:34",
    "highlights": [
        "23 Room Boutique Hotel",
        "Various commercial and residential buildings on site",
        // ...
    ],
    "address": "1354 South 2nd Street",
    "city": "Raton",
    "state": "NM",
    "zip": "87740",
    "country": "United States",
    "coordinates": {
        "lat": "36.87756139999999",
        "lng": "-104.44098919999999"
    },
    "images": [
        "https://d3k1yame0apvip.cloudfront.net/website-1490/de63483567da08c/back_of_building.jpg",
        "https://d3k1yame0apvip.cloudfront.net/website-1490/bf261a0e21ee30e/pool.jpg",
        // ...
    ],
    "availabilities": [
        // availabilities
    ],
    "siteplan": "https://d3k1yame0apvip.cloudfront.net/website-1490/bf261a0e21ee30e/pool.jpg",
    "brokers": [
        // brokers
    ],
    "type": "investment",
    "transaction": "sale",
    "surface": null,
    "surface_unit": "sqf",
    "cap_rate": null,
    "year_built": null,
    "units": null,
    "sale_price": "990000",
    "sale_price_unit": null
}

Parameter	Description
id	SharpLaunch unique id (string\|integer)
url	Listing URL (string)
deal_room_url	Listing's deal room URL (string)
pdf_brochure_url	Listing's PDF brochure URL (string)
virtual_tour_url	Listing's virtual tour URL (string)
name	Listing name (string)
description	Description (string)
updated_at	Last updated (string)
highlights	Listing highlights (array of string)
address	Street address (string)
city	City (string)
state	State (string)
zip	ZIP/Postal code (string)
country	Country (string)
coordinates	Latitude & Longitude (array)
images	Listing images (array of strings)
availabilities	Array of Availability (array)
siteplan	Site plan URL (string) JPG, PNG
brokers	Array of Broker (array)
type	Listing type (string) office, retail, industrial, multifamily, hospitality, land, mixed, medical, flex, special, farmranch, other (!list not exhaustive, some listings have custom types)
transaction	Transaction type (string) sale, lease, lease-sale, sublease
surface	Total listing surface (string\|integer)
surface_unit	Listing surface unit (string) sqft, sqm, ac
cap_rate	CAP rate (string)
year_built	Year built (string)
units	Units (string)
sale_price	Sale Price (string)
sale_price_unit	Sale price currency (string)

The Availability Object

# Sample availability item object
{
    "name": "3rd Floor Office",
    "transaction": null,
    "type": "office",
    "floor": null,
    "unit": null,
    "surface": "18000",
    "surface_min": "1600",
    "surface_contiguous": "18000",
    "surface_unit": "sqft",
    "rent": 12,
    "rent_type": 0,
    "file_url": null
}

Parameter	Description
name	Availability name (string)
transaction	Transaction type (string) sale, lease, lease-sale, sublease
type	Availability type (string) office, retail, industrial, multifamily, hospitality, land, mixed, medical, flex, special, farmranch, other (!list not exhaustive, some listings have custom types)
floor	Floor no (string)
unit	Unit no (string)
surface	Space surface (string\|integer)
surface_min	Space min divisible surface (string\|integer)
surface_contiguous	Space max contiguous surface (string\|integer)
surface_unit	Listing surface unit (string) sqft, sqm, ac
rent	Rent value (number)
rent_type	Rent type expected values: 0 - Amt/surface_unit/Year 1 - Amt/surface_unit/Month 2 - Amt/Year 3 - Amt/Month *(number)_
file_url	Floor plan URL (string) JPG, PNG, PDF formats

The Broker Object

# Sample broker object
{
    "name": "Steve Mondraker",
    "avatar": "https://d3k1yame0apvip.cloudfront.net/website-1277/b8c6d2db7860bb9/150x150/steve_monroe.jpg",
    "position": "Vice President",
    "phone": "(210) 426-1800",
    "email": "steve.mondraker@intellicenter.co",
    "company": "Intellicenter"
}

Parameter	Description
name	Broker name (string)
avatar	Broker photo URL (string)
position	Company position (string)
phone	Phone no (string)
email	Email address (string)
company	Company name (string)

Trackback

# With shell, you can just pass the correct header with each request
curl "https://app.sharplaunch.com/trackback/:id"
  --header 'X-APIKEY: yourapikey' \
  --header 'Content-Type: application/json' \
  -d '{"url": "https://partners.url/listing-slug"}'

Make sure to replace yourapikey and :id.

{ "url": "https://partners.url/listing-slug" }

We expect to be notified of the status of a syndicated listing. Please use the trackback API request to send back the URL of the listing on your platform.

POST https://app.sharplaunch.com/trackback/:id

Please send the listing url in the request body and the SharpLaunch ID as URL parameter.

URL Parameter	Description
id	SharpLaunch unique id (string)

# Introduction

# Authentication

# The Listings Feed

# Querystring Parameters

# Options

# Building type values

# Unit type values

# The Listing Object

# The Availability Object

# The Broker Object

# Trackback

Introduction

Authentication

The Listings Feed

Querystring Parameters

Options

Building type values

Unit type values

The Listing Object

The Availability Object

The Broker Object

Trackback