Offers Logo
API docs by Redocly

SkySlope Offers API Reference

Download OpenAPI specification:Download

Support: [email protected] URL: https://support.skyslope.com/hc/en-us Terms of Service

Introduction

The SkySlope Offers API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Authentication

The SkySlope Offers API uses OAuth 2.0 client credentials flow to obtain an access token that can be used to authenticate subsequent API requests.

To obtain an access token, see this endpoint.

Authentication to the API is performed by including your access token in the Authorization header of your API requests with the Bearer authentication scheme.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Agents, Listings

Retrieve an up-to-date agent listings & offers count

Retrieve the ten listings owned by this agent, that have most recently received offers. Sorted descending by offer submission date (most recent first).

path Parameters
agentId
string

The agent id used to filter the listings. Contact SkySlope for your MLS field mapping.

query Parameters
startDate
Date

yyyy-mm-dd

Optional parameter in ISO format yyyy-mm-ddT00:00:00.000Z to help separating listings with new offers from the rest.

If startDate is not provided, it's assumed to be 7 days prior to today.

If there exists listings with offers newer than startDate, the hasNewOffers indicator will be true otherwise false.

header Parameters
Authorization
required
string

Bearer ACCESS_TOKEN

"ACCESS_TOKEN" is the token returned from /ext/token

Responses

Request samples 

curl -X GET "https://offers.skyslope.com/offers-api/ext/agent/:agentId/listings?startDate=2023-01-01" -H "Authorization: Bearer ACCESS_TOKEN"

Response samples

Content type
application/json
{
  • "hasNewOffers": true,
  • "listings": []
}

Offers

Retrieve the offer details

Retrieves the offer details given the offer identifier

path Parameters
offerId
required
String

Offer Identifier

header Parameters
Authorization
required
string

Bearer ACCESS_TOKEN

"ACCESS_TOKEN" is the token returned from /ext/token

Responses

Request samples 

curl -X GET "https://offers.skyslope.com/offers-api/ext/offer/64510abe7d7e1f1dfac47393" -H "Authorization: Bearer ACCESS_TOKEN"

Response samples

Content type
application/json
{
  • "OfferId": "64510abe7d7e1f1dfac47393",
  • "OfferOriginatingSystemId": "SkySlope",
  • "OfferSourceSystemId": "SkySlope",
  • "ModificationTimestamp": "2023-05-02T13:18:21.439Z",
  • "OfferSubmissionDate": "2023-05-01T13:18:21.439Z",
  • "OfferProperty": {
    },
  • "OfferTerms": {
    }
}

Retrieve all offers for a given date range.

Retrieve all offers for a given date range.

query Parameters
startDate
required
Date

2023-01-01

The start of the date range in UTC format

endDate
Date

2023-01-31

The end of the date range in UTC format. Max date range is 31 days. When larger range is requested, result for 31 days is returned.

page
Number

Page number

pageSize
Number

Page size

header Parameters
Authorization
required
string

Bearer ACCESS_TOKEN

"ACCESS_TOKEN" is the token returned from /ext/token

Responses

Request samples 

curl -X GET "https://offers.skyslope.com/offers-api/ext/offers/?startDate=2023-01-01&endDate=2023-01-31" -H "Authorization: Bearer ACCESS_TOKEN"

Response samples

Content type
application/json
[
  • {
    }
]

Report

Retrieve count of listings & offers

Retrieves a count of listings & offers for the provided date range.

query Parameters
startDate
required
Date

2023-01-01

The start of the date range in UTC format

endDate
required
Date

2023-05-01

The end of the date range in UTC format

header Parameters
Authorization
required
string

Bearer ACCESS_TOKEN

"ACCESS_TOKEN" is the token returned from /ext/token

Responses

Request samples 

curl -X GET "https://offers.skyslope.com/offers-api/ext/report?startDate=2023-01-01&endDate=2023-04-26" -H "Authorization: Bearer ACCESS_TOKEN"

Response samples

Content type
application/json
{
  • "mlsMarket": "your-market",
  • "offerCount": 100,
  • "listingCount": 10
}

Auth

Retrieve an access token

Retrieve an access token to authenticate requests with.

header Parameters
Authorization
required
string

Basic BASE64_CREDENTIALS

"BASE64_CREDENTIALS" is the Base64-encoded value of your Client ID and Client Secret, separated by a colon

Responses

Request samples 

curl --location --request POST 'https://offers.skyslope.com/offers-api/ext/token' \ --header 'Authorization: Basic BASE64_CREDENTIALS'

Response samples

Content type
application/json
{
  • "token_type": "Bearer",
  • "expires_in": 3600,
  • "access_token": "ACCESS_TOKEN"
}