מדריך API של marketdata

חיפוש בכל נקודות הקצה

/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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.categorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.resolvedCategorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.seoCategorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.categoryTitlePlural`	`string`	`כן`
`$.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].slug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePlural`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.city`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.city.cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.city.citySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.city.countryCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.city.isoRegion`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.city.imageURL512`	`string`	`כן`
`$.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.isRestrictedMarket`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.city.showRevenueMetrics`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.city.recentActivity`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.city.recentActivity.windowHours`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.city.recentActivity.peopleCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.venues`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.venues[].rank`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].locationID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].ratingCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].externalRatingCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].locationAlias`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].tickerCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].stateShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].countryShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].addressString`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].categorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].categoryDescriptor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].categoryIcon`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].categoryJsonLDType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].imageColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].communitySnippet`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].communitySnippetURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].profileURL`	`string`	`כן`
`$.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].latitude`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].coordinates.anyOf[0].longitude`	`number`	`כן`
`$.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].ratingCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].postCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostText`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].reviewBoardName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].reviewBoardURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostTitle`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostAuthorAlias`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestPostCreatedDate`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestBoardName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].latestBoardURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].minimumRatingCount`	`integer`	`לא`
`$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[0].hasPublicRating`	`boolean`	`לא`
`$.oneOf[0].allOf[1].Payload.venues[].communityContext.anyOf[1]`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].showRevenueMetrics`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].isRestrictedByRegulation`	`boolean`	`כן`
`$.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[].visualInitial`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].visualPrimaryColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].visualSecondaryColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].visualTextColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].ugcImageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].ugcImageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].visualImageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].visualImageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].visualDisplayImageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].visualDisplayImageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].visualImageIsUGC`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].visualDisplayImageSource`	`string ["fallback","ugc","generated"]`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].streetNumber`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].street`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].zip`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].ratingSource`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].addedByUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].addedYearMonth`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].mentionURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.venues[].localRank`	`integer`	`כן`
`$.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[].rankChangeData`	`object`	`כן`
`$.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[].recentViews`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.pageSize`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.pageNumber`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.dateRange`	`string ["7d","30d","90d","180d","365d"]`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.categorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.resolvedCategorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.seoCategorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.categoryTitlePlural`	`string`	`כן`
`$.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].slug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePlural`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.continent`	`string ["NA","EU","AS","MEA","SA","OC"]`	`כן`
`$.oneOf[0].allOf[1].Payload.countries`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.countries[].countryCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].countryName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].citySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].stateShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].isoRegion`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].countryCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].countryName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].continentShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].detailURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].tradingActivity30Day`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].numberTransactions`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].venueCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].rank`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].isHot`	`boolean`	`כן`
`$.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[].coordinates`	`object`	`כן`
`$.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[].distanceMeters`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.countries[].cities[].distanceMiles`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.totalCities`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.dateRange`	`string ["7d","30d","90d","180d","365d"]`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias`	`string`	`כן`
`$.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.KeyValueFieldList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]`	`string`	`לא`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.categorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.resolvedCategorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.seoCategorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.categoryTitlePlural`	`string`	`כן`
`$.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].slug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePlural`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.mode`	`string ["cities","locations"]`	`כן`
`$.oneOf[0].allOf[1].Payload.scope`	`string ["overview","city"]`	`כן`
`$.oneOf[0].allOf[1].Payload.citySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.cities[].citySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].stateShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].isoRegion`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].countryCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].countryName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].continentShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].detailURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].tradingActivity30Day`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].numberTransactions`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].venueCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].rank`	`integer`	`כן`
`$.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[].coordinates`	`object`	`כן`
`$.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[].distanceMeters`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.cities[].distanceMiles`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.cities[].regionLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.locations[].rank`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].locationID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].ratingCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].externalRatingCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].locationAlias`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].tickerCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].stateShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].countryShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].closeByCitySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].addressString`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].categorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].categoryDescriptor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].categoryIcon`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].categoryJsonLDType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].imageColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].communitySnippet`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].communitySnippetURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].profileURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].cityDetailURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].coordinates`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].coordinates.latitude`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].coordinates.longitude`	`number`	`כן`
`$.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[].communityContext`	`object`	`כן`
`$.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.ratingCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].communityContext.postCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].communityContext.latestPostText`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].communityContext.latestPostURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].communityContext.reviewBoardName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].communityContext.reviewBoardURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].showRevenueMetrics`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].isRestrictedByRegulation`	`boolean`	`כן`
`$.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[].visualInitial`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].visualPrimaryColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].visualSecondaryColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].visualTextColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].ugcImageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].ugcImageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].visualImageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].visualImageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].visualDisplayImageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].visualDisplayImageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].visualImageIsUGC`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.locations[].visualDisplayImageSource`	`string ["fallback","ugc","generated"]`	`כן`
`$.oneOf[0].allOf[1].Payload.viewport`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.viewport.west`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.viewport.south`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.viewport.east`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.viewport.north`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.viewport.zoom`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.totalResults`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.dateRange`	`string ["7d","30d","90d","180d","365d"]`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias`	`string`	`כן`
`$.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.KeyValueFieldList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]`	`string`	`לא`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias`	`string`	`כן`
`$.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.KeyValueFieldList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]`	`string`	`לא`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias`	`string`	`כן`
`$.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.KeyValueFieldList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]`	`string`	`לא`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.items`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.items[]`		`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].id`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].subtitle`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].typeLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].iconText`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].lastViewedAt`	`string`	`כן`
`$.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].lastViewID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].type`	`= "city"`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.citySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.stateShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.isoRegion`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.countryCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.countryName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.continentShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.detailURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.tradingActivity30Day`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.numberTransactions`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.venueCount`	`integer`	`כן`
`$.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.coordinates`	`object`	`כן`
`$.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.distanceMeters`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[0].city.distanceMiles`	`number`	`לא`
`$.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].id`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].subtitle`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].typeLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].iconText`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].lastViewedAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].url`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].lastViewID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualInitial`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualPrimaryColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualSecondaryColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualTextColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].ugcImageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].ugcImageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualImageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualImageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualDisplayImageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualDisplayImageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualImageIsUGC`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].visualDisplayImageSource`	`string ["fallback","ugc","generated"]`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].type`	`= "location"`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].tickerCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.locationID`	`DatabaseInteger`	`כן`	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.name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.alias`	`string`	`כן`
`$.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.cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.stateShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].location.countryCode`	`string`	`כן`
`$.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.lastViewID`	`DatabaseInteger`	`כן`	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.lastViewedAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[1].isRestrictedByRegulation`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].id`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].subtitle`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].typeLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].iconText`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].lastViewedAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].url`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].lastViewID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualInitial`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualPrimaryColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualSecondaryColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualTextColor`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].ugcImageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].ugcImageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualImageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualImageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualDisplayImageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualDisplayImageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualImageIsUGC`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].visualDisplayImageSource`	`string ["fallback","ugc","generated"]`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].type`	`= "listing"`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].discussionPostID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].discussionPostUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].discussionCommentCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].tickerCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.appointmentID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.locationID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.discussionPostID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.listingUUID`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.locationName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.locationAlias`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.locationTicker`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.inventoryTypeName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.date`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.dateLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.time`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.citySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].listing.discussionPostUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[2].isRestrictedByRegulation`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].id`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].subtitle`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].typeLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].iconText`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].lastViewedAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].url`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].lastViewID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].type`	`= "board"`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].pills`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].pills[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].pills[].label`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.boardID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.boardType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.urlAlias`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.url`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.citySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.stateShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.countryCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageRole`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.lastViewedAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.isRestricted`	`integer [0,1]`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.viewerCanRead`	`integer [0,1]`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.viewerCanWrite`	`integer [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].positionXPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageFrame.anyOf[0].positionYPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageFrame.anyOf[0].zoomPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.imageFrame.anyOf[1]`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].board.lastViewID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].isRestricted`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].viewerCanRead`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[3].viewerCanWrite`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].id`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].subtitle`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].typeLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].iconText`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].lastViewedAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].url`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].lastViewID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].type`	`= "profile"`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.userID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.alias`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.avatarEmoji`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileURL`	`string`	`כן`
`$.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].id`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].thumbUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].mediaUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].mediaType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].width`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].height`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].isImage`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].isEmbedded`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].frame`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].frame.positionXPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].frame.positionYPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].frame.zoomPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[4].profile.profileImage.anyOf[0].backgroundUrl`	`string`	`לא`
`$.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].id`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].subtitle`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].typeLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].iconText`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].lastViewedAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].url`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].lastViewID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].type`	`= "plans"`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.appointmentID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.locationID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.locationName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.date`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.cityCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCities`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCities[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCities[].label`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCities[].count`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCities[].cityLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCities[].cityCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].plans.upcomingCities[].cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pills`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pills[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pills[].label`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pills[].count`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pills[].cityLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pills[].cityCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[5].pills[].cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].id`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].subtitle`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].typeLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].iconText`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].lastViewedAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].url`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].lastViewID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].type`	`= "requests"`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.count`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.primaryBidID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.primaryPostID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.locationID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.locationName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.dateLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].requests.cityLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].pills`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].pills[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].pills[].label`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].pills[].count`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[6].pills[].cityLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].id`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].subtitle`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].typeLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].iconText`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].lastViewedAt`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].url`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].lastViewID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].type`	`= "plans_requests"`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.appointmentID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.locationID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.locationName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.date`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.cityCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCities`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCities[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCities[].label`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCities[].count`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCities[].cityLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCities[].cityCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].plans.upcomingCities[].cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.count`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.primaryBidID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.primaryPostID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.locationID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.locationName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.dateLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].requests.cityLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills`	`array`	`כן`
`$.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].label`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[0].count`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[0].cityLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[0].cityCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[0].cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[1]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[1].label`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[1].count`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.items[].oneOf[7].pills[].anyOf[1].cityLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.totalResults`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.source`	`string ["history","trending_nearby","trending_world","empty"]`	`כן`
`$.oneOf[0].allOf[1].Payload.closestCity`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.closestCity.name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.closestCity.slug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.closestCity.countryCode`	`string`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.yearOverYearAverageMarketPriceChange`	`number`	`כן`
`$.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].....numberHistoricalTransactions`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....currentNumberBids`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....currentHighBid`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....currentLowBid`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....currentBidVolume`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....currentNumberListings`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....currentListingHighPrice`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....currentListingLowPrice`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....currentListingAveragePrice`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....averagePrice`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....minimumPrice`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....maximumPrice`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....totalDemand`	`number`	`כן`
`$.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].CreatedDate`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....specialEventInformation.anyOf[0].LastUpdateDate`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....specialEventInformation.anyOf[0].Name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....specialEventInformation.anyOf[0].Description`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....specialEventInformation.anyOf[0].URL`	`string`	`כן`
`$.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].ThisPeriodTimeFrame`	`object`	`כן`
`$.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].LastPeriodTimeFrame`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....specialEventInformation.anyOf[0].LastPeriodTimeFrame.StartTime`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....specialEventInformation.anyOf[0].LastPeriodTimeFrame.EndTime`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....specialEventInformation.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....sourceDataLocationAliasList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....sourceDataLocationAliasList[]`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList.anyOf[0].....lastYearsCorrespondingDayList`	`array`	`כן`
`$.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.KeyValueFieldList`	`array`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation.TotalNumberLocations`	`DatabaseInteger`	`כן`	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.KeyValueList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].locationAlias`	`string`	`כן`
`$.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.KeyValueFieldList`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]`	`string`	`לא`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "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_trending_near

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

פרמטרים

שם	סוג	חובה	ברירת מחדל	תיאור
`lat`	`float`	`כן`	`—`	Latitude in decimal degrees.
`long`	`float`	`כן`	`—`	Longitude in decimal degrees.
`pageSize`	`int`	`לא`	`4`	Number of cities to return (1-20).
`categorySlug`	`string`	`לא`	`""`	Optional category filter.
`dateRange`	`string`	`לא`	`"90d"`	Activity window.

דוגמת בקשה (cURL)

curl --get \
  'https://he.appointmenttrader.com/v1/marketdata/get_trending_near' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'lat={{lat}}' \
  --data-urlencode 'long={{long}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'categorySlug={{categorySlug}}' \
  --data-urlencode 'dateRange={{dateRange}}'

ערך מוחזר

JSON

See the shared response schema and synthetic example.

שדות התגובה

שדה	סוג	חובה
`$`	`marketdata_get_trending_near_Response`	`כן`
`$.oneOf[0]`		`כן`
`$.oneOf[0].allOf[0]`	`object`	`כן`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.categorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.resolvedCategorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.seoCategorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.categoryTitlePlural`	`string`	`כן`
`$.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].slug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePlural`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.cities`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.cities[].citySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].stateShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].isoRegion`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].countryCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].countryName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].continentShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].detailURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].tradingActivity30Day`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].numberTransactions`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].venueCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].rank`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].isHot`	`boolean`	`כן`
`$.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[].coordinates`	`object`	`כן`
`$.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[].distanceMeters`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.cities[].distanceMiles`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.closestCity`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.closestCity.name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.closestCity.slug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.closestCity.countryCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.dateRange`	`string ["7d","30d","90d","180d","365d"]`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/marketdata/get_trending_near",
    "RequestUserAlias": "example-user",
    "Payload": {
        "categorySlug": "synthetic-example",
        "resolvedCategorySlug": "synthetic-example",
        "seoCategorySlug": "synthetic-example",
        "categoryTitlePlural": "synthetic-example",
        "canonicalURL": "synthetic-example",
        "category": {
            "id": 0,
            "slug": "synthetic-example",
            "seoSlug": "synthetic-example",
            "name": "synthetic-example",
            "titlePlural": "synthetic-example",
            "jsonLDType": "synthetic-example"
        },
        "cities": [],
        "closestCity": {
            "name": "synthetic-example",
            "slug": "synthetic-example",
            "countryCode": "synthetic-example"
        },
        "dateRange": "7d"
    }
}

תיעוד נקודת קצה קריא למכונה

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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.scope`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.scope.scopeType`	`string ["global","continent","city"]`	`כן`
`$.oneOf[0].allOf[1].Payload.scope.scopeValue`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.scope.displayName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.scope.labelKey`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.scope.citySlug`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.scope.countryCode`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.scope.isoRegion`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.timeframe`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.timeframe.timeframe`	`string ["today","yesterday","month","ytd","year","alltime"]`	`כן`
`$.oneOf[0].allOf[1].Payload.timeframe.year`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.timeframe.startDate`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.timeframe.endDate`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.timeframe.labelKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.lists[].listKey`	`string ["highest_transaction","most_volume_purchased","most_volume_sold","largest_concierge_bonus","most_generous_users"]`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].labelKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].label`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].descriptionKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].description`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].countLabelKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].countLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].role`	`string ["buyer","seller"]`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].metric`	`string ["single_transaction","total_volume","single_bonus","total_bonus"]`	`כן`
`$.oneOf[0].allOf[1].Payload.pageSize`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.boards`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.boards[].listKey`	`string ["highest_transaction","most_volume_purchased","most_volume_sold","largest_concierge_bonus","most_generous_users"]`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].labelKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].label`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].descriptionKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].description`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].countLabelKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].countLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].role`	`string ["buyer","seller"]`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].metric`	`string ["single_transaction","total_volume","single_bonus","total_bonus"]`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].rank`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].userID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].transactionCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].alias`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].avatarURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].avatarEmoji`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImageURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImageURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].transactionCountLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].amountLabel`	`string`	`כן`
`$.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].id`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].thumbUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].mediaUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].mediaType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].width`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].height`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].isImage`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].isEmbedded`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frame`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frame.positionXPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frame.positionYPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].frame.zoomPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].profileImage.anyOf[0].backgroundUrl`	`string`	`לא`
`$.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].id`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].thumbUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].mediaUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].mediaType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].width`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].height`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].isImage`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].isEmbedded`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frame`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frame.positionXPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frame.positionYPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].frame.zoomPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[0].backgroundUrl`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.boards[].entries[].bannerImage.anyOf[1]`	`null`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.scope`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.scope.scopeType`	`string ["global","continent","city"]`	`כן`
`$.oneOf[0].allOf[1].Payload.scope.scopeValue`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.scope.displayName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.scope.labelKey`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.scope.citySlug`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.scope.countryCode`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.scope.isoRegion`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.timeframe`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.timeframe.timeframe`	`string ["today","yesterday","month","ytd","year","alltime"]`	`כן`
`$.oneOf[0].allOf[1].Payload.timeframe.year`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.timeframe.startDate`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.timeframe.endDate`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.timeframe.labelKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.lists[].listKey`	`string ["highest_transaction","most_volume_purchased","most_volume_sold","largest_concierge_bonus","most_generous_users"]`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].labelKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].label`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].descriptionKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].description`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].countLabelKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].countLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].role`	`string ["buyer","seller"]`	`כן`
`$.oneOf[0].allOf[1].Payload.lists[].metric`	`string ["single_transaction","total_volume","single_bonus","total_bonus"]`	`כן`
`$.oneOf[0].allOf[1].Payload.pageSize`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.board`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.board.listKey`	`string ["highest_transaction","most_volume_purchased","most_volume_sold","largest_concierge_bonus","most_generous_users"]`	`כן`
`$.oneOf[0].allOf[1].Payload.board.labelKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.label`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.descriptionKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.description`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.countLabelKey`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.countLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.role`	`string ["buyer","seller"]`	`כן`
`$.oneOf[0].allOf[1].Payload.board.metric`	`string ["single_transaction","total_volume","single_bonus","total_bonus"]`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.board.entries[].rank`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].userID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].transactionCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].alias`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].avatarURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].avatarEmoji`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImageURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImageURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].transactionCountLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].amountLabel`	`string`	`כן`
`$.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].id`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].thumbUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].mediaUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].mediaType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].width`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].height`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].isImage`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].isEmbedded`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].frame`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].frame.positionXPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].frame.positionYPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].frame.zoomPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].profileImage.anyOf[0].backgroundUrl`	`string`	`לא`
`$.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].id`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].thumbUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].mediaUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].mediaType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].width`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].height`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].isImage`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].isEmbedded`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].frame`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].frame.positionXPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].frame.positionYPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].frame.zoomPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[0].backgroundUrl`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.board.entries[].bannerImage.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.entries`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.entries[].rank`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].userID`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].transactionCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].alias`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].avatarURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].avatarEmoji`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImageURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImageURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].transactionCountLabel`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].amountLabel`	`string`	`כן`
`$.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].id`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].thumbUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].mediaUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].mediaType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].width`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].height`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].isImage`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].isEmbedded`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].frame`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].frame.positionXPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].frame.positionYPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].frame.zoomPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].profileImage.anyOf[0].backgroundUrl`	`string`	`לא`
`$.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].id`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].thumbUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].mediaUrl`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].mediaType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].width`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].height`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].title`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].isImage`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].isEmbedded`	`boolean`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].frame`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].frame.positionXPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].frame.positionYPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].frame.zoomPercent`	`number`	`כן`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[0].backgroundUrl`	`string`	`לא`
`$.oneOf[0].allOf[1].Payload.entries[].bannerImage.anyOf[1]`	`null`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "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://he.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].RequestUserAlias`	`string`	`כן`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`כן`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`כן`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`כן`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`
`$.oneOf[0].allOf[1]`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload`	`object`	`כן`
`$.oneOf[0].allOf[1].Payload.categorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.resolvedCategorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.seoCategorySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.categoryTitlePlural`	`string`	`כן`
`$.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].slug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].seoSlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].name`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].titlePlural`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[0].jsonLDType`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.category.anyOf[1]`	`null`	`כן`
`$.oneOf[0].allOf[1].Payload.cities`	`array`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[]`	`object`	`לא`
`$.oneOf[0].allOf[1].Payload.cities[].citySlug`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].cityName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].stateShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].isoRegion`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].countryCode`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].countryName`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].continentShort`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].imageURL256`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].imageURL512`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].detailURL`	`string`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].tradingActivity30Day`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].numberTransactions`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].venueCount`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].rank`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.cities[].isHot`	`boolean`	`כן`
`$.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[].coordinates`	`object`	`כן`
`$.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[].distanceMeters`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.cities[].distanceMiles`	`number`	`לא`
`$.oneOf[0].allOf[1].Payload.totalResults`	`integer`	`כן`
`$.oneOf[0].allOf[1].Payload.dateRange`	`string ["7d","30d","90d","180d","365d"]`	`כן`
`$.oneOf[1]`	`object`	`כן`
`$.oneOf[1].RequestUserAlias`	`string`	`כן`
`$.oneOf[1].RequestPath`	`string \| null`	`כן`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`כן`
`$.oneOf[1].ResponseCode`	`integer`	`כן`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`כן`
`$.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].RequestImpersonatedByUserAlias`	`string`	`לא`

דוגמת תגובה

{
    "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"
    }
}

תיעוד נקודת קצה קריא למכונה