AT AppointmentTrader
Iniciar sesión
En línea ahora  

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

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
citySlug string si — 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.
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.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}}'

Respuesta

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

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
continent string si — 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.
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.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}}'

Respuesta

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

/v1/marketdata/get_highest_converting_locations

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

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
pageSize int No 25 Defines how many results will be return per request
pageNumber int No 0 Defines which page should be returned
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.appointmenttrader.com/v1/marketdata/get_highest_converting_locations' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$marketdata_get_highest_converting_locations_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" si
$.oneOf[0].allOf[1].Payload.ResponseBodyobject si
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring si
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0]DatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0].oneOf[0]integer si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0].oneOf[1]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0]DatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0].oneOf[0]integer si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0].oneOf[1]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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": []
        }
    }
}
Documentación del endpoint legible por máquinas
GET

/v1/marketdata/get_map_points

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

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
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.
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.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}}'

Respuesta

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

/v1/marketdata/get_most_bids_least_asks

#
Returns locations with the highest bids vs listing ratio

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
pageSize int No 25 Defines how many results will be return per request
pageNumber int No 0 Defines which page should be returned
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.appointmenttrader.com/v1/marketdata/get_most_bids_least_asks' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$marketdata_get_most_bids_least_asks_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" si
$.oneOf[0].allOf[1].Payload.ResponseBodyobject si
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring si
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0]DatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[0]integer si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[1]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0]DatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[0]integer si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[1]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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": []
        }
    }
}
Documentación del endpoint legible por máquinas
GET

/v1/marketdata/get_most_underserved_locations

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

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
pageSize int No 25 Defines how many results will be return per request
pageNumber int No 0 Defines which page should be returned
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.appointmenttrader.com/v1/marketdata/get_most_underserved_locations' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$marketdata_get_most_underserved_locations_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" si
$.oneOf[0].allOf[1].Payload.ResponseBodyobject si
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring si
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0]DatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[0]integer si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[1]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings = 0 si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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": []
        }
    }
}
Documentación del endpoint legible por máquinas
GET

/v1/marketdata/get_most_viewed_locations_with_least_listings

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

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
pageSize int No 25 Defines how many results will be return per request
pageNumber int No 0 Defines which page should be returned
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.appointmenttrader.com/v1/marketdata/get_most_viewed_locations_with_least_listings' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$marketdata_get_most_viewed_locations_with_least_listings_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" si
$.oneOf[0].allOf[1].Payload.ResponseBodyobject si
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring si
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0]DatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[0]integer si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[1]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0]DatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[0]integer si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[1]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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": []
        }
    }
}
Documentación del endpoint legible por máquinas
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.

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
pageSize int No 12 Number of recently viewed items to return (1-20).
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.appointmenttrader.com/v1/marketdata/get_recently_viewed' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}'

Respuesta

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

/v1/marketdata/get_required_inventory_forecast

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

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
locationAlias string si — Slug found after the slash when opening a location in the portal
dateRangeStart string si — oldest date of metrics to be reported Date format: YYYY-MM-DD
dateRangeEnd string si — 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
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.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}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$marketdata_get_required_inventory_forecast_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" si
$.oneOf[0].allOf[1].Payload.ResponseBodyobject si
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring si
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject si
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.yearOverYearAverageMarketPriceChangenumber si
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberSuggestedTransactions = 0 si
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberSuggestedBids = 0 si
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberSuggestedListingPurchases = 0 si
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalSuggestedDollarVolume = 0 si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0]object si
$.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 si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentNumberBidsinteger si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentHighBidinteger si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentLowBidinteger si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentBidVolumeinteger si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentNumberListingsinteger si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentListingHighPriceinteger si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentListingLowPriceinteger si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentListingAveragePriceinteger si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.averagePricenumber si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.minimumPricenumber si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.maximumPricenumber si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.totalDemandnumber si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0]object si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].CreatedDatestring si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastUpdateDatestring si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Namestring si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Descriptionstring si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].URLstring si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Icon si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Icon.anyOf[0]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Icon.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].event-locationAlias si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].event-locationAlias.anyOf[0]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].event-locationAlias.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[0]DatabaseInteger siInteger 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 si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[0].oneOf[1]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrameobject si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.StartTime si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.StartTime.anyOf[0]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.StartTime.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.EndTime si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.EndTime.anyOf[0]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.EndTime.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastPeriodTimeFrameobject si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastPeriodTimeFrame.StartTimestring si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastPeriodTimeFrame.EndTimestring si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.sourceDataLocationAliasListarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.sourceDataLocationAliasList[]string No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.lastYearsCorrespondingDayListarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.lastYearsCorrespondingDayList[]string No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[1]array si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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": []
        }
    }
}
Documentación del endpoint legible por máquinas
GET

/v1/marketdata/get_toplist

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

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
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
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.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}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$marketdata_get_toplist_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" si
$.oneOf[0].allOf[1].Payload.ResponseBodyobject si
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring si
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject si
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocationsDatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocations.oneOf[0]integer si
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocations.oneOf[1]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object No
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0]DatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0].oneOf[0]integer si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0].oneOf[1]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0]DatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[0]integer si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[1]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0]DatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0].oneOf[0]integer si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0].oneOf[1]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0]DatabaseInteger siInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0].oneOf[0]integer si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0].oneOf[1]string si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRankChangeData siPipe-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 si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRankChangeData.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRankChangeData siPipe-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 si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRankChangeData.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray si
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string No
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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": []
        }
    }
}
Documentación del endpoint legible por máquinas
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.

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
lat float si — Latitude in decimal degrees.
long float si — 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.
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.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}}'

Respuesta

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

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
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).
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.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}}'

Respuesta

JSON
See the shared response schema and synthetic example.
Campos de respuesta
CampoTipoObligatorioDescripción
$marketdata_get_wall_of_fame_Response si
$.oneOf[0] si
$.oneOf[0].allOf[0]object si
$.oneOf[0].allOf[0].RequestUserAliasstring si
$.oneOf[0].allOf[0].RequestPathstring | null si
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" si
$.oneOf[0].allOf[0].ResponseCodeinteger si
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object si
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring No
$.oneOf[0].allOf[1]object si
$.oneOf[0].allOf[1].Payloadobject si
$.oneOf[0].allOf[1].Payload.scopeobject si
$.oneOf[0].allOf[1].Payload.scope.scopeTypestring ["global","continent","city"] si
$.oneOf[0].allOf[1].Payload.scope.scopeValuestring si
$.oneOf[0].allOf[1].Payload.scope.displayNamestring si
$.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 si
$.oneOf[0].allOf[1].Payload.timeframe.timeframestring ["today","yesterday","month","ytd","year","alltime"] si
$.oneOf[0].allOf[1].Payload.timeframe.yearinteger si
$.oneOf[0].allOf[1].Payload.timeframe.startDatestring si
$.oneOf[0].allOf[1].Payload.timeframe.endDatestring si
$.oneOf[0].allOf[1].Payload.timeframe.labelKeystring si
$.oneOf[0].allOf[1].Payload.listsarray si
$.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"] si
$.oneOf[0].allOf[1].Payload.lists[].labelKeystring si
$.oneOf[0].allOf[1].Payload.lists[].labelstring si
$.oneOf[0].allOf[1].Payload.lists[].descriptionKeystring si
$.oneOf[0].allOf[1].Payload.lists[].descriptionstring si
$.oneOf[0].allOf[1].Payload.lists[].countLabelKeystring si
$.oneOf[0].allOf[1].Payload.lists[].countLabelstring si
$.oneOf[0].allOf[1].Payload.lists[].rolestring ["buyer","seller"] si
$.oneOf[0].allOf[1].Payload.lists[].metricstring ["single_transaction","total_volume","single_bonus","total_bonus"] si
$.oneOf[0].allOf[1].Payload.pageSizeinteger si
$.oneOf[0].allOf[1].Payload.boardsarray si
$.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"] si
$.oneOf[0].allOf[1].Payload.boards[].labelKeystring si
$.oneOf[0].allOf[1].Payload.boards[].labelstring si
$.oneOf[0].allOf[1].Payload.boards[].descriptionKeystring si
$.oneOf[0].allOf[1].Payload.boards[].descriptionstring si
$.oneOf[0].allOf[1].Payload.boards[].countLabelKeystring si
$.oneOf[0].allOf[1].Payload.boards[].countLabelstring si
$.oneOf[0].allOf[1].Payload.boards[].rolestring ["buyer","seller"] si
$.oneOf[0].allOf[1].Payload.boards[].metricstring ["single_transaction","total_volume","single_bonus","total_bonus"] si
$.oneOf[0].allOf[1].Payload.boards[].entriesarray si
$.oneOf[0].allOf[1].Payload.boards[].entries[]object No
$.oneOf[0].allOf[1].Payload.boards[].entries[].rankinteger si
$.oneOf[0].allOf[1].Payload.boards[].entries[].userIDinteger si
$.oneOf[0].allOf[1].Payload.boards[].entries[].transactionCountinteger si
$.oneOf[0].allOf[1].Payload.boards[].entries[].aliasstring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].avatarURLstring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].avatarEmojistring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImageURLstring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImageURLstring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileURLstring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].transactionCountLabelstring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].amountLabelstring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0]object si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].idinteger si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].thumbUrlstring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].mediaUrlstring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].mediaTypestring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].widthinteger si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].heightinteger si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].titlestring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].isImageboolean si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].isEmbeddedboolean si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frameobject si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frame.positionXPercentnumber si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frame.positionYPercentnumber si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frame.zoomPercentnumber si
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[1]null si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0]object si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].idinteger si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].thumbUrlstring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].mediaUrlstring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].mediaTypestring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].widthinteger si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].heightinteger si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].titlestring si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].isImageboolean si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].isEmbeddedboolean si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frameobject si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frame.positionXPercentnumber si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frame.positionYPercentnumber si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frame.zoomPercentnumber si
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].backgroundUrlstring No
$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[1]null si
$.oneOf[1]object si
$.oneOf[1].RequestUserAliasstring si
$.oneOf[1].RequestPathstring | null si
$.oneOf[1].RequestStatus = "Failed" si
$.oneOf[1].ResponseCodeinteger si
$.oneOf[1].ResponseMessageAPIResponseMessage si
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null si
$.oneOf[1].ResponseMessage.oneOf[1]array si
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage No
$.oneOf[1].ResponseMessage.oneOf[2]object si
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage No
$.oneOf[1].RequestImpersonatedByUserAliasstring No
Ejemplo de respuesta 
{
    "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": []
    }
}
Documentación del endpoint legible por máquinas
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.

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
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).
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.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}}'

Respuesta

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

Parámetros

NombreTipoObligatorioPredeterminadoDescripción
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.
Ejemplo de solicitud (cURL) 
curl --get \
  'https://es.appointmenttrader.com/v1/marketdata/get_world_top' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'categorySlug={{categorySlug}}' \
  --data-urlencode 'dateRange={{dateRange}}'

Respuesta

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