AT AppointmentTrader
Sign In
Online Now  

/v1/marketdata/

Contains all market data related functions to allow sellers to pick up on trends throughout the year
GET

/v1/marketdata/get_city_hot_list

#
Returns the most-traded venues in a given city, with rank-change deltas. Powers the per-city Hot List page at /market-data/.

Parameters

NameTypeRequiredDefaultDescription
citySlug string Yes — CloseByCitySlug (e.g. los-angeles, new-york).
pageSize int No 20 Venues per page (1-50).
pageNumber int No 0 Zero-based page number.
categorySlug string No "" Optional category filter.
dateRange string No "90d" Activity window.
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_city_hot_list' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'citySlug={{citySlug}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}' \
  --data-urlencode 'categorySlug={{categorySlug}}' \
  --data-urlencode 'dateRange={{dateRange}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_city_hot_list_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.categorySlugstring Yes
$.oneOf[0].allOf[1].Payload.resolvedCategorySlugstring Yes
$.oneOf[0].allOf[1].Payload.seoCategorySlugstring Yes
$.oneOf[0].allOf[1].Payload.categoryTitlePluralstring Yes
$.oneOf[0].allOf[1].Payload.canonicalURL Yes
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[1] = false Yes
$.oneOf[0].allOf[1].Payload.category Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlugstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePluralstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDTypestring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.cityobject Yes
$.oneOf[0].allOf[1].Payload.city.cityNamestring Yes
$.oneOf[0].allOf[1].Payload.city.citySlugstring Yes
$.oneOf[0].allOf[1].Payload.city.countryCodestring Yes
$.oneOf[0].allOf[1].Payload.city.isoRegionstring Yes
$.oneOf[0].allOf[1].Payload.city.imageURL512string Yes
$.oneOf[0].allOf[1].Payload.city.canonicalURL Yes
$.oneOf[0].allOf[1].Payload.city.canonicalURL.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.city.canonicalURL.anyOf[1] = false Yes
$.oneOf[0].allOf[1].Payload.city.isRestrictedMarketboolean Yes
$.oneOf[0].allOf[1].Payload.city.showRevenueMetricsboolean Yes
$.oneOf[0].allOf[1].Payload.city.recentActivityobject Yes
$.oneOf[0].allOf[1].Payload.city.recentActivity.windowHoursinteger Yes
$.oneOf[0].allOf[1].Payload.city.recentActivity.peopleCountinteger Yes
$.oneOf[0].allOf[1].Payload.venuesarray Yes
$.oneOf[0].allOf[1].Payload.venues[]object No
$.oneOf[0].allOf[1].Payload.venues[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.venues[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.venues[].ratingCountinteger Yes
$.oneOf[0].allOf[1].Payload.venues[].externalRatingCountinteger Yes
$.oneOf[0].allOf[1].Payload.venues[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.venues[].tickerCodestring Yes
$.oneOf[0].allOf[1].Payload.venues[].namestring Yes
$.oneOf[0].allOf[1].Payload.venues[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.venues[].stateShortstring Yes
$.oneOf[0].allOf[1].Payload.venues[].countryShortstring Yes
$.oneOf[0].allOf[1].Payload.venues[].addressStringstring Yes
$.oneOf[0].allOf[1].Payload.venues[].categorySlugstring Yes
$.oneOf[0].allOf[1].Payload.venues[].categoryDescriptorstring Yes
$.oneOf[0].allOf[1].Payload.venues[].categoryIconstring Yes
$.oneOf[0].allOf[1].Payload.venues[].categoryJsonLDTypestring Yes
$.oneOf[0].allOf[1].Payload.venues[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.venues[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.venues[].imageColorstring Yes
$.oneOf[0].allOf[1].Payload.venues[].communitySnippetstring Yes
$.oneOf[0].allOf[1].Payload.venues[].communitySnippetURLstring Yes
$.oneOf[0].allOf[1].Payload.venues[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.venues[].coordinates Yes
$.oneOf[0].allOf[1].Payload.venues[].coordinates.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.venues[].coordinates.anyOf[0].latitudenumber Yes
$.oneOf[0].allOf[1].Payload.venues[].coordinates.anyOf[0].longitudenumber Yes
$.oneOf[0].allOf[1].Payload.venues[].coordinates.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.venues[].rating Yes
$.oneOf[0].allOf[1].Payload.venues[].rating.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.venues[].rating.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].externalRating Yes
$.oneOf[0].allOf[1].Payload.venues[].externalRating.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.venues[].externalRating.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].priceLevel Yes
$.oneOf[0].allOf[1].Payload.venues[].priceLevel.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.venues[].priceLevel.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].rating Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].rating.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].rating.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].ratingCountinteger Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].postCountinteger Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostTextstring Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostURLstring Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].reviewBoardNamestring Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].reviewBoardURLstring Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostTitlestring Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostAuthorAliasstring Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostCreatedDatestring Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestBoardNamestring Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestBoardURLstring Yes
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].minimumRatingCountinteger No
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].hasPublicRatingboolean No
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.venues[].showRevenueMetricsboolean Yes
$.oneOf[0].allOf[1].Payload.venues[].isRestrictedByRegulationboolean Yes
$.oneOf[0].allOf[1].Payload.venues[].userTrades Yes
$.oneOf[0].allOf[1].Payload.venues[].userTrades.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.venues[].userTrades.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].bidsLast30Day Yes
$.oneOf[0].allOf[1].Payload.venues[].bidsLast30Day.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.venues[].bidsLast30Day.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].avgPrice Yes
$.oneOf[0].allOf[1].Payload.venues[].avgPrice.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.venues[].avgPrice.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].visualInitialstring Yes
$.oneOf[0].allOf[1].Payload.venues[].visualPrimaryColorstring Yes
$.oneOf[0].allOf[1].Payload.venues[].visualSecondaryColorstring Yes
$.oneOf[0].allOf[1].Payload.venues[].visualTextColorstring Yes
$.oneOf[0].allOf[1].Payload.venues[].ugcImageURL256string Yes
$.oneOf[0].allOf[1].Payload.venues[].ugcImageURL512string Yes
$.oneOf[0].allOf[1].Payload.venues[].visualImageURL256string Yes
$.oneOf[0].allOf[1].Payload.venues[].visualImageURL512string Yes
$.oneOf[0].allOf[1].Payload.venues[].visualDisplayImageURL256string Yes
$.oneOf[0].allOf[1].Payload.venues[].visualDisplayImageURL512string Yes
$.oneOf[0].allOf[1].Payload.venues[].visualImageIsUGCboolean Yes
$.oneOf[0].allOf[1].Payload.venues[].visualDisplayImageSourcestring ["fallback","ugc","generated"] Yes
$.oneOf[0].allOf[1].Payload.venues[].streetNumberstring Yes
$.oneOf[0].allOf[1].Payload.venues[].streetstring Yes
$.oneOf[0].allOf[1].Payload.venues[].zipstring Yes
$.oneOf[0].allOf[1].Payload.venues[].ratingSourcestring Yes
$.oneOf[0].allOf[1].Payload.venues[].addedByUserAliasstring Yes
$.oneOf[0].allOf[1].Payload.venues[].addedYearMonthstring Yes
$.oneOf[0].allOf[1].Payload.venues[].mentionURLstring Yes
$.oneOf[0].allOf[1].Payload.venues[].localRankinteger Yes
$.oneOf[0].allOf[1].Payload.venues[].rankDelta30Day Yes
$.oneOf[0].allOf[1].Payload.venues[].rankDelta30Day.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.venues[].rankDelta30Day.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].priorRank Yes
$.oneOf[0].allOf[1].Payload.venues[].priorRank.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.venues[].priorRank.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeDataobject Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.1d Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.1d.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.1d.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.7d Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.7d.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.7d.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.30d Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.30d.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.30d.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.3mo Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.3mo.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.3mo.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.12mo Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.12mo.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.12mo.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.venues[].recentViewsinteger Yes
$.oneOf[0].allOf[1].Payload.pageSizeinteger Yes
$.oneOf[0].allOf[1].Payload.pageNumberinteger Yes
$.oneOf[0].allOf[1].Payload.dateRangestring ["7d","30d","90d","180d","365d"] Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_city_hot_list",
    "RequestUserAlias": "example-user",
    "Payload": {
        "categorySlug": "synthetic-example",
        "resolvedCategorySlug": "synthetic-example",
        "seoCategorySlug": "synthetic-example",
        "categoryTitlePlural": "synthetic-example",
        "canonicalURL": "synthetic-example",
        "category": {
            "id": 0,
            "slug": "synthetic-example",
            "seoSlug": "synthetic-example",
            "name": "synthetic-example",
            "titlePlural": "synthetic-example",
            "jsonLDType": "synthetic-example"
        },
        "city": {
            "cityName": "synthetic-example",
            "citySlug": "synthetic-example",
            "countryCode": "synthetic-example",
            "isoRegion": "synthetic-example",
            "imageURL512": "synthetic-example",
            "canonicalURL": "synthetic-example",
            "isRestrictedMarket": false,
            "showRevenueMetrics": false,
            "recentActivity": {
                "windowHours": 0,
                "peopleCount": 0
            }
        },
        "venues": [],
        "pageSize": 0,
        "pageNumber": 0,
        "dateRange": "7d"
    }
}
Machine-readable endpoint documentation
GET

/v1/marketdata/get_continent_country_top

#
Returns the top cities of an editorial continent, grouped by country. Editorial continents are: NA (North America incl. Canada/Mexico), EU (Europe), AS (Asia, excluding Middle East), MEA (Middle East & Africa), SA (South America), OC (Oceania).

Parameters

NameTypeRequiredDefaultDescription
continent string Yes — Editorial continent code: NA, EU, AS, MEA, SA, OC.
pageSize int No 100 Number of cities (1-100).
categorySlug string No "" Optional category filter.
dateRange string No "90d" Activity window.
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_continent_country_top' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'continent={{continent}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'categorySlug={{categorySlug}}' \
  --data-urlencode 'dateRange={{dateRange}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_continent_country_top_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.categorySlugstring Yes
$.oneOf[0].allOf[1].Payload.resolvedCategorySlugstring Yes
$.oneOf[0].allOf[1].Payload.seoCategorySlugstring Yes
$.oneOf[0].allOf[1].Payload.categoryTitlePluralstring Yes
$.oneOf[0].allOf[1].Payload.canonicalURL Yes
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[1] = false Yes
$.oneOf[0].allOf[1].Payload.category Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlugstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePluralstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDTypestring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.continentstring ["NA","EU","AS","MEA","SA","OC"] Yes
$.oneOf[0].allOf[1].Payload.countriesarray Yes
$.oneOf[0].allOf[1].Payload.countries[]object No
$.oneOf[0].allOf[1].Payload.countries[].countryCodestring Yes
$.oneOf[0].allOf[1].Payload.countries[].countryNamestring Yes
$.oneOf[0].allOf[1].Payload.countries[].citiesarray Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[]object No
$.oneOf[0].allOf[1].Payload.countries[].cities[].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].stateShortstring Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].isoRegionstring Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].countryCodestring Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].countryNamestring Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].continentShortstring Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].detailURLstring Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].tradingActivity30Dayinteger Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].numberTransactionsinteger Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].venueCountinteger Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].isHotboolean Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].avgTradingPrice Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].avgTradingPrice.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].avgTradingPrice.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinatesobject Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.latitude Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.latitude.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.latitude.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.longitude Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.longitude.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.longitude.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.countries[].cities[].distanceMetersnumber No
$.oneOf[0].allOf[1].Payload.countries[].cities[].distanceMilesnumber No
$.oneOf[0].allOf[1].Payload.totalCitiesinteger Yes
$.oneOf[0].allOf[1].Payload.dateRangestring ["7d","30d","90d","180d","365d"] Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_continent_country_top",
    "RequestUserAlias": "example-user",
    "Payload": {
        "categorySlug": "synthetic-example",
        "resolvedCategorySlug": "synthetic-example",
        "seoCategorySlug": "synthetic-example",
        "categoryTitlePlural": "synthetic-example",
        "canonicalURL": "synthetic-example",
        "category": {
            "id": 0,
            "slug": "synthetic-example",
            "seoSlug": "synthetic-example",
            "name": "synthetic-example",
            "titlePlural": "synthetic-example",
            "jsonLDType": "synthetic-example"
        },
        "continent": "NA",
        "countries": [],
        "totalCities": 0,
        "dateRange": "7d"
    }
}
Machine-readable endpoint documentation
GET

/v1/marketdata/get_highest_converting_locations

#
Returns the best converting venues, indicating the most demand for listings

Parameters

NameTypeRequiredDefaultDescription
pageSize int No 25 Defines how many results will be return per request
pageNumber int No 0 Defines which page should be returned
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_highest_converting_locations' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_highest_converting_locations_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Yes
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_highest_converting_locations",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": [],
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/marketdata/get_map_points

#
Returns signed-in Market Data map points for overview and city Hot List map panels.

Parameters

NameTypeRequiredDefaultDescription
scope string No "overview" overview or city.
citySlug string No "" CloseByCitySlug when scope=city.
west float No -180 Viewport west longitude.
south float No -85 Viewport south latitude.
east float No 180 Viewport east longitude.
north float No 85 Viewport north latitude.
zoom int No 2 Current map zoom. Below 6 returns city points; 6 and above returns location points.
pageSize int No 200 Number of points to return (1-300).
categorySlug string No "" Optional category filter.
dateRange string No "90d" Activity window: 7d, 30d, 90d, 180d, 365d.
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_map_points' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'scope={{scope}}' \
  --data-urlencode 'citySlug={{citySlug}}' \
  --data-urlencode 'west={{west}}' \
  --data-urlencode 'south={{south}}' \
  --data-urlencode 'east={{east}}' \
  --data-urlencode 'north={{north}}' \
  --data-urlencode 'zoom={{zoom}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'categorySlug={{categorySlug}}' \
  --data-urlencode 'dateRange={{dateRange}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_map_points_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.categorySlugstring Yes
$.oneOf[0].allOf[1].Payload.resolvedCategorySlugstring Yes
$.oneOf[0].allOf[1].Payload.seoCategorySlugstring Yes
$.oneOf[0].allOf[1].Payload.categoryTitlePluralstring Yes
$.oneOf[0].allOf[1].Payload.canonicalURL Yes
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[1] = false Yes
$.oneOf[0].allOf[1].Payload.category Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlugstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePluralstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDTypestring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.modestring ["cities","locations"] Yes
$.oneOf[0].allOf[1].Payload.scopestring ["overview","city"] Yes
$.oneOf[0].allOf[1].Payload.citySlugstring Yes
$.oneOf[0].allOf[1].Payload.citiesarray Yes
$.oneOf[0].allOf[1].Payload.cities[]object No
$.oneOf[0].allOf[1].Payload.cities[].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.cities[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.cities[].stateShortstring Yes
$.oneOf[0].allOf[1].Payload.cities[].isoRegionstring Yes
$.oneOf[0].allOf[1].Payload.cities[].countryCodestring Yes
$.oneOf[0].allOf[1].Payload.cities[].countryNamestring Yes
$.oneOf[0].allOf[1].Payload.cities[].continentShortstring Yes
$.oneOf[0].allOf[1].Payload.cities[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.cities[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.cities[].detailURLstring Yes
$.oneOf[0].allOf[1].Payload.cities[].tradingActivity30Dayinteger Yes
$.oneOf[0].allOf[1].Payload.cities[].numberTransactionsinteger Yes
$.oneOf[0].allOf[1].Payload.cities[].venueCountinteger Yes
$.oneOf[0].allOf[1].Payload.cities[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice Yes
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinatesobject Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.cities[].distanceMetersnumber No
$.oneOf[0].allOf[1].Payload.cities[].distanceMilesnumber No
$.oneOf[0].allOf[1].Payload.cities[].regionLabelstring Yes
$.oneOf[0].allOf[1].Payload.locationsarray Yes
$.oneOf[0].allOf[1].Payload.locations[]object No
$.oneOf[0].allOf[1].Payload.locations[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.locations[].locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.locations[].ratingCountinteger Yes
$.oneOf[0].allOf[1].Payload.locations[].externalRatingCountinteger Yes
$.oneOf[0].allOf[1].Payload.locations[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.locations[].tickerCodestring Yes
$.oneOf[0].allOf[1].Payload.locations[].namestring Yes
$.oneOf[0].allOf[1].Payload.locations[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.locations[].stateShortstring Yes
$.oneOf[0].allOf[1].Payload.locations[].countryShortstring Yes
$.oneOf[0].allOf[1].Payload.locations[].closeByCitySlugstring Yes
$.oneOf[0].allOf[1].Payload.locations[].addressStringstring Yes
$.oneOf[0].allOf[1].Payload.locations[].categorySlugstring Yes
$.oneOf[0].allOf[1].Payload.locations[].categoryDescriptorstring Yes
$.oneOf[0].allOf[1].Payload.locations[].categoryIconstring Yes
$.oneOf[0].allOf[1].Payload.locations[].categoryJsonLDTypestring Yes
$.oneOf[0].allOf[1].Payload.locations[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.locations[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.locations[].imageColorstring Yes
$.oneOf[0].allOf[1].Payload.locations[].communitySnippetstring Yes
$.oneOf[0].allOf[1].Payload.locations[].communitySnippetURLstring Yes
$.oneOf[0].allOf[1].Payload.locations[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.locations[].cityDetailURLstring Yes
$.oneOf[0].allOf[1].Payload.locations[].coordinatesobject Yes
$.oneOf[0].allOf[1].Payload.locations[].coordinates.latitudenumber Yes
$.oneOf[0].allOf[1].Payload.locations[].coordinates.longitudenumber Yes
$.oneOf[0].allOf[1].Payload.locations[].rating Yes
$.oneOf[0].allOf[1].Payload.locations[].rating.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.locations[].rating.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.locations[].externalRating Yes
$.oneOf[0].allOf[1].Payload.locations[].externalRating.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.locations[].externalRating.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.locations[].priceLevel Yes
$.oneOf[0].allOf[1].Payload.locations[].priceLevel.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.locations[].priceLevel.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.locations[].communityContextobject Yes
$.oneOf[0].allOf[1].Payload.locations[].communityContext.rating Yes
$.oneOf[0].allOf[1].Payload.locations[].communityContext.rating.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.locations[].communityContext.rating.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.locations[].communityContext.ratingCountinteger Yes
$.oneOf[0].allOf[1].Payload.locations[].communityContext.postCountinteger Yes
$.oneOf[0].allOf[1].Payload.locations[].communityContext.latestPostTextstring Yes
$.oneOf[0].allOf[1].Payload.locations[].communityContext.latestPostURLstring Yes
$.oneOf[0].allOf[1].Payload.locations[].communityContext.reviewBoardNamestring Yes
$.oneOf[0].allOf[1].Payload.locations[].communityContext.reviewBoardURLstring Yes
$.oneOf[0].allOf[1].Payload.locations[].showRevenueMetricsboolean Yes
$.oneOf[0].allOf[1].Payload.locations[].isRestrictedByRegulationboolean Yes
$.oneOf[0].allOf[1].Payload.locations[].userTrades Yes
$.oneOf[0].allOf[1].Payload.locations[].userTrades.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.locations[].userTrades.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.locations[].bidsLast30Day Yes
$.oneOf[0].allOf[1].Payload.locations[].bidsLast30Day.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.locations[].bidsLast30Day.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.locations[].avgPrice Yes
$.oneOf[0].allOf[1].Payload.locations[].avgPrice.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.locations[].avgPrice.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.locations[].visualInitialstring Yes
$.oneOf[0].allOf[1].Payload.locations[].visualPrimaryColorstring Yes
$.oneOf[0].allOf[1].Payload.locations[].visualSecondaryColorstring Yes
$.oneOf[0].allOf[1].Payload.locations[].visualTextColorstring Yes
$.oneOf[0].allOf[1].Payload.locations[].ugcImageURL256string Yes
$.oneOf[0].allOf[1].Payload.locations[].ugcImageURL512string Yes
$.oneOf[0].allOf[1].Payload.locations[].visualImageURL256string Yes
$.oneOf[0].allOf[1].Payload.locations[].visualImageURL512string Yes
$.oneOf[0].allOf[1].Payload.locations[].visualDisplayImageURL256string Yes
$.oneOf[0].allOf[1].Payload.locations[].visualDisplayImageURL512string Yes
$.oneOf[0].allOf[1].Payload.locations[].visualImageIsUGCboolean Yes
$.oneOf[0].allOf[1].Payload.locations[].visualDisplayImageSourcestring ["fallback","ugc","generated"] Yes
$.oneOf[0].allOf[1].Payload.viewportobject Yes
$.oneOf[0].allOf[1].Payload.viewport.westnumber Yes
$.oneOf[0].allOf[1].Payload.viewport.southnumber Yes
$.oneOf[0].allOf[1].Payload.viewport.eastnumber Yes
$.oneOf[0].allOf[1].Payload.viewport.northnumber Yes
$.oneOf[0].allOf[1].Payload.viewport.zoomnumber Yes
$.oneOf[0].allOf[1].Payload.totalResultsinteger Yes
$.oneOf[0].allOf[1].Payload.dateRangestring ["7d","30d","90d","180d","365d"] Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_map_points",
    "RequestUserAlias": "example-user",
    "Payload": {
        "categorySlug": "synthetic-example",
        "resolvedCategorySlug": "synthetic-example",
        "seoCategorySlug": "synthetic-example",
        "categoryTitlePlural": "synthetic-example",
        "canonicalURL": "synthetic-example",
        "category": {
            "id": 0,
            "slug": "synthetic-example",
            "seoSlug": "synthetic-example",
            "name": "synthetic-example",
            "titlePlural": "synthetic-example",
            "jsonLDType": "synthetic-example"
        },
        "mode": "cities",
        "scope": "overview",
        "citySlug": "synthetic-example",
        "cities": [],
        "locations": [],
        "viewport": {
            "west": 0,
            "south": 0,
            "east": 0,
            "north": 0,
            "zoom": 0
        },
        "totalResults": 0,
        "dateRange": "7d"
    }
}
Machine-readable endpoint documentation
GET

/v1/marketdata/get_most_bids_least_asks

#
Returns locations with the highest bids vs listing ratio

Parameters

NameTypeRequiredDefaultDescription
pageSize int No 25 Defines how many results will be return per request
pageNumber int No 0 Defines which page should be returned
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_most_bids_least_asks' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_most_bids_least_asks_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Yes
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_most_bids_least_asks",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": [],
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/marketdata/get_most_underserved_locations

#
Returns locations with the most bids and the least number of listings in the past 30 days

Parameters

NameTypeRequiredDefaultDescription
pageSize int No 25 Defines how many results will be return per request
pageNumber int No 0 Defines which page should be returned
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_most_underserved_locations' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_most_underserved_locations_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Yes
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings = 0 Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_most_underserved_locations",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": [],
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/marketdata/get_most_viewed_locations_with_least_listings

#
Returns the most viewed locations with the least amount of listings

Parameters

NameTypeRequiredDefaultDescription
pageSize int No 25 Defines how many results will be return per request
pageNumber int No 0 Defines which page should be returned
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_most_viewed_locations_with_least_listings' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_most_viewed_locations_with_least_listings_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Yes
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_most_viewed_locations_with_least_listings",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": [],
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/marketdata/get_recently_viewed

#
Returns signed-in caller-scoped recently viewed listings, marketplace locations, cities, communities, profiles, plus viewer-owned My Bookings and active request tiles when available. Public-by-design: anonymous callers do not read session/IP recently viewed history and receive the trending fallback instead. Signed-in callers receive only their own user-scoped history, caller-owned plan and pending-request summaries, and profile views recorded for that caller. It exposes no private history, plans, or requests for other users.

Parameters

NameTypeRequiredDefaultDescription
pageSize int No 12 Number of recently viewed items to return (1-20).
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_recently_viewed' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_recently_viewed_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.itemsarray Yes
$.oneOf[0].allOf[1].Payload.items[] No
$.oneOf[0].allOf[1].Payload.items[].oneOf[0]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].idstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].subtitlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].typeLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].iconTextstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].lastViewedAtstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].url Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].url.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].url.anyOf[1] = false Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].lastViewIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].type = "city" Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].cityobject Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.citySlugstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.cityNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.stateShortstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.isoRegionstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.countryCodestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.countryNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.continentShortstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.imageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.imageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.detailURLstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.tradingActivity30Dayinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.numberTransactionsinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.venueCountinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.avgTradingPrice Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.avgTradingPrice.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.avgTradingPrice.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.coordinatesobject Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.coordinates.latitude Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.coordinates.latitude.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.coordinates.latitude.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.coordinates.longitude Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.coordinates.longitude.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.coordinates.longitude.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.distanceMetersnumber No
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.distanceMilesnumber No
$.oneOf[0].allOf[1].Payload.items[].oneOf[0].isFallback = true No
$.oneOf[0].allOf[1].Payload.items[].oneOf[1]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].idstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].titlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].subtitlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].typeLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].iconTextstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].lastViewedAtstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].urlstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].lastViewIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualInitialstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualPrimaryColorstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualSecondaryColorstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualTextColorstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].ugcImageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].ugcImageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualImageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualImageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualDisplayImageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualDisplayImageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualImageIsUGCboolean Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualDisplayImageSourcestring ["fallback","ugc","generated"] Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].type = "location" Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].tickerCodestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].locationobject Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.locationIDDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.locationID.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.locationID.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.namestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.aliasstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.ticker Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.ticker.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.ticker.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.cityNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.stateShortstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.countryCodestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.citySlug Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.citySlug.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.citySlug.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.imageBasePath Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.imageBasePath.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.imageBasePath.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.lastViewIDDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.lastViewID.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.lastViewID.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.lastViewedAtstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[1].isRestrictedByRegulationboolean Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].idstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].titlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].subtitlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].typeLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].iconTextstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].lastViewedAtstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].urlstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].lastViewIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualInitialstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualPrimaryColorstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualSecondaryColorstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualTextColorstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].ugcImageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].ugcImageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualImageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualImageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualDisplayImageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualDisplayImageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualImageIsUGCboolean Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualDisplayImageSourcestring ["fallback","ugc","generated"] Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].type = "listing" Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].discussionPostIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].discussionPostUrlstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].discussionCommentCountinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].tickerCodestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listingobject Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.appointmentIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.discussionPostIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.listingUUIDstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.locationNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.locationTickerstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.inventoryTypeNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.datestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.dateLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.timestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.cityNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.citySlugstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.discussionPostUrlstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[2].isRestrictedByRegulationboolean Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].idstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].titlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].subtitlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].typeLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].iconTextstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].lastViewedAtstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].urlstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].lastViewIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].type = "board" Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].pillsarray Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].pills[]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].pills[].labelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].boardobject Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.boardIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.namestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.boardTypestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.urlAliasstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.urlstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.cityNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.citySlugstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.stateShortstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.countryCodestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageRolestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.lastViewedAtstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.isRestrictedinteger [0,1] Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.viewerCanReadinteger [0,1] Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.viewerCanWriteinteger [0,1] Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageFrame Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageFrame.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageFrame.anyOf[0].positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageFrame.anyOf[0].positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageFrame.anyOf[0].zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageFrame.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.lastViewIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].isRestrictedboolean Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].viewerCanReadboolean Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[3].viewerCanWriteboolean Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].idstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].titlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].subtitlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].typeLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].iconTextstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].lastViewedAtstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].urlstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].lastViewIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].type = "profile" Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profileobject Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.userIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.aliasstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileURLstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].idstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].titlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].subtitlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].typeLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].iconTextstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].lastViewedAtstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].urlstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].lastViewIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].type = "plans" Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plansobject Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.appointmentIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.locationNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.datestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.cityCodestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCitiesarray Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCities[]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCities[].labelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCities[].countinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCities[].cityLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCities[].cityCodestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCities[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pillsarray Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pills[]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pills[].labelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pills[].countinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pills[].cityLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pills[].cityCodestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pills[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].idstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].titlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].subtitlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].typeLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].iconTextstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].lastViewedAtstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].urlstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].lastViewIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].type = "requests" Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requestsobject Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.countinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.primaryBidIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.primaryPostIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.locationNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.dateLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.cityLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].pillsarray Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].pills[]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].pills[].labelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].pills[].countinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[6].pills[].cityLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].idstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].titlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].subtitlestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].typeLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].iconTextstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].lastViewedAtstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].urlstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].lastViewIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].type = "plans_requests" Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plansobject Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.appointmentIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.locationNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.datestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.cityCodestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCitiesarray Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCities[]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCities[].labelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCities[].countinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCities[].cityLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCities[].cityCodestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCities[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requestsobject Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.countinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.primaryBidIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.primaryPostIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.locationIDinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.locationNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.dateLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.cityLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pillsarray Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[] No
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[0]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[0].labelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[0].countinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[0].cityLabelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[0].cityCodestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[0].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[1]object No
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[1].labelstring Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[1].countinteger Yes
$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[1].cityLabelstring Yes
$.oneOf[0].allOf[1].Payload.totalResultsinteger Yes
$.oneOf[0].allOf[1].Payload.sourcestring ["history","trending_nearby","trending_world","empty"] Yes
$.oneOf[0].allOf[1].Payload.closestCityobject Yes
$.oneOf[0].allOf[1].Payload.closestCity.namestring Yes
$.oneOf[0].allOf[1].Payload.closestCity.slugstring Yes
$.oneOf[0].allOf[1].Payload.closestCity.countryCodestring Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_recently_viewed",
    "RequestUserAlias": "example-user",
    "Payload": {
        "items": [],
        "totalResults": 0,
        "source": "history",
        "closestCity": {
            "name": "synthetic-example",
            "slug": "synthetic-example",
            "countryCode": "synthetic-example"
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/marketdata/get_required_inventory_forecast

#
Returns inventory that may have high chance of selling based on historical data

Parameters

NameTypeRequiredDefaultDescription
locationAlias string Yes — Slug found after the slash when opening a location in the portal
dateRangeStart string Yes — oldest date of metrics to be reported Date format: YYYY-MM-DD
dateRangeEnd string Yes — latest date of metrics to be reported Date format: YYYY-MM-DD
additionalLocationAliasSourceList string No "" Comma separated List of other locations that should be used as a data source for the forecast, related locations can be found at /v1/location/get_related_location_list
maximumPrice int No 0 Items to exclude based on price
desiredProfitBasisPoints int No 10000 defines how much profit should be made per line item
pageSize int No 1500 Defines how many results will be return per request
pageNumber int No 0 Defines which page should be returned
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_required_inventory_forecast' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'locationAlias={{locationAlias}}' \
  --data-urlencode 'dateRangeStart={{dateRangeStart}}' \
  --data-urlencode 'dateRangeEnd={{dateRangeEnd}}' \
  --data-urlencode 'additionalLocationAliasSourceList={{additionalLocationAliasSourceList}}' \
  --data-urlencode 'maximumPrice={{maximumPrice}}' \
  --data-urlencode 'desiredProfitBasisPoints={{desiredProfitBasisPoints}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_required_inventory_forecast_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Yes
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.yearOverYearAverageMarketPriceChangenumber Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberSuggestedTransactions = 0 Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberSuggestedBids = 0 Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberSuggestedListingPurchases = 0 Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalSuggestedDollarVolume = 0 Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.numberHistoricalTransactionsinteger Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentNumberBidsinteger Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentHighBidinteger Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentLowBidinteger Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentBidVolumeinteger Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentNumberListingsinteger Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentListingHighPriceinteger Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentListingLowPriceinteger Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentListingAveragePriceinteger Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.averagePricenumber Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.minimumPricenumber Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.maximumPricenumber Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.totalDemandnumber Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].CreatedDatestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastUpdateDatestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Namestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Descriptionstring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].URLstring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Icon Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Icon.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Icon.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].event-locationAlias Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].event-locationAlias.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].event-locationAlias.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrameobject Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.StartTime Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.StartTime.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.StartTime.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.EndTime Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.EndTime.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.EndTime.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastPeriodTimeFrameobject Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastPeriodTimeFrame.StartTimestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastPeriodTimeFrame.EndTimestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.sourceDataLocationAliasListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.sourceDataLocationAliasList[]string No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.lastYearsCorrespondingDayListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.lastYearsCorrespondingDayList[]string No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[1]array Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_required_inventory_forecast",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": {
                "yearOverYearAverageMarketPriceChange": 0,
                "totalNumberSuggestedTransactions": 0,
                "totalNumberSuggestedBids": 0,
                "totalNumberSuggestedListingPurchases": 0,
                "totalSuggestedDollarVolume": 0
            },
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/marketdata/get_toplist

#
Returns locations with the most bids and the least number of listings in the past 30 days

Parameters

NameTypeRequiredDefaultDescription
cityCode string No "" The code of the City that is being queried If left empty worldwide results are being returned Exemplary Value: NYC
categorySlug string No "" The slug of the location category that is being requested. If left empty all categories are being returned. Exemplary Value: restaurants
pageSize int No 25 Defines how many results will be return per request
pageNumber int No 0 Defines which page should be returned
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_toplist' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'cityCode={{cityCode}}' \
  --data-urlencode 'categorySlug={{categorySlug}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_toplist_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Yes
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocationsDatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocations.oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocations.oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0]DatabaseInteger YesInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0].oneOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0].oneOf[1]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRankChangeData YesPipe-separated changes for 1 day, 7 days, 30 days, 3 months and 12 months; empty segments mean unavailable.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRankChangeData.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRankChangeData.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRankChangeData YesPipe-separated changes for 1 day, 7 days, 30 days, 3 months and 12 months; empty segments mean unavailable.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRankChangeData.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRankChangeData.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Yes
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_toplist",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": {
                "TotalNumberLocations": 0
            },
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}
Machine-readable endpoint documentation
GET

/v1/marketdata/get_trending_near

#
Returns the cities trending closest to a given lat/long. Resolves the closest city via ATAirport proximity, then returns cities within that city's continent ordered by distance, using activity as the tie-breaker. Used by the Market Data page's "Trending near you" row.

Parameters

NameTypeRequiredDefaultDescription
lat float Yes — Latitude in decimal degrees.
long float Yes — Longitude in decimal degrees.
pageSize int No 4 Number of cities to return (1-20).
categorySlug string No "" Optional category filter.
dateRange string No "90d" Activity window.
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_trending_near' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'lat={{lat}}' \
  --data-urlencode 'long={{long}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'categorySlug={{categorySlug}}' \
  --data-urlencode 'dateRange={{dateRange}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_trending_near_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.categorySlugstring Yes
$.oneOf[0].allOf[1].Payload.resolvedCategorySlugstring Yes
$.oneOf[0].allOf[1].Payload.seoCategorySlugstring Yes
$.oneOf[0].allOf[1].Payload.categoryTitlePluralstring Yes
$.oneOf[0].allOf[1].Payload.canonicalURL Yes
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[1] = false Yes
$.oneOf[0].allOf[1].Payload.category Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlugstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePluralstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDTypestring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.citiesarray Yes
$.oneOf[0].allOf[1].Payload.cities[]object No
$.oneOf[0].allOf[1].Payload.cities[].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.cities[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.cities[].stateShortstring Yes
$.oneOf[0].allOf[1].Payload.cities[].isoRegionstring Yes
$.oneOf[0].allOf[1].Payload.cities[].countryCodestring Yes
$.oneOf[0].allOf[1].Payload.cities[].countryNamestring Yes
$.oneOf[0].allOf[1].Payload.cities[].continentShortstring Yes
$.oneOf[0].allOf[1].Payload.cities[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.cities[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.cities[].detailURLstring Yes
$.oneOf[0].allOf[1].Payload.cities[].tradingActivity30Dayinteger Yes
$.oneOf[0].allOf[1].Payload.cities[].numberTransactionsinteger Yes
$.oneOf[0].allOf[1].Payload.cities[].venueCountinteger Yes
$.oneOf[0].allOf[1].Payload.cities[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.cities[].isHotboolean Yes
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice Yes
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinatesobject Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.cities[].distanceMetersnumber No
$.oneOf[0].allOf[1].Payload.cities[].distanceMilesnumber No
$.oneOf[0].allOf[1].Payload.closestCityobject Yes
$.oneOf[0].allOf[1].Payload.closestCity.namestring Yes
$.oneOf[0].allOf[1].Payload.closestCity.slugstring Yes
$.oneOf[0].allOf[1].Payload.closestCity.countryCodestring Yes
$.oneOf[0].allOf[1].Payload.dateRangestring ["7d","30d","90d","180d","365d"] Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_trending_near",
    "RequestUserAlias": "example-user",
    "Payload": {
        "categorySlug": "synthetic-example",
        "resolvedCategorySlug": "synthetic-example",
        "seoCategorySlug": "synthetic-example",
        "categoryTitlePlural": "synthetic-example",
        "canonicalURL": "synthetic-example",
        "category": {
            "id": 0,
            "slug": "synthetic-example",
            "seoSlug": "synthetic-example",
            "name": "synthetic-example",
            "titlePlural": "synthetic-example",
            "jsonLDType": "synthetic-example"
        },
        "cities": [],
        "closestCity": {
            "name": "synthetic-example",
            "slug": "synthetic-example",
            "countryCode": "synthetic-example"
        },
        "dateRange": "7d"
    }
}
Machine-readable endpoint documentation
GET

/v1/marketdata/get_wall_of_fame

#
Returns all public Wall of Fame leaderboards for the requested scope and timeframe. Public-by-design: Wall of Fame cards expose public user aliases, avatars, selected public profile/banner images, profile links, ranks, transaction counts, and rounded amount labels only. Raw transaction and bonus amounts stay internal to the cached ranking helper.

Parameters

NameTypeRequiredDefaultDescription
scopeType string No "global" global, continent, or city.
scopeValue string No "" Continent code (NA, EU, AS, MEA, SA, OC) or airport-backed city slug when scopeType=city.
timeframe string No "today" today, yesterday, month, ytd, year, or alltime.
year int No 0 Calendar year used when timeframe=year.
pageSize int No 10 Entries per board (1-25).
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_wall_of_fame' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'scopeType={{scopeType}}' \
  --data-urlencode 'scopeValue={{scopeValue}}' \
  --data-urlencode 'timeframe={{timeframe}}' \
  --data-urlencode 'year={{year}}' \
  --data-urlencode 'pageSize={{pageSize}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_wall_of_fame_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.scopeobject Yes
$.oneOf[0].allOf[1].Payload.scope.scopeTypestring ["global","continent","city"] Yes
$.oneOf[0].allOf[1].Payload.scope.scopeValuestring Yes
$.oneOf[0].allOf[1].Payload.scope.displayNamestring Yes
$.oneOf[0].allOf[1].Payload.scope.labelKeystring No
$.oneOf[0].allOf[1].Payload.scope.citySlugstring No
$.oneOf[0].allOf[1].Payload.scope.countryCodestring No
$.oneOf[0].allOf[1].Payload.scope.isoRegionstring No
$.oneOf[0].allOf[1].Payload.timeframeobject Yes
$.oneOf[0].allOf[1].Payload.timeframe.timeframestring ["today","yesterday","month","ytd","year","alltime"] Yes
$.oneOf[0].allOf[1].Payload.timeframe.yearinteger Yes
$.oneOf[0].allOf[1].Payload.timeframe.startDatestring Yes
$.oneOf[0].allOf[1].Payload.timeframe.endDatestring Yes
$.oneOf[0].allOf[1].Payload.timeframe.labelKeystring Yes
$.oneOf[0].allOf[1].Payload.listsarray Yes
$.oneOf[0].allOf[1].Payload.lists[]object No
$.oneOf[0].allOf[1].Payload.lists[].listKeystring ["highest_transaction","most_volume_purchased","most_volume_sold","largest_concierge_bonus","most_generous_users"] Yes
$.oneOf[0].allOf[1].Payload.lists[].labelKeystring Yes
$.oneOf[0].allOf[1].Payload.lists[].labelstring Yes
$.oneOf[0].allOf[1].Payload.lists[].descriptionKeystring Yes
$.oneOf[0].allOf[1].Payload.lists[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.lists[].countLabelKeystring Yes
$.oneOf[0].allOf[1].Payload.lists[].countLabelstring Yes
$.oneOf[0].allOf[1].Payload.lists[].rolestring ["buyer","seller"] Yes
$.oneOf[0].allOf[1].Payload.lists[].metricstring ["single_transaction","total_volume","single_bonus","total_bonus"] Yes
$.oneOf[0].allOf[1].Payload.pageSizeinteger Yes
$.oneOf[0].allOf[1].Payload.boardsarray Yes
$.oneOf[0].allOf[1].Payload.boards[]object No
$.oneOf[0].allOf[1].Payload.boards[].listKeystring ["highest_transaction","most_volume_purchased","most_volume_sold","largest_concierge_bonus","most_generous_users"] Yes
$.oneOf[0].allOf[1].Payload.boards[].labelKeystring Yes
$.oneOf[0].allOf[1].Payload.boards[].labelstring Yes
$.oneOf[0].allOf[1].Payload.boards[].descriptionKeystring Yes
$.oneOf[0].allOf[1].Payload.boards[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.boards[].countLabelKeystring Yes
$.oneOf[0].allOf[1].Payload.boards[].countLabelstring Yes
$.oneOf[0].allOf[1].Payload.boards[].rolestring ["buyer","seller"] Yes
$.oneOf[0].allOf[1].Payload.boards[].metricstring ["single_transaction","total_volume","single_bonus","total_bonus"] Yes
$.oneOf[0].allOf[1].Payload.boards[].entriesarray Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[]object No
$.oneOf[0].allOf[1].Payload.boards[].entries[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].transactionCountinteger Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].avatarURLstring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].transactionCountLabelstring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].amountLabelstring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[1]null Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_wall_of_fame",
    "RequestUserAlias": "example-user",
    "Payload": {
        "scope": {
            "scopeType": "global",
            "scopeValue": "synthetic-example",
            "displayName": "synthetic-example"
        },
        "timeframe": {
            "timeframe": "today",
            "year": 0,
            "startDate": "synthetic-example",
            "endDate": "synthetic-example",
            "labelKey": "synthetic-example"
        },
        "lists": [],
        "pageSize": 0,
        "boards": []
    }
}
Machine-readable endpoint documentation
GET

/v1/marketdata/get_wall_of_fame_list

#
Returns one public Wall of Fame leaderboard. Public-by-design: the response intentionally excludes exact raw cents and only emits rounded public amount labels plus public user identity fields and selected public profile/banner images.

Parameters

NameTypeRequiredDefaultDescription
listKey string No "highest_transaction" highest_transaction, most_volume_purchased, most_volume_sold, largest_concierge_bonus, or most_generous_users.
scopeType string No "global" global, continent, or city.
scopeValue string No "" Continent code or airport-backed city slug.
timeframe string No "today" today, yesterday, month, ytd, year, or alltime.
year int No 0 Calendar year used when timeframe=year.
pageSize int No 10 Entries per board (1-25).
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_wall_of_fame_list' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'listKey={{listKey}}' \
  --data-urlencode 'scopeType={{scopeType}}' \
  --data-urlencode 'scopeValue={{scopeValue}}' \
  --data-urlencode 'timeframe={{timeframe}}' \
  --data-urlencode 'year={{year}}' \
  --data-urlencode 'pageSize={{pageSize}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_wall_of_fame_list_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.scopeobject Yes
$.oneOf[0].allOf[1].Payload.scope.scopeTypestring ["global","continent","city"] Yes
$.oneOf[0].allOf[1].Payload.scope.scopeValuestring Yes
$.oneOf[0].allOf[1].Payload.scope.displayNamestring Yes
$.oneOf[0].allOf[1].Payload.scope.labelKeystring No
$.oneOf[0].allOf[1].Payload.scope.citySlugstring No
$.oneOf[0].allOf[1].Payload.scope.countryCodestring No
$.oneOf[0].allOf[1].Payload.scope.isoRegionstring No
$.oneOf[0].allOf[1].Payload.timeframeobject Yes
$.oneOf[0].allOf[1].Payload.timeframe.timeframestring ["today","yesterday","month","ytd","year","alltime"] Yes
$.oneOf[0].allOf[1].Payload.timeframe.yearinteger Yes
$.oneOf[0].allOf[1].Payload.timeframe.startDatestring Yes
$.oneOf[0].allOf[1].Payload.timeframe.endDatestring Yes
$.oneOf[0].allOf[1].Payload.timeframe.labelKeystring Yes
$.oneOf[0].allOf[1].Payload.listsarray Yes
$.oneOf[0].allOf[1].Payload.lists[]object No
$.oneOf[0].allOf[1].Payload.lists[].listKeystring ["highest_transaction","most_volume_purchased","most_volume_sold","largest_concierge_bonus","most_generous_users"] Yes
$.oneOf[0].allOf[1].Payload.lists[].labelKeystring Yes
$.oneOf[0].allOf[1].Payload.lists[].labelstring Yes
$.oneOf[0].allOf[1].Payload.lists[].descriptionKeystring Yes
$.oneOf[0].allOf[1].Payload.lists[].descriptionstring Yes
$.oneOf[0].allOf[1].Payload.lists[].countLabelKeystring Yes
$.oneOf[0].allOf[1].Payload.lists[].countLabelstring Yes
$.oneOf[0].allOf[1].Payload.lists[].rolestring ["buyer","seller"] Yes
$.oneOf[0].allOf[1].Payload.lists[].metricstring ["single_transaction","total_volume","single_bonus","total_bonus"] Yes
$.oneOf[0].allOf[1].Payload.pageSizeinteger Yes
$.oneOf[0].allOf[1].Payload.boardobject Yes
$.oneOf[0].allOf[1].Payload.board.listKeystring ["highest_transaction","most_volume_purchased","most_volume_sold","largest_concierge_bonus","most_generous_users"] Yes
$.oneOf[0].allOf[1].Payload.board.labelKeystring Yes
$.oneOf[0].allOf[1].Payload.board.labelstring Yes
$.oneOf[0].allOf[1].Payload.board.descriptionKeystring Yes
$.oneOf[0].allOf[1].Payload.board.descriptionstring Yes
$.oneOf[0].allOf[1].Payload.board.countLabelKeystring Yes
$.oneOf[0].allOf[1].Payload.board.countLabelstring Yes
$.oneOf[0].allOf[1].Payload.board.rolestring ["buyer","seller"] Yes
$.oneOf[0].allOf[1].Payload.board.metricstring ["single_transaction","total_volume","single_bonus","total_bonus"] Yes
$.oneOf[0].allOf[1].Payload.board.entriesarray Yes
$.oneOf[0].allOf[1].Payload.board.entries[]object No
$.oneOf[0].allOf[1].Payload.board.entries[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.board.entries[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.board.entries[].transactionCountinteger Yes
$.oneOf[0].allOf[1].Payload.board.entries[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].avatarURLstring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].transactionCountLabelstring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].amountLabelstring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.entriesarray Yes
$.oneOf[0].allOf[1].Payload.entries[]object No
$.oneOf[0].allOf[1].Payload.entries[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.entries[].userIDinteger Yes
$.oneOf[0].allOf[1].Payload.entries[].transactionCountinteger Yes
$.oneOf[0].allOf[1].Payload.entries[].aliasstring Yes
$.oneOf[0].allOf[1].Payload.entries[].avatarURLstring Yes
$.oneOf[0].allOf[1].Payload.entries[].avatarEmojistring Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImageURLstring Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImageURLstring Yes
$.oneOf[0].allOf[1].Payload.entries[].profileURLstring Yes
$.oneOf[0].allOf[1].Payload.entries[].transactionCountLabelstring Yes
$.oneOf[0].allOf[1].Payload.entries[].amountLabelstring Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].idinteger Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].thumbUrlstring Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].mediaUrlstring Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].mediaTypestring Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].widthinteger Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].heightinteger Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].titlestring Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].isImageboolean Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].isEmbeddedboolean Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].frameobject Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].frame.positionXPercentnumber Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].frame.positionYPercentnumber Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].frame.zoomPercentnumber Yes
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[1]null Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_wall_of_fame_list",
    "RequestUserAlias": "example-user",
    "Payload": {
        "scope": {
            "scopeType": "global",
            "scopeValue": "synthetic-example",
            "displayName": "synthetic-example"
        },
        "timeframe": {
            "timeframe": "today",
            "year": 0,
            "startDate": "synthetic-example",
            "endDate": "synthetic-example",
            "labelKey": "synthetic-example"
        },
        "lists": [],
        "pageSize": 0,
        "board": {
            "listKey": "highest_transaction",
            "labelKey": "synthetic-example",
            "label": "synthetic-example",
            "descriptionKey": "synthetic-example",
            "description": "synthetic-example",
            "countLabelKey": "synthetic-example",
            "countLabel": "synthetic-example",
            "role": "buyer",
            "metric": "single_transaction",
            "entries": []
        },
        "entries": []
    }
}
Machine-readable endpoint documentation
GET

/v1/marketdata/get_world_top

#
Returns the top cities worldwide ordered by recent trading activity. Used by the Market Data overview page's "World's Top N" header section.

Parameters

NameTypeRequiredDefaultDescription
pageSize int No 20 Number of cities to return (1-100).
categorySlug string No "" Optional category filter (restaurants, events, concerts, hotels, dmv, mentoring, shopping, golf, rv, marinas, cruises, houseparties, dj, concierges, general). Empty = all categories.
dateRange string No "90d" Activity window: 7d, 30d, 90d, 180d, 365d.
Request example (cURL) 
curl --get \
  'https://ca.appointmenttrader.com/v1/marketdata/get_world_top' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'categorySlug={{categorySlug}}' \
  --data-urlencode 'dateRange={{dateRange}}'

Returns

JSON
See the shared response schema and synthetic example.
Response fields
FieldTypeRequiredDescription
$marketdata_get_world_top_Response Yes
$.oneOf[0] Yes
$.oneOf[0].allOf[0]object Yes
$.oneOf[0].allOf[0].RequestUserAliasstring Yes
$.oneOf[0].allOf[0].RequestPathstring | null Yes
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Yes
$.oneOf[0].allOf[0].ResponseCodeinteger Yes
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Yes
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Yes
$.oneOf[0].allOf[1].Payloadobject Yes
$.oneOf[0].allOf[1].Payload.categorySlugstring Yes
$.oneOf[0].allOf[1].Payload.resolvedCategorySlugstring Yes
$.oneOf[0].allOf[1].Payload.seoCategorySlugstring Yes
$.oneOf[0].allOf[1].Payload.categoryTitlePluralstring Yes
$.oneOf[0].allOf[1].Payload.canonicalURL Yes
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[0]string Yes
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[1] = false Yes
$.oneOf[0].allOf[1].Payload.category Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0]object Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].slugstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlugstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].namestring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePluralstring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDTypestring Yes
$.oneOf[0].allOf[1].Payload.category.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.citiesarray Yes
$.oneOf[0].allOf[1].Payload.cities[]object No
$.oneOf[0].allOf[1].Payload.cities[].citySlugstring Yes
$.oneOf[0].allOf[1].Payload.cities[].cityNamestring Yes
$.oneOf[0].allOf[1].Payload.cities[].stateShortstring Yes
$.oneOf[0].allOf[1].Payload.cities[].isoRegionstring Yes
$.oneOf[0].allOf[1].Payload.cities[].countryCodestring Yes
$.oneOf[0].allOf[1].Payload.cities[].countryNamestring Yes
$.oneOf[0].allOf[1].Payload.cities[].continentShortstring Yes
$.oneOf[0].allOf[1].Payload.cities[].imageURL256string Yes
$.oneOf[0].allOf[1].Payload.cities[].imageURL512string Yes
$.oneOf[0].allOf[1].Payload.cities[].detailURLstring Yes
$.oneOf[0].allOf[1].Payload.cities[].tradingActivity30Dayinteger Yes
$.oneOf[0].allOf[1].Payload.cities[].numberTransactionsinteger Yes
$.oneOf[0].allOf[1].Payload.cities[].venueCountinteger Yes
$.oneOf[0].allOf[1].Payload.cities[].rankinteger Yes
$.oneOf[0].allOf[1].Payload.cities[].isHotboolean Yes
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice Yes
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[0]integer Yes
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinatesobject Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[0]number Yes
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[1]null Yes
$.oneOf[0].allOf[1].Payload.cities[].distanceMetersnumber No
$.oneOf[0].allOf[1].Payload.cities[].distanceMilesnumber No
$.oneOf[0].allOf[1].Payload.totalResultsinteger Yes
$.oneOf[0].allOf[1].Payload.dateRangestring ["7d","30d","90d","180d","365d"] Yes
$.oneOf[1]object Yes
$.oneOf[1].RequestUserAliasstring Yes
$.oneOf[1].RequestPathstring | null Yes
$.oneOf[1].RequestStatus = "Failed" Yes
$.oneOf[1].ResponseCodeinteger Yes
$.oneOf[1].ResponseMessageAPIResponseMessage Yes
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Yes
$.oneOf[1].ResponseMessage.oneOf[1]array Yes
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Yes
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Response example 
{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_world_top",
    "RequestUserAlias": "example-user",
    "Payload": {
        "categorySlug": "synthetic-example",
        "resolvedCategorySlug": "synthetic-example",
        "seoCategorySlug": "synthetic-example",
        "categoryTitlePlural": "synthetic-example",
        "canonicalURL": "synthetic-example",
        "category": {
            "id": 0,
            "slug": "synthetic-example",
            "seoSlug": "synthetic-example",
            "name": "synthetic-example",
            "titlePlural": "synthetic-example",
            "jsonLDType": "synthetic-example"
        },
        "cities": [],
        "totalResults": 0,
        "dateRange": "7d"
    }
}
Machine-readable endpoint documentation