AT AppointmentTrader
Accedi
Online ora  

/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/.

Parametri

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

Risposta

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
continent string Sì — Editorial continent code: NA, EU, AS, MEA, SA, OC.
pageSize int No 100 Number of cities (1-100).
categorySlug string No "" Optional category filter.
dateRange string No "90d" Activity window.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.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}}'

Risposta

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

/v1/marketdata/get_highest_converting_locations

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

Parametri

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

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$marketdata_get_highest_converting_locations_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Sì
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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": []
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
GET

/v1/marketdata/get_map_points

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

Parametri

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

Risposta

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

/v1/marketdata/get_most_bids_least_asks

#
Returns locations with the highest bids vs listing ratio

Parametri

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

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$marketdata_get_most_bids_least_asks_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Sì
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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": []
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
GET

/v1/marketdata/get_most_underserved_locations

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

Parametri

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

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$marketdata_get_most_underserved_locations_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Sì
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings = 0 Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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": []
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
GET

/v1/marketdata/get_most_viewed_locations_with_least_listings

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

Parametri

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

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$marketdata_get_most_viewed_locations_with_least_listings_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Sì
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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": []
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

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

Risposta

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

/v1/marketdata/get_required_inventory_forecast

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

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
locationAlias string Sì — Slug found after the slash when opening a location in the portal
dateRangeStart string Sì — oldest date of metrics to be reported Date format: YYYY-MM-DD
dateRangeEnd string Sì — latest date of metrics to be reported Date format: YYYY-MM-DD
additionalLocationAliasSourceList string No "" Comma separated List of other locations that should be used as a data source for the forecast, related locations can be found at /v1/location/get_related_location_list
maximumPrice int No 0 Items to exclude based on price
desiredProfitBasisPoints int No 10000 defines how much profit should be made per line item
pageSize int No 1500 Defines how many results will be return per request
pageNumber int No 0 Defines which page should be returned
Esempio di richiesta (cURL) 
curl --get \
  'https://it.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}}'

Risposta

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

/v1/marketdata/get_toplist

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

Parametri

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

Risposta

JSON
See the shared response schema and synthetic example.
Campi della risposta
CampoTipoObbligatorioDescrizione
$marketdata_get_toplist_Response Sì
$.oneOf[0] Sì
$.oneOf[0].allOf[0]object Sì
$.oneOf[0].allOf[0].RequestUserAliasstring Sì
$.oneOf[0].allOf[0].RequestPathstring | null Sì
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" Sì
$.oneOf[0].allOf[0].ResponseCodeinteger Sì
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object Sì
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object Sì
$.oneOf[0].allOf[1].Payloadobject Sì
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" Sì
$.oneOf[0].allOf[1].Payload.ResponseBodyobject Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocationsDatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocations.oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocations.oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0]DatabaseInteger SìInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0].oneOf[0]integer Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0].oneOf[1]string Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRankChangeData SìPipe-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 Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRankChangeData.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRankChangeData SìPipe-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 Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRankChangeData.anyOf[1]null Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray Sì
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object Sì
$.oneOf[1].RequestUserAliasstring Sì
$.oneOf[1].RequestPathstring | null Sì
$.oneOf[1].RequestStatus = "Failed" Sì
$.oneOf[1].ResponseCodeinteger Sì
$.oneOf[1].ResponseMessageAPIResponseMessage Sì
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null Sì
$.oneOf[1].ResponseMessage.oneOf[1]array Sì
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object Sì
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Esempio di risposta 
{
    "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": []
        }
    }
}
Documentazione dell’endpoint leggibile dalle macchine
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.

Parametri

NomeTipoObbligatorioPredefinitoDescrizione
lat float Sì — Latitude in decimal degrees.
long float Sì — Longitude in decimal degrees.
pageSize int No 4 Number of cities to return (1-20).
categorySlug string No "" Optional category filter.
dateRange string No "90d" Activity window.
Esempio di richiesta (cURL) 
curl --get \
  'https://it.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}}'

Risposta

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

Parametri

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

Risposta

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

Parametri

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

Risposta

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

Parametri

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

Risposta

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