AT AppointmentTrader
Aanmelden
Online nu  

/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

NaamTypeVerplichtStandaardBeschrijving
citySlug string Ja — CloseByCitySlug (e.g. los-angeles, new-york).
pageSize int Nee 20 Venues per page (1-50).
pageNumber int Nee 0 Zero-based page number.
categorySlug string Nee "" Optional category filter.
dateRange string Nee "90d" Activity window.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$marketdata_get_city_hot_list_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.categorySlugstring Ja
$.oneOf[0].allOf[1].Payload.resolvedCategorySlugstring Ja
$.oneOf[0].allOf[1].Payload.seoCategorySlugstring Ja
$.oneOf[0].allOf[1].Payload.categoryTitlePluralstring Ja
$.oneOf[0].allOf[1].Payload.canonicalURL Ja
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[1] = false Ja
$.oneOf[0].allOf[1].Payload.category Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].slugstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlugstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].namestring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePluralstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDTypestring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.cityobject Ja
$.oneOf[0].allOf[1].Payload.city.cityNamestring Ja
$.oneOf[0].allOf[1].Payload.city.citySlugstring Ja
$.oneOf[0].allOf[1].Payload.city.countryCodestring Ja
$.oneOf[0].allOf[1].Payload.city.isoRegionstring Ja
$.oneOf[0].allOf[1].Payload.city.imageURL512string Ja
$.oneOf[0].allOf[1].Payload.city.canonicalURL Ja
$.oneOf[0].allOf[1].Payload.city.canonicalURL.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.city.canonicalURL.anyOf[1] = false Ja
$.oneOf[0].allOf[1].Payload.city.isRestrictedMarketboolean Ja
$.oneOf[0].allOf[1].Payload.city.showRevenueMetricsboolean Ja
$.oneOf[0].allOf[1].Payload.city.recentActivityobject Ja
$.oneOf[0].allOf[1].Payload.city.recentActivity.windowHoursinteger Ja
$.oneOf[0].allOf[1].Payload.city.recentActivity.peopleCountinteger Ja
$.oneOf[0].allOf[1].Payload.venuesarray Ja
$.oneOf[0].allOf[1].Payload.venues[]object Nee
$.oneOf[0].allOf[1].Payload.venues[].rankinteger Ja
$.oneOf[0].allOf[1].Payload.venues[].locationIDinteger Ja
$.oneOf[0].allOf[1].Payload.venues[].ratingCountinteger Ja
$.oneOf[0].allOf[1].Payload.venues[].externalRatingCountinteger Ja
$.oneOf[0].allOf[1].Payload.venues[].locationAliasstring Ja
$.oneOf[0].allOf[1].Payload.venues[].tickerCodestring Ja
$.oneOf[0].allOf[1].Payload.venues[].namestring Ja
$.oneOf[0].allOf[1].Payload.venues[].cityNamestring Ja
$.oneOf[0].allOf[1].Payload.venues[].stateShortstring Ja
$.oneOf[0].allOf[1].Payload.venues[].countryShortstring Ja
$.oneOf[0].allOf[1].Payload.venues[].addressStringstring Ja
$.oneOf[0].allOf[1].Payload.venues[].categorySlugstring Ja
$.oneOf[0].allOf[1].Payload.venues[].categoryDescriptorstring Ja
$.oneOf[0].allOf[1].Payload.venues[].categoryIconstring Ja
$.oneOf[0].allOf[1].Payload.venues[].categoryJsonLDTypestring Ja
$.oneOf[0].allOf[1].Payload.venues[].imageURL256string Ja
$.oneOf[0].allOf[1].Payload.venues[].imageURL512string Ja
$.oneOf[0].allOf[1].Payload.venues[].imageColorstring Ja
$.oneOf[0].allOf[1].Payload.venues[].communitySnippetstring Ja
$.oneOf[0].allOf[1].Payload.venues[].communitySnippetURLstring Ja
$.oneOf[0].allOf[1].Payload.venues[].profileURLstring Ja
$.oneOf[0].allOf[1].Payload.venues[].coordinates Ja
$.oneOf[0].allOf[1].Payload.venues[].coordinates.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.venues[].coordinates.anyOf[0].latitudenumber Ja
$.oneOf[0].allOf[1].Payload.venues[].coordinates.anyOf[0].longitudenumber Ja
$.oneOf[0].allOf[1].Payload.venues[].coordinates.anyOf[1]array Ja
$.oneOf[0].allOf[1].Payload.venues[].rating Ja
$.oneOf[0].allOf[1].Payload.venues[].rating.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.venues[].rating.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].externalRating Ja
$.oneOf[0].allOf[1].Payload.venues[].externalRating.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.venues[].externalRating.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].priceLevel Ja
$.oneOf[0].allOf[1].Payload.venues[].priceLevel.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.venues[].priceLevel.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].rating Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].rating.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].rating.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].ratingCountinteger Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].postCountinteger Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostTextstring Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostURLstring Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].reviewBoardNamestring Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].reviewBoardURLstring Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostTitlestring Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostAuthorAliasstring Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostCreatedDatestring Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestBoardNamestring Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestBoardURLstring Ja
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].minimumRatingCountinteger Nee
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].hasPublicRatingboolean Nee
$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[1]array Ja
$.oneOf[0].allOf[1].Payload.venues[].showRevenueMetricsboolean Ja
$.oneOf[0].allOf[1].Payload.venues[].isRestrictedByRegulationboolean Ja
$.oneOf[0].allOf[1].Payload.venues[].userTrades Ja
$.oneOf[0].allOf[1].Payload.venues[].userTrades.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.venues[].userTrades.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].bidsLast30Day Ja
$.oneOf[0].allOf[1].Payload.venues[].bidsLast30Day.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.venues[].bidsLast30Day.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].avgPrice Ja
$.oneOf[0].allOf[1].Payload.venues[].avgPrice.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.venues[].avgPrice.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].visualInitialstring Ja
$.oneOf[0].allOf[1].Payload.venues[].visualPrimaryColorstring Ja
$.oneOf[0].allOf[1].Payload.venues[].visualSecondaryColorstring Ja
$.oneOf[0].allOf[1].Payload.venues[].visualTextColorstring Ja
$.oneOf[0].allOf[1].Payload.venues[].ugcImageURL256string Ja
$.oneOf[0].allOf[1].Payload.venues[].ugcImageURL512string Ja
$.oneOf[0].allOf[1].Payload.venues[].visualImageURL256string Ja
$.oneOf[0].allOf[1].Payload.venues[].visualImageURL512string Ja
$.oneOf[0].allOf[1].Payload.venues[].visualDisplayImageURL256string Ja
$.oneOf[0].allOf[1].Payload.venues[].visualDisplayImageURL512string Ja
$.oneOf[0].allOf[1].Payload.venues[].visualImageIsUGCboolean Ja
$.oneOf[0].allOf[1].Payload.venues[].visualDisplayImageSourcestring ["fallback","ugc","generated"] Ja
$.oneOf[0].allOf[1].Payload.venues[].streetNumberstring Ja
$.oneOf[0].allOf[1].Payload.venues[].streetstring Ja
$.oneOf[0].allOf[1].Payload.venues[].zipstring Ja
$.oneOf[0].allOf[1].Payload.venues[].ratingSourcestring Ja
$.oneOf[0].allOf[1].Payload.venues[].addedByUserAliasstring Ja
$.oneOf[0].allOf[1].Payload.venues[].addedYearMonthstring Ja
$.oneOf[0].allOf[1].Payload.venues[].mentionURLstring Ja
$.oneOf[0].allOf[1].Payload.venues[].localRankinteger Ja
$.oneOf[0].allOf[1].Payload.venues[].rankDelta30Day Ja
$.oneOf[0].allOf[1].Payload.venues[].rankDelta30Day.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.venues[].rankDelta30Day.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].priorRank Ja
$.oneOf[0].allOf[1].Payload.venues[].priorRank.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.venues[].priorRank.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeDataobject Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.1d Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.1d.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.1d.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.7d Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.7d.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.7d.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.30d Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.30d.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.30d.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.3mo Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.3mo.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.3mo.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.12mo Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.12mo.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.venues[].rankChangeData.12mo.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.venues[].recentViewsinteger Ja
$.oneOf[0].allOf[1].Payload.pageSizeinteger Ja
$.oneOf[0].allOf[1].Payload.pageNumberinteger Ja
$.oneOf[0].allOf[1].Payload.dateRangestring ["7d","30d","90d","180d","365d"] Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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"
    }
}
Machineleesbare endpointdocumentatie
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

NaamTypeVerplichtStandaardBeschrijving
continent string Ja — Editorial continent code: NA, EU, AS, MEA, SA, OC.
pageSize int Nee 100 Number of cities (1-100).
categorySlug string Nee "" Optional category filter.
dateRange string Nee "90d" Activity window.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$marketdata_get_continent_country_top_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.categorySlugstring Ja
$.oneOf[0].allOf[1].Payload.resolvedCategorySlugstring Ja
$.oneOf[0].allOf[1].Payload.seoCategorySlugstring Ja
$.oneOf[0].allOf[1].Payload.categoryTitlePluralstring Ja
$.oneOf[0].allOf[1].Payload.canonicalURL Ja
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[1] = false Ja
$.oneOf[0].allOf[1].Payload.category Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].slugstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlugstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].namestring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePluralstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDTypestring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.continentstring ["NA","EU","AS","MEA","SA","OC"] Ja
$.oneOf[0].allOf[1].Payload.countriesarray Ja
$.oneOf[0].allOf[1].Payload.countries[]object Nee
$.oneOf[0].allOf[1].Payload.countries[].countryCodestring Ja
$.oneOf[0].allOf[1].Payload.countries[].countryNamestring Ja
$.oneOf[0].allOf[1].Payload.countries[].citiesarray Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[]object Nee
$.oneOf[0].allOf[1].Payload.countries[].cities[].citySlugstring Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].cityNamestring Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].stateShortstring Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].isoRegionstring Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].countryCodestring Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].countryNamestring Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].continentShortstring Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].imageURL256string Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].imageURL512string Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].detailURLstring Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].tradingActivity30Dayinteger Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].numberTransactionsinteger Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].venueCountinteger Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].rankinteger Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].isHotboolean Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].avgTradingPrice Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].avgTradingPrice.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].avgTradingPrice.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinatesobject Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.latitude Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.latitude.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.latitude.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.longitude Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.longitude.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.longitude.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.countries[].cities[].distanceMetersnumber Nee
$.oneOf[0].allOf[1].Payload.countries[].cities[].distanceMilesnumber Nee
$.oneOf[0].allOf[1].Payload.totalCitiesinteger Ja
$.oneOf[0].allOf[1].Payload.dateRangestring ["7d","30d","90d","180d","365d"] Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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"
    }
}
Machineleesbare endpointdocumentatie
GET

/v1/marketdata/get_highest_converting_locations

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

Parameters

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

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$marketdata_get_highest_converting_locations_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Ja
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string Nee
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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": []
        }
    }
}
Machineleesbare endpointdocumentatie
GET

/v1/marketdata/get_map_points

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
scope string Nee "overview" overview or city.
citySlug string Nee "" CloseByCitySlug when scope=city.
west float Nee -180 Viewport west longitude.
south float Nee -85 Viewport south latitude.
east float Nee 180 Viewport east longitude.
north float Nee 85 Viewport north latitude.
zoom int Nee 2 Current map zoom. Below 6 returns city points; 6 and above returns location points.
pageSize int Nee 200 Number of points to return (1-300).
categorySlug string Nee "" Optional category filter.
dateRange string Nee "90d" Activity window: 7d, 30d, 90d, 180d, 365d.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$marketdata_get_map_points_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.categorySlugstring Ja
$.oneOf[0].allOf[1].Payload.resolvedCategorySlugstring Ja
$.oneOf[0].allOf[1].Payload.seoCategorySlugstring Ja
$.oneOf[0].allOf[1].Payload.categoryTitlePluralstring Ja
$.oneOf[0].allOf[1].Payload.canonicalURL Ja
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[1] = false Ja
$.oneOf[0].allOf[1].Payload.category Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].slugstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlugstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].namestring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePluralstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDTypestring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.modestring ["cities","locations"] Ja
$.oneOf[0].allOf[1].Payload.scopestring ["overview","city"] Ja
$.oneOf[0].allOf[1].Payload.citySlugstring Ja
$.oneOf[0].allOf[1].Payload.citiesarray Ja
$.oneOf[0].allOf[1].Payload.cities[]object Nee
$.oneOf[0].allOf[1].Payload.cities[].citySlugstring Ja
$.oneOf[0].allOf[1].Payload.cities[].cityNamestring Ja
$.oneOf[0].allOf[1].Payload.cities[].stateShortstring Ja
$.oneOf[0].allOf[1].Payload.cities[].isoRegionstring Ja
$.oneOf[0].allOf[1].Payload.cities[].countryCodestring Ja
$.oneOf[0].allOf[1].Payload.cities[].countryNamestring Ja
$.oneOf[0].allOf[1].Payload.cities[].continentShortstring Ja
$.oneOf[0].allOf[1].Payload.cities[].imageURL256string Ja
$.oneOf[0].allOf[1].Payload.cities[].imageURL512string Ja
$.oneOf[0].allOf[1].Payload.cities[].detailURLstring Ja
$.oneOf[0].allOf[1].Payload.cities[].tradingActivity30Dayinteger Ja
$.oneOf[0].allOf[1].Payload.cities[].numberTransactionsinteger Ja
$.oneOf[0].allOf[1].Payload.cities[].venueCountinteger Ja
$.oneOf[0].allOf[1].Payload.cities[].rankinteger Ja
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice Ja
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinatesobject Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.cities[].distanceMetersnumber Nee
$.oneOf[0].allOf[1].Payload.cities[].distanceMilesnumber Nee
$.oneOf[0].allOf[1].Payload.cities[].regionLabelstring Ja
$.oneOf[0].allOf[1].Payload.locationsarray Ja
$.oneOf[0].allOf[1].Payload.locations[]object Nee
$.oneOf[0].allOf[1].Payload.locations[].rankinteger Ja
$.oneOf[0].allOf[1].Payload.locations[].locationIDinteger Ja
$.oneOf[0].allOf[1].Payload.locations[].ratingCountinteger Ja
$.oneOf[0].allOf[1].Payload.locations[].externalRatingCountinteger Ja
$.oneOf[0].allOf[1].Payload.locations[].locationAliasstring Ja
$.oneOf[0].allOf[1].Payload.locations[].tickerCodestring Ja
$.oneOf[0].allOf[1].Payload.locations[].namestring Ja
$.oneOf[0].allOf[1].Payload.locations[].cityNamestring Ja
$.oneOf[0].allOf[1].Payload.locations[].stateShortstring Ja
$.oneOf[0].allOf[1].Payload.locations[].countryShortstring Ja
$.oneOf[0].allOf[1].Payload.locations[].closeByCitySlugstring Ja
$.oneOf[0].allOf[1].Payload.locations[].addressStringstring Ja
$.oneOf[0].allOf[1].Payload.locations[].categorySlugstring Ja
$.oneOf[0].allOf[1].Payload.locations[].categoryDescriptorstring Ja
$.oneOf[0].allOf[1].Payload.locations[].categoryIconstring Ja
$.oneOf[0].allOf[1].Payload.locations[].categoryJsonLDTypestring Ja
$.oneOf[0].allOf[1].Payload.locations[].imageURL256string Ja
$.oneOf[0].allOf[1].Payload.locations[].imageURL512string Ja
$.oneOf[0].allOf[1].Payload.locations[].imageColorstring Ja
$.oneOf[0].allOf[1].Payload.locations[].communitySnippetstring Ja
$.oneOf[0].allOf[1].Payload.locations[].communitySnippetURLstring Ja
$.oneOf[0].allOf[1].Payload.locations[].profileURLstring Ja
$.oneOf[0].allOf[1].Payload.locations[].cityDetailURLstring Ja
$.oneOf[0].allOf[1].Payload.locations[].coordinatesobject Ja
$.oneOf[0].allOf[1].Payload.locations[].coordinates.latitudenumber Ja
$.oneOf[0].allOf[1].Payload.locations[].coordinates.longitudenumber Ja
$.oneOf[0].allOf[1].Payload.locations[].rating Ja
$.oneOf[0].allOf[1].Payload.locations[].rating.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.locations[].rating.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.locations[].externalRating Ja
$.oneOf[0].allOf[1].Payload.locations[].externalRating.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.locations[].externalRating.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.locations[].priceLevel Ja
$.oneOf[0].allOf[1].Payload.locations[].priceLevel.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.locations[].priceLevel.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.locations[].communityContextobject Ja
$.oneOf[0].allOf[1].Payload.locations[].communityContext.rating Ja
$.oneOf[0].allOf[1].Payload.locations[].communityContext.rating.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.locations[].communityContext.rating.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.locations[].communityContext.ratingCountinteger Ja
$.oneOf[0].allOf[1].Payload.locations[].communityContext.postCountinteger Ja
$.oneOf[0].allOf[1].Payload.locations[].communityContext.latestPostTextstring Ja
$.oneOf[0].allOf[1].Payload.locations[].communityContext.latestPostURLstring Ja
$.oneOf[0].allOf[1].Payload.locations[].communityContext.reviewBoardNamestring Ja
$.oneOf[0].allOf[1].Payload.locations[].communityContext.reviewBoardURLstring Ja
$.oneOf[0].allOf[1].Payload.locations[].showRevenueMetricsboolean Ja
$.oneOf[0].allOf[1].Payload.locations[].isRestrictedByRegulationboolean Ja
$.oneOf[0].allOf[1].Payload.locations[].userTrades Ja
$.oneOf[0].allOf[1].Payload.locations[].userTrades.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.locations[].userTrades.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.locations[].bidsLast30Day Ja
$.oneOf[0].allOf[1].Payload.locations[].bidsLast30Day.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.locations[].bidsLast30Day.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.locations[].avgPrice Ja
$.oneOf[0].allOf[1].Payload.locations[].avgPrice.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.locations[].avgPrice.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.locations[].visualInitialstring Ja
$.oneOf[0].allOf[1].Payload.locations[].visualPrimaryColorstring Ja
$.oneOf[0].allOf[1].Payload.locations[].visualSecondaryColorstring Ja
$.oneOf[0].allOf[1].Payload.locations[].visualTextColorstring Ja
$.oneOf[0].allOf[1].Payload.locations[].ugcImageURL256string Ja
$.oneOf[0].allOf[1].Payload.locations[].ugcImageURL512string Ja
$.oneOf[0].allOf[1].Payload.locations[].visualImageURL256string Ja
$.oneOf[0].allOf[1].Payload.locations[].visualImageURL512string Ja
$.oneOf[0].allOf[1].Payload.locations[].visualDisplayImageURL256string Ja
$.oneOf[0].allOf[1].Payload.locations[].visualDisplayImageURL512string Ja
$.oneOf[0].allOf[1].Payload.locations[].visualImageIsUGCboolean Ja
$.oneOf[0].allOf[1].Payload.locations[].visualDisplayImageSourcestring ["fallback","ugc","generated"] Ja
$.oneOf[0].allOf[1].Payload.viewportobject Ja
$.oneOf[0].allOf[1].Payload.viewport.westnumber Ja
$.oneOf[0].allOf[1].Payload.viewport.southnumber Ja
$.oneOf[0].allOf[1].Payload.viewport.eastnumber Ja
$.oneOf[0].allOf[1].Payload.viewport.northnumber Ja
$.oneOf[0].allOf[1].Payload.viewport.zoomnumber Ja
$.oneOf[0].allOf[1].Payload.totalResultsinteger Ja
$.oneOf[0].allOf[1].Payload.dateRangestring ["7d","30d","90d","180d","365d"] Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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"
    }
}
Machineleesbare endpointdocumentatie
GET

/v1/marketdata/get_most_bids_least_asks

#
Returns locations with the highest bids vs listing ratio

Parameters

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

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$marketdata_get_most_bids_least_asks_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Ja
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string Nee
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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": []
        }
    }
}
Machineleesbare endpointdocumentatie
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

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

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$marketdata_get_most_underserved_locations_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Ja
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings = 0 Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string Nee
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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": []
        }
    }
}
Machineleesbare endpointdocumentatie
GET

/v1/marketdata/get_most_viewed_locations_with_least_listings

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

Parameters

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

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$marketdata_get_most_viewed_locations_with_least_listings_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Ja
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string Nee
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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": []
        }
    }
}
Machineleesbare endpointdocumentatie
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

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

Retourwaarde

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

/v1/marketdata/get_required_inventory_forecast

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
locationAlias string Ja — Slug found after the slash when opening a location in the portal
dateRangeStart string Ja — oldest date of metrics to be reported Date format: YYYY-MM-DD
dateRangeEnd string Ja — latest date of metrics to be reported Date format: YYYY-MM-DD
additionalLocationAliasSourceList string Nee "" 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 Nee 0 Items to exclude based on price
desiredProfitBasisPoints int Nee 10000 defines how much profit should be made per line item
pageSize int Nee 1500 Defines how many results will be return per request
pageNumber int Nee 0 Defines which page should be returned
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$marketdata_get_required_inventory_forecast_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Ja
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.yearOverYearAverageMarketPriceChangenumber Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberSuggestedTransactions = 0 Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberSuggestedBids = 0 Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberSuggestedListingPurchases = 0 Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalSuggestedDollarVolume = 0 Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*object Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*object Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*object Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*object Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.numberHistoricalTransactionsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentNumberBidsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentHighBidinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentLowBidinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentBidVolumeinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentNumberListingsinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentListingHighPriceinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentListingLowPriceinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentListingAveragePriceinteger Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.averagePricenumber Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.minimumPricenumber Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.maximumPricenumber Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.totalDemandnumber Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].CreatedDatestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastUpdateDatestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Namestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Descriptionstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].URLstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Icon Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Icon.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Icon.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].event-locationAlias Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].event-locationAlias.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].event-locationAlias.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[0]DatabaseInteger JaInteger 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 Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrameobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.StartTime Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.StartTime.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.StartTime.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.EndTime Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.EndTime.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.EndTime.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastPeriodTimeFrameobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastPeriodTimeFrame.StartTimestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastPeriodTimeFrame.EndTimestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.sourceDataLocationAliasListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.sourceDataLocationAliasList[]string Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.lastYearsCorrespondingDayListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.lastYearsCorrespondingDayList[]string Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[1]array Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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": []
        }
    }
}
Machineleesbare endpointdocumentatie
GET

/v1/marketdata/get_toplist

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

Parameters

NaamTypeVerplichtStandaardBeschrijving
cityCode string Nee "" The code of the City that is being queried If left empty worldwide results are being returned Exemplary Value: NYC
categorySlug string Nee "" The slug of the location category that is being requested. If left empty all categories are being returned. Exemplary Value: restaurants
pageSize int Nee 25 Defines how many results will be return per request
pageNumber int Nee 0 Defines which page should be returned
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$marketdata_get_toplist_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Ja
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocationsDatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocations.oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocations.oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object Nee
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0]DatabaseInteger JaInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0].oneOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0].oneOf[1]string Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRankChangeData JaPipe-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 Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRankChangeData.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRankChangeData JaPipe-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 Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRankChangeData.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Ja
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string Nee
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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": []
        }
    }
}
Machineleesbare endpointdocumentatie
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

NaamTypeVerplichtStandaardBeschrijving
lat float Ja — Latitude in decimal degrees.
long float Ja — Longitude in decimal degrees.
pageSize int Nee 4 Number of cities to return (1-20).
categorySlug string Nee "" Optional category filter.
dateRange string Nee "90d" Activity window.
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$marketdata_get_trending_near_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.categorySlugstring Ja
$.oneOf[0].allOf[1].Payload.resolvedCategorySlugstring Ja
$.oneOf[0].allOf[1].Payload.seoCategorySlugstring Ja
$.oneOf[0].allOf[1].Payload.categoryTitlePluralstring Ja
$.oneOf[0].allOf[1].Payload.canonicalURL Ja
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[1] = false Ja
$.oneOf[0].allOf[1].Payload.category Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].slugstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlugstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].namestring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePluralstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDTypestring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.citiesarray Ja
$.oneOf[0].allOf[1].Payload.cities[]object Nee
$.oneOf[0].allOf[1].Payload.cities[].citySlugstring Ja
$.oneOf[0].allOf[1].Payload.cities[].cityNamestring Ja
$.oneOf[0].allOf[1].Payload.cities[].stateShortstring Ja
$.oneOf[0].allOf[1].Payload.cities[].isoRegionstring Ja
$.oneOf[0].allOf[1].Payload.cities[].countryCodestring Ja
$.oneOf[0].allOf[1].Payload.cities[].countryNamestring Ja
$.oneOf[0].allOf[1].Payload.cities[].continentShortstring Ja
$.oneOf[0].allOf[1].Payload.cities[].imageURL256string Ja
$.oneOf[0].allOf[1].Payload.cities[].imageURL512string Ja
$.oneOf[0].allOf[1].Payload.cities[].detailURLstring Ja
$.oneOf[0].allOf[1].Payload.cities[].tradingActivity30Dayinteger Ja
$.oneOf[0].allOf[1].Payload.cities[].numberTransactionsinteger Ja
$.oneOf[0].allOf[1].Payload.cities[].venueCountinteger Ja
$.oneOf[0].allOf[1].Payload.cities[].rankinteger Ja
$.oneOf[0].allOf[1].Payload.cities[].isHotboolean Ja
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice Ja
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinatesobject Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.cities[].distanceMetersnumber Nee
$.oneOf[0].allOf[1].Payload.cities[].distanceMilesnumber Nee
$.oneOf[0].allOf[1].Payload.closestCityobject Ja
$.oneOf[0].allOf[1].Payload.closestCity.namestring Ja
$.oneOf[0].allOf[1].Payload.closestCity.slugstring Ja
$.oneOf[0].allOf[1].Payload.closestCity.countryCodestring Ja
$.oneOf[0].allOf[1].Payload.dateRangestring ["7d","30d","90d","180d","365d"] Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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"
    }
}
Machineleesbare endpointdocumentatie
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

NaamTypeVerplichtStandaardBeschrijving
scopeType string Nee "global" global, continent, or city.
scopeValue string Nee "" Continent code (NA, EU, AS, MEA, SA, OC) or airport-backed city slug when scopeType=city.
timeframe string Nee "today" today, yesterday, month, ytd, year, or alltime.
year int Nee 0 Calendar year used when timeframe=year.
pageSize int Nee 10 Entries per board (1-25).
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$marketdata_get_wall_of_fame_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.scopeobject Ja
$.oneOf[0].allOf[1].Payload.scope.scopeTypestring ["global","continent","city"] Ja
$.oneOf[0].allOf[1].Payload.scope.scopeValuestring Ja
$.oneOf[0].allOf[1].Payload.scope.displayNamestring Ja
$.oneOf[0].allOf[1].Payload.scope.labelKeystring Nee
$.oneOf[0].allOf[1].Payload.scope.citySlugstring Nee
$.oneOf[0].allOf[1].Payload.scope.countryCodestring Nee
$.oneOf[0].allOf[1].Payload.scope.isoRegionstring Nee
$.oneOf[0].allOf[1].Payload.timeframeobject Ja
$.oneOf[0].allOf[1].Payload.timeframe.timeframestring ["today","yesterday","month","ytd","year","alltime"] Ja
$.oneOf[0].allOf[1].Payload.timeframe.yearinteger Ja
$.oneOf[0].allOf[1].Payload.timeframe.startDatestring Ja
$.oneOf[0].allOf[1].Payload.timeframe.endDatestring Ja
$.oneOf[0].allOf[1].Payload.timeframe.labelKeystring Ja
$.oneOf[0].allOf[1].Payload.listsarray Ja
$.oneOf[0].allOf[1].Payload.lists[]object Nee
$.oneOf[0].allOf[1].Payload.lists[].listKeystring ["highest_transaction","most_volume_purchased","most_volume_sold","largest_concierge_bonus","most_generous_users"] Ja
$.oneOf[0].allOf[1].Payload.lists[].labelKeystring Ja
$.oneOf[0].allOf[1].Payload.lists[].labelstring Ja
$.oneOf[0].allOf[1].Payload.lists[].descriptionKeystring Ja
$.oneOf[0].allOf[1].Payload.lists[].descriptionstring Ja
$.oneOf[0].allOf[1].Payload.lists[].countLabelKeystring Ja
$.oneOf[0].allOf[1].Payload.lists[].countLabelstring Ja
$.oneOf[0].allOf[1].Payload.lists[].rolestring ["buyer","seller"] Ja
$.oneOf[0].allOf[1].Payload.lists[].metricstring ["single_transaction","total_volume","single_bonus","total_bonus"] Ja
$.oneOf[0].allOf[1].Payload.pageSizeinteger Ja
$.oneOf[0].allOf[1].Payload.boardsarray Ja
$.oneOf[0].allOf[1].Payload.boards[]object Nee
$.oneOf[0].allOf[1].Payload.boards[].listKeystring ["highest_transaction","most_volume_purchased","most_volume_sold","largest_concierge_bonus","most_generous_users"] Ja
$.oneOf[0].allOf[1].Payload.boards[].labelKeystring Ja
$.oneOf[0].allOf[1].Payload.boards[].labelstring Ja
$.oneOf[0].allOf[1].Payload.boards[].descriptionKeystring Ja
$.oneOf[0].allOf[1].Payload.boards[].descriptionstring Ja
$.oneOf[0].allOf[1].Payload.boards[].countLabelKeystring Ja
$.oneOf[0].allOf[1].Payload.boards[].countLabelstring Ja
$.oneOf[0].allOf[1].Payload.boards[].rolestring ["buyer","seller"] Ja
$.oneOf[0].allOf[1].Payload.boards[].metricstring ["single_transaction","total_volume","single_bonus","total_bonus"] Ja
$.oneOf[0].allOf[1].Payload.boards[].entriesarray Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[]object Nee
$.oneOf[0].allOf[1].Payload.boards[].entries[].rankinteger Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].userIDinteger Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].transactionCountinteger Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].aliasstring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].avatarURLstring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].avatarEmojistring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImageURLstring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImageURLstring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileURLstring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].transactionCountLabelstring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].amountLabelstring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].thumbUrlstring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].mediaUrlstring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].mediaTypestring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].widthinteger Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].heightinteger Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].isImageboolean Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].isEmbeddedboolean Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frameobject Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frame.positionXPercentnumber Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frame.positionYPercentnumber Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frame.zoomPercentnumber Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].backgroundUrlstring Nee
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].thumbUrlstring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].mediaUrlstring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].mediaTypestring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].widthinteger Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].heightinteger Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].isImageboolean Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].isEmbeddedboolean Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frameobject Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frame.positionXPercentnumber Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frame.positionYPercentnumber Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frame.zoomPercentnumber Ja
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].backgroundUrlstring Nee
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[1]null Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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": []
    }
}
Machineleesbare endpointdocumentatie
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

NaamTypeVerplichtStandaardBeschrijving
listKey string Nee "highest_transaction" highest_transaction, most_volume_purchased, most_volume_sold, largest_concierge_bonus, or most_generous_users.
scopeType string Nee "global" global, continent, or city.
scopeValue string Nee "" Continent code or airport-backed city slug.
timeframe string Nee "today" today, yesterday, month, ytd, year, or alltime.
year int Nee 0 Calendar year used when timeframe=year.
pageSize int Nee 10 Entries per board (1-25).
Voorbeeldverzoek (cURL) 
curl --get \
  'https://nl.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}}'

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$marketdata_get_wall_of_fame_list_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.scopeobject Ja
$.oneOf[0].allOf[1].Payload.scope.scopeTypestring ["global","continent","city"] Ja
$.oneOf[0].allOf[1].Payload.scope.scopeValuestring Ja
$.oneOf[0].allOf[1].Payload.scope.displayNamestring Ja
$.oneOf[0].allOf[1].Payload.scope.labelKeystring Nee
$.oneOf[0].allOf[1].Payload.scope.citySlugstring Nee
$.oneOf[0].allOf[1].Payload.scope.countryCodestring Nee
$.oneOf[0].allOf[1].Payload.scope.isoRegionstring Nee
$.oneOf[0].allOf[1].Payload.timeframeobject Ja
$.oneOf[0].allOf[1].Payload.timeframe.timeframestring ["today","yesterday","month","ytd","year","alltime"] Ja
$.oneOf[0].allOf[1].Payload.timeframe.yearinteger Ja
$.oneOf[0].allOf[1].Payload.timeframe.startDatestring Ja
$.oneOf[0].allOf[1].Payload.timeframe.endDatestring Ja
$.oneOf[0].allOf[1].Payload.timeframe.labelKeystring Ja
$.oneOf[0].allOf[1].Payload.listsarray Ja
$.oneOf[0].allOf[1].Payload.lists[]object Nee
$.oneOf[0].allOf[1].Payload.lists[].listKeystring ["highest_transaction","most_volume_purchased","most_volume_sold","largest_concierge_bonus","most_generous_users"] Ja
$.oneOf[0].allOf[1].Payload.lists[].labelKeystring Ja
$.oneOf[0].allOf[1].Payload.lists[].labelstring Ja
$.oneOf[0].allOf[1].Payload.lists[].descriptionKeystring Ja
$.oneOf[0].allOf[1].Payload.lists[].descriptionstring Ja
$.oneOf[0].allOf[1].Payload.lists[].countLabelKeystring Ja
$.oneOf[0].allOf[1].Payload.lists[].countLabelstring Ja
$.oneOf[0].allOf[1].Payload.lists[].rolestring ["buyer","seller"] Ja
$.oneOf[0].allOf[1].Payload.lists[].metricstring ["single_transaction","total_volume","single_bonus","total_bonus"] Ja
$.oneOf[0].allOf[1].Payload.pageSizeinteger Ja
$.oneOf[0].allOf[1].Payload.boardobject Ja
$.oneOf[0].allOf[1].Payload.board.listKeystring ["highest_transaction","most_volume_purchased","most_volume_sold","largest_concierge_bonus","most_generous_users"] Ja
$.oneOf[0].allOf[1].Payload.board.labelKeystring Ja
$.oneOf[0].allOf[1].Payload.board.labelstring Ja
$.oneOf[0].allOf[1].Payload.board.descriptionKeystring Ja
$.oneOf[0].allOf[1].Payload.board.descriptionstring Ja
$.oneOf[0].allOf[1].Payload.board.countLabelKeystring Ja
$.oneOf[0].allOf[1].Payload.board.countLabelstring Ja
$.oneOf[0].allOf[1].Payload.board.rolestring ["buyer","seller"] Ja
$.oneOf[0].allOf[1].Payload.board.metricstring ["single_transaction","total_volume","single_bonus","total_bonus"] Ja
$.oneOf[0].allOf[1].Payload.board.entriesarray Ja
$.oneOf[0].allOf[1].Payload.board.entries[]object Nee
$.oneOf[0].allOf[1].Payload.board.entries[].rankinteger Ja
$.oneOf[0].allOf[1].Payload.board.entries[].userIDinteger Ja
$.oneOf[0].allOf[1].Payload.board.entries[].transactionCountinteger Ja
$.oneOf[0].allOf[1].Payload.board.entries[].aliasstring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].avatarURLstring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].avatarEmojistring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImageURLstring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImageURLstring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileURLstring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].transactionCountLabelstring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].amountLabelstring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].thumbUrlstring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].mediaUrlstring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].mediaTypestring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].widthinteger Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].heightinteger Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].isImageboolean Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].isEmbeddedboolean Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].frameobject Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].frame.positionXPercentnumber Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].frame.positionYPercentnumber Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].frame.zoomPercentnumber Ja
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].backgroundUrlstring Nee
$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].thumbUrlstring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].mediaUrlstring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].mediaTypestring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].widthinteger Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].heightinteger Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].isImageboolean Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].isEmbeddedboolean Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].frameobject Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].frame.positionXPercentnumber Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].frame.positionYPercentnumber Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].frame.zoomPercentnumber Ja
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].backgroundUrlstring Nee
$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.entriesarray Ja
$.oneOf[0].allOf[1].Payload.entries[]object Nee
$.oneOf[0].allOf[1].Payload.entries[].rankinteger Ja
$.oneOf[0].allOf[1].Payload.entries[].userIDinteger Ja
$.oneOf[0].allOf[1].Payload.entries[].transactionCountinteger Ja
$.oneOf[0].allOf[1].Payload.entries[].aliasstring Ja
$.oneOf[0].allOf[1].Payload.entries[].avatarURLstring Ja
$.oneOf[0].allOf[1].Payload.entries[].avatarEmojistring Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImageURLstring Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImageURLstring Ja
$.oneOf[0].allOf[1].Payload.entries[].profileURLstring Ja
$.oneOf[0].allOf[1].Payload.entries[].transactionCountLabelstring Ja
$.oneOf[0].allOf[1].Payload.entries[].amountLabelstring Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].thumbUrlstring Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].mediaUrlstring Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].mediaTypestring Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].widthinteger Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].heightinteger Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].isImageboolean Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].isEmbeddedboolean Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].frameobject Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].frame.positionXPercentnumber Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].frame.positionYPercentnumber Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].frame.zoomPercentnumber Ja
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].backgroundUrlstring Nee
$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].idinteger Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].thumbUrlstring Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].mediaUrlstring Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].mediaTypestring Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].widthinteger Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].heightinteger Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].titlestring Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].isImageboolean Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].isEmbeddedboolean Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].frameobject Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].frame.positionXPercentnumber Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].frame.positionYPercentnumber Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].frame.zoomPercentnumber Ja
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].backgroundUrlstring Nee
$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[1]null Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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": []
    }
}
Machineleesbare endpointdocumentatie
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

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

Retourwaarde

JSON
See the shared response schema and synthetic example.
Antwoordvelden
VeldTypeVerplichtBeschrijving
$marketdata_get_world_top_Response Ja
$.oneOf[0] Ja
$.oneOf[0].allOf[0]object Ja
$.oneOf[0].allOf[0].RequestUserAliasstring Ja
$.oneOf[0].allOf[0].RequestPathstring | null Ja
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Ja
$.oneOf[0].allOf[0].ResponseCodeinteger Ja
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Ja
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring Nee
$.oneOf[0].allOf[1]object Ja
$.oneOf[0].allOf[1].Payloadobject Ja
$.oneOf[0].allOf[1].Payload.categorySlugstring Ja
$.oneOf[0].allOf[1].Payload.resolvedCategorySlugstring Ja
$.oneOf[0].allOf[1].Payload.seoCategorySlugstring Ja
$.oneOf[0].allOf[1].Payload.categoryTitlePluralstring Ja
$.oneOf[0].allOf[1].Payload.canonicalURL Ja
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[0]string Ja
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[1] = false Ja
$.oneOf[0].allOf[1].Payload.category Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0]object Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].slugstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlugstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].namestring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePluralstring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDTypestring Ja
$.oneOf[0].allOf[1].Payload.category.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.citiesarray Ja
$.oneOf[0].allOf[1].Payload.cities[]object Nee
$.oneOf[0].allOf[1].Payload.cities[].citySlugstring Ja
$.oneOf[0].allOf[1].Payload.cities[].cityNamestring Ja
$.oneOf[0].allOf[1].Payload.cities[].stateShortstring Ja
$.oneOf[0].allOf[1].Payload.cities[].isoRegionstring Ja
$.oneOf[0].allOf[1].Payload.cities[].countryCodestring Ja
$.oneOf[0].allOf[1].Payload.cities[].countryNamestring Ja
$.oneOf[0].allOf[1].Payload.cities[].continentShortstring Ja
$.oneOf[0].allOf[1].Payload.cities[].imageURL256string Ja
$.oneOf[0].allOf[1].Payload.cities[].imageURL512string Ja
$.oneOf[0].allOf[1].Payload.cities[].detailURLstring Ja
$.oneOf[0].allOf[1].Payload.cities[].tradingActivity30Dayinteger Ja
$.oneOf[0].allOf[1].Payload.cities[].numberTransactionsinteger Ja
$.oneOf[0].allOf[1].Payload.cities[].venueCountinteger Ja
$.oneOf[0].allOf[1].Payload.cities[].rankinteger Ja
$.oneOf[0].allOf[1].Payload.cities[].isHotboolean Ja
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice Ja
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[0]integer Ja
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinatesobject Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[0]number Ja
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[1]null Ja
$.oneOf[0].allOf[1].Payload.cities[].distanceMetersnumber Nee
$.oneOf[0].allOf[1].Payload.cities[].distanceMilesnumber Nee
$.oneOf[0].allOf[1].Payload.totalResultsinteger Ja
$.oneOf[0].allOf[1].Payload.dateRangestring ["7d","30d","90d","180d","365d"] Ja
$.oneOf[1]object Ja
$.oneOf[1].RequestUserAliasstring Ja
$.oneOf[1].RequestPathstring | null Ja
$.oneOf[1].RequestStatus = "Failed" Ja
$.oneOf[1].ResponseCodeinteger Ja
$.oneOf[1].ResponseMessageAPIResponseMessage Ja
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Ja
$.oneOf[1].ResponseMessage.oneOf[1]array Ja
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage Nee
$.oneOf[1].ResponseMessage.oneOf[2]object Ja
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage Nee
$.oneOf[1].RequestImpersonatedByUserAliasstring Nee
Voorbeeldantwoord 
{
    "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"
    }
}
Machineleesbare endpointdocumentatie