متصلون الآن  

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

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
citySlug string نعم — CloseByCitySlug (e.g. los-angeles, new-york).
pageSize int لا 20 Venues per page (1-50).
pageNumber int لا 0 Zero-based page number.
categorySlug string لا "" Optional category filter.
dateRange string لا "90d" Activity window.
مثال طلب (cURL)
curl --get \
  'https://ar.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}}'

القيمة المُرجعة

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

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
continent string نعم — Editorial continent code: NA, EU, AS, MEA, SA, OC.
pageSize int لا 100 Number of cities (1-100).
categorySlug string لا "" Optional category filter.
dateRange string لا "90d" Activity window.
مثال طلب (cURL)
curl --get \
  'https://ar.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}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$marketdata_get_continent_country_top_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.categorySlugstring نعم
$.oneOf[0].allOf[1].Payload.resolvedCategorySlugstring نعم
$.oneOf[0].allOf[1].Payload.seoCategorySlugstring نعم
$.oneOf[0].allOf[1].Payload.categoryTitlePluralstring نعم
$.oneOf[0].allOf[1].Payload.canonicalURL نعم
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[0]string نعم
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[1] = false نعم
$.oneOf[0].allOf[1].Payload.category نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].slugstring نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlugstring نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].namestring نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePluralstring نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDTypestring نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.continentstring ["NA","EU","AS","MEA","SA","OC"] نعم
$.oneOf[0].allOf[1].Payload.countriesarray نعم
$.oneOf[0].allOf[1].Payload.countries[]object لا
$.oneOf[0].allOf[1].Payload.countries[].countryCodestring نعم
$.oneOf[0].allOf[1].Payload.countries[].countryNamestring نعم
$.oneOf[0].allOf[1].Payload.countries[].citiesarray نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[]object لا
$.oneOf[0].allOf[1].Payload.countries[].cities[].citySlugstring نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].cityNamestring نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].stateShortstring نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].isoRegionstring نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].countryCodestring نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].countryNamestring نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].continentShortstring نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].imageURL256string نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].imageURL512string نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].detailURLstring نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].tradingActivity30Dayinteger نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].numberTransactionsinteger نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].venueCountinteger نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].rankinteger نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].isHotboolean نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].avgTradingPrice نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].avgTradingPrice.anyOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].avgTradingPrice.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinatesobject نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.latitude نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.latitude.anyOf[0]number نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.latitude.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.longitude نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.longitude.anyOf[0]number نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].coordinates.longitude.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.countries[].cities[].distanceMetersnumber لا
$.oneOf[0].allOf[1].Payload.countries[].cities[].distanceMilesnumber لا
$.oneOf[0].allOf[1].Payload.totalCitiesinteger نعم
$.oneOf[0].allOf[1].Payload.dateRangestring ["7d","30d","90d","180d","365d"] نعم
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة
{
    "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"
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا
GET

/v1/marketdata/get_highest_converting_locations

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

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
pageSize int لا 25 Defines how many results will be return per request
pageNumber int لا 0 Defines which page should be returned
مثال طلب (cURL)
curl --get \
  'https://ar.appointmenttrader.com/v1/marketdata/get_highest_converting_locations' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$marketdata_get_highest_converting_locations_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" نعم
$.oneOf[0].allOf[1].Payload.ResponseBodyobject نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object لا
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0]DatabaseInteger نعمInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0].oneOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[0].oneOf[1]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayViewToTransactionConversionBasisPoints.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0]DatabaseInteger نعمInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0].oneOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[0].oneOf[1]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberTransactions.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string لا
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة
{
    "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": []
        }
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا
GET

/v1/marketdata/get_map_points

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

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
scope string لا "overview" overview or city.
citySlug string لا "" CloseByCitySlug when scope=city.
west float لا -180 Viewport west longitude.
south float لا -85 Viewport south latitude.
east float لا 180 Viewport east longitude.
north float لا 85 Viewport north latitude.
zoom int لا 2 Current map zoom. Below 6 returns city points; 6 and above returns location points.
pageSize int لا 200 Number of points to return (1-300).
categorySlug string لا "" Optional category filter.
dateRange string لا "90d" Activity window: 7d, 30d, 90d, 180d, 365d.
مثال طلب (cURL)
curl --get \
  'https://ar.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}}'

القيمة المُرجعة

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

/v1/marketdata/get_most_bids_least_asks

#
Returns locations with the highest bids vs listing ratio

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
pageSize int لا 25 Defines how many results will be return per request
pageNumber int لا 0 Defines which page should be returned
مثال طلب (cURL)
curl --get \
  'https://ar.appointmenttrader.com/v1/marketdata/get_most_bids_least_asks' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$marketdata_get_most_bids_least_asks_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" نعم
$.oneOf[0].allOf[1].Payload.ResponseBodyobject نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object لا
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0]DatabaseInteger نعمInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[1]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0]DatabaseInteger نعمInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[1]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string لا
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة
{
    "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": []
        }
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا
GET

/v1/marketdata/get_most_underserved_locations

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

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
pageSize int لا 25 Defines how many results will be return per request
pageNumber int لا 0 Defines which page should be returned
مثال طلب (cURL)
curl --get \
  'https://ar.appointmenttrader.com/v1/marketdata/get_most_underserved_locations' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$marketdata_get_most_underserved_locations_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" نعم
$.oneOf[0].allOf[1].Payload.ResponseBodyobject نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object لا
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0]DatabaseInteger نعمInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[0].oneOf[1]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30dayNumberBids.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings = 0 نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string لا
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة
{
    "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": []
        }
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا
GET

/v1/marketdata/get_most_viewed_locations_with_least_listings

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

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
pageSize int لا 25 Defines how many results will be return per request
pageNumber int لا 0 Defines which page should be returned
مثال طلب (cURL)
curl --get \
  'https://ar.appointmenttrader.com/v1/marketdata/get_most_viewed_locations_with_least_listings' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$marketdata_get_most_viewed_locations_with_least_listings_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" نعم
$.oneOf[0].allOf[1].Payload.ResponseBodyobject نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object لا
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0]DatabaseInteger نعمInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[1]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0]DatabaseInteger نعمInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[0].oneOf[1]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberListings.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string لا
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة
{
    "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": []
        }
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا
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.

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
pageSize int لا 12 Number of recently viewed items to return (1-20).
مثال طلب (cURL)
curl --get \
  'https://ar.appointmenttrader.com/v1/marketdata/get_recently_viewed' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}'

القيمة المُرجعة

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

/v1/marketdata/get_required_inventory_forecast

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

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
locationAlias string نعم — Slug found after the slash when opening a location in the portal
dateRangeStart string نعم — oldest date of metrics to be reported Date format: YYYY-MM-DD
dateRangeEnd string نعم — latest date of metrics to be reported Date format: YYYY-MM-DD
additionalLocationAliasSourceList string لا "" 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 لا 0 Items to exclude based on price
desiredProfitBasisPoints int لا 10000 defines how much profit should be made per line item
pageSize int لا 1500 Defines how many results will be return per request
pageNumber int لا 0 Defines which page should be returned
مثال طلب (cURL)
curl --get \
  'https://ar.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}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$marketdata_get_required_inventory_forecast_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" نعم
$.oneOf[0].allOf[1].Payload.ResponseBodyobject نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.yearOverYearAverageMarketPriceChangenumber نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberSuggestedTransactions = 0 نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberSuggestedBids = 0 نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalNumberSuggestedListingPurchases = 0 نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.totalSuggestedDollarVolume = 0 نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*object لا
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*object لا
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*object لا
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*object لا
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.numberHistoricalTransactionsinteger نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentNumberBidsinteger نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentHighBidinteger نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentLowBidinteger نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentBidVolumeinteger نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentNumberListingsinteger نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentListingHighPriceinteger نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentListingLowPriceinteger نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.currentListingAveragePriceinteger نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.averagePricenumber نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.minimumPricenumber نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.maximumPricenumber نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.totalDemandnumber نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].CreatedDatestring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastUpdateDatestring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Namestring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Descriptionstring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].URLstring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Icon نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Icon.anyOf[0]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].Icon.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].event-locationAlias نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].event-locationAlias.anyOf[0]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].event-locationAlias.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[0]DatabaseInteger نعمInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[0].oneOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[0].oneOf[1]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].EffectRadiusInMeters.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrameobject نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.StartTime نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.StartTime.anyOf[0]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.StartTime.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.EndTime نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.EndTime.anyOf[0]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].ThisPeriodTimeFrame.EndTime.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastPeriodTimeFrameobject نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastPeriodTimeFrame.StartTimestring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[0].LastPeriodTimeFrame.EndTimestring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.specialEventInformation.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.sourceDataLocationAliasListarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.sourceDataLocationAliasList[]string لا
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.lastYearsCorrespondingDayListarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].*.*.*.*.lastYearsCorrespondingDayList[]string لا
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[1]array نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray نعم
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة
{
    "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": []
        }
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا
GET

/v1/marketdata/get_toplist

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

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
cityCode string لا "" The code of the City that is being queried If left empty worldwide results are being returned Exemplary Value: NYC
categorySlug string لا "" The slug of the location category that is being requested. If left empty all categories are being returned. Exemplary Value: restaurants
pageSize int لا 25 Defines how many results will be return per request
pageNumber int لا 0 Defines which page should be returned
مثال طلب (cURL)
curl --get \
  'https://ar.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}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$marketdata_get_toplist_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.ATResponseObjectType = "NestedKeyValueList" نعم
$.oneOf[0].allOf[1].Payload.ResponseBodyobject نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.Namestring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformationobject نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocationsDatabaseInteger نعمInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocations.oneOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocations.oneOf[1]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueListarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]object لا
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAliasstring نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0]DatabaseInteger نعمInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0].oneOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[0].oneOf[1]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayNumberBids.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0]DatabaseInteger نعمInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[0].oneOf[1]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].30DayATPageViews.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0]DatabaseInteger نعمInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0].oneOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[0].oneOf[1]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRank.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0]DatabaseInteger نعمInteger value; legacy MySQL reads may serialize it as a numeric string.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0].oneOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[0].oneOf[1]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRank.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRankChangeData نعمPipe-separated changes for 1 day, 7 days, 30 days, 3 months and 12 months; empty segments mean unavailable.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRankChangeData.anyOf[0]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].GlobalATRankChangeData.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRankChangeData نعمPipe-separated changes for 1 day, 7 days, 30 days, 3 months and 12 months; empty segments mean unavailable.
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRankChangeData.anyOf[0]string نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].LocalATRankChangeData.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldListarray نعم
$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]string لا
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة
{
    "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": []
        }
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا
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.

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
scopeType string لا "global" global, continent, or city.
scopeValue string لا "" Continent code (NA, EU, AS, MEA, SA, OC) or airport-backed city slug when scopeType=city.
timeframe string لا "today" today, yesterday, month, ytd, year, or alltime.
year int لا 0 Calendar year used when timeframe=year.
pageSize int لا 10 Entries per board (1-25).
مثال طلب (cURL)
curl --get \
  'https://ar.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}}'

القيمة المُرجعة

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

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
listKey string لا "highest_transaction" highest_transaction, most_volume_purchased, most_volume_sold, largest_concierge_bonus, or most_generous_users.
scopeType string لا "global" global, continent, or city.
scopeValue string لا "" Continent code or airport-backed city slug.
timeframe string لا "today" today, yesterday, month, ytd, year, or alltime.
year int لا 0 Calendar year used when timeframe=year.
pageSize int لا 10 Entries per board (1-25).
مثال طلب (cURL)
curl --get \
  'https://ar.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}}'

القيمة المُرجعة

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

المعلمات

الاسمالنوعمطلوبالافتراضيالوصف
pageSize int لا 20 Number of cities to return (1-100).
categorySlug string لا "" Optional category filter (restaurants, events, concerts, hotels, dmv, mentoring, shopping, golf, rv, marinas, cruises, houseparties, dj, concierges, general). Empty = all categories.
dateRange string لا "90d" Activity window: 7d, 30d, 90d, 180d, 365d.
مثال طلب (cURL)
curl --get \
  'https://ar.appointmenttrader.com/v1/marketdata/get_world_top' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'categorySlug={{categorySlug}}' \
  --data-urlencode 'dateRange={{dateRange}}'

القيمة المُرجعة

JSON
See the shared response schema and synthetic example.
حقول الاستجابة
الحقلالنوعمطلوبالوصف
$marketdata_get_world_top_Response نعم
$.oneOf[0] نعم
$.oneOf[0].allOf[0]object نعم
$.oneOf[0].allOf[0].RequestUserAliasstring نعم
$.oneOf[0].allOf[0].RequestPathstring | null نعم
$.oneOf[0].allOf[0].RequestStatus = "Succeeded" نعم
$.oneOf[0].allOf[0].ResponseCodeinteger نعم
$.oneOf[0].allOf[0].ResponseMessageAPIResponseMessage نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]array نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]object نعم
$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[0].allOf[0].RequestImpersonatedByUserAliasstring لا
$.oneOf[0].allOf[1]object نعم
$.oneOf[0].allOf[1].Payloadobject نعم
$.oneOf[0].allOf[1].Payload.categorySlugstring نعم
$.oneOf[0].allOf[1].Payload.resolvedCategorySlugstring نعم
$.oneOf[0].allOf[1].Payload.seoCategorySlugstring نعم
$.oneOf[0].allOf[1].Payload.categoryTitlePluralstring نعم
$.oneOf[0].allOf[1].Payload.canonicalURL نعم
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[0]string نعم
$.oneOf[0].allOf[1].Payload.canonicalURL.anyOf[1] = false نعم
$.oneOf[0].allOf[1].Payload.category نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0]object نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].id.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].slugstring نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlugstring نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].namestring نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePluralstring نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDTypestring نعم
$.oneOf[0].allOf[1].Payload.category.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.citiesarray نعم
$.oneOf[0].allOf[1].Payload.cities[]object لا
$.oneOf[0].allOf[1].Payload.cities[].citySlugstring نعم
$.oneOf[0].allOf[1].Payload.cities[].cityNamestring نعم
$.oneOf[0].allOf[1].Payload.cities[].stateShortstring نعم
$.oneOf[0].allOf[1].Payload.cities[].isoRegionstring نعم
$.oneOf[0].allOf[1].Payload.cities[].countryCodestring نعم
$.oneOf[0].allOf[1].Payload.cities[].countryNamestring نعم
$.oneOf[0].allOf[1].Payload.cities[].continentShortstring نعم
$.oneOf[0].allOf[1].Payload.cities[].imageURL256string نعم
$.oneOf[0].allOf[1].Payload.cities[].imageURL512string نعم
$.oneOf[0].allOf[1].Payload.cities[].detailURLstring نعم
$.oneOf[0].allOf[1].Payload.cities[].tradingActivity30Dayinteger نعم
$.oneOf[0].allOf[1].Payload.cities[].numberTransactionsinteger نعم
$.oneOf[0].allOf[1].Payload.cities[].venueCountinteger نعم
$.oneOf[0].allOf[1].Payload.cities[].rankinteger نعم
$.oneOf[0].allOf[1].Payload.cities[].isHotboolean نعم
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice نعم
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[0]integer نعم
$.oneOf[0].allOf[1].Payload.cities[].avgTradingPrice.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.cities[].coordinatesobject نعم
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude نعم
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[0]number نعم
$.oneOf[0].allOf[1].Payload.cities[].coordinates.latitude.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude نعم
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[0]number نعم
$.oneOf[0].allOf[1].Payload.cities[].coordinates.longitude.anyOf[1]null نعم
$.oneOf[0].allOf[1].Payload.cities[].distanceMetersnumber لا
$.oneOf[0].allOf[1].Payload.cities[].distanceMilesnumber لا
$.oneOf[0].allOf[1].Payload.totalResultsinteger نعم
$.oneOf[0].allOf[1].Payload.dateRangestring ["7d","30d","90d","180d","365d"] نعم
$.oneOf[1]object نعم
$.oneOf[1].RequestUserAliasstring نعم
$.oneOf[1].RequestPathstring | null نعم
$.oneOf[1].RequestStatus = "Failed" نعم
$.oneOf[1].ResponseCodeinteger نعم
$.oneOf[1].ResponseMessageAPIResponseMessage نعم
$.oneOf[1].ResponseMessage.oneOf[0]string | number | boolean | null نعم
$.oneOf[1].ResponseMessage.oneOf[1]array نعم
$.oneOf[1].ResponseMessage.oneOf[1][]APIResponseMessage لا
$.oneOf[1].ResponseMessage.oneOf[2]object نعم
$.oneOf[1].ResponseMessage.oneOf[2].*APIResponseMessage لا
$.oneOf[1].RequestImpersonatedByUserAliasstring لا
مثال استجابة
{
    "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"
    }
}
توثيق نقطة النهاية القابل للقراءة آليًا