Skip to main content
GET
Get Trending Listings

Authorizations

x-api-key
string
header
required

Path Parameters

apiVersion
enum<string>
required
Available options:
v1-sandbox,
v1
apiProvince
enum<string>
default:on
required
Available options:
all,
on,
bc,
ab,
mb,
nb,
nl,
ns,
pe,
qc,
sk

Query Parameters

retrieveAttributes
string

Attributes to retrieve. For example: name, summary, builders, etc. It should be comma separated. See more info.

referrences
string

Fields to attach referrences. For example: builders, marketers, etc. It should be comma separated. See more info.

minScore
integer<int32>

Listings minimum score (from 0 to 100), 100 being most trending.

maxRecommendations
integer<int32>

Maximum number of recommendations/results. The maximum value is 30.

Response

200

results
object[]
perPage
integer
default:0
Example:

5

total
integer
default:0
Example:

5

pages
integer
default:0
Example:

1

page
integer
default:0
Example:

0