Tarification

• Coût unitaire : 0.01 € (par SKU)

Endpoints

Endpoint : /similar-properties/query

• Requête

GET https://api.yanport.com/similar-properties/query?minDocCount=6&cityIds=50605099&marketingType=SALE&propertyTypes=HOUSE&price=696800&surface=145&roomCount=6

•  Réponse

{
  "searchQueryParam": {
    "from": 0,
    "size": 20,
    "includes": [],
    "excludes": []
  },
  "source": "AD",
  "ids": [],
  "aggregatePropertyIds": [],
  "externalIds": [],
  "programIds": [],
  "organizationIds": [],
  "marketingTypes": [
    "SALE"
  ],
  "crawlSources": [],
  "dealerTypes": [],
  "dealerNames": [],
  "dealerIds": [],
  "excludedDealerIds": [],
  "bloctelStatus": [],
  "propertyTypes": [
    "HOUSE"
  ],
  "roomCounts": [
    6
  ],
  "departments": [],
  "zipCodes": [],
  "cityIds": [
    50605099
  ],
  "agglomerationIds": [],
  "irisIds": [],
  "quarterIds": [],
  "parcelIds": [],
  "saleStatus": [],
  "surfaceMin": 131.0,
  "surfaceMax": 160.0,
  "priceM2Min": 4324.97,
  "priceM2Max": 5286.07,
  "missingFields": [],
  "existingFields": [],
  "excludedIds": [],
  "geoSearchQuery": {
    "radius": "10m",
    "approximate": false,
    "valid": false
  }
}

• Consommation: 1 SKU (soit 0,01 €)

Le nombre de SKU est égale au nombre de requête HTTP. 

Endpoint : /similar-properties/percentiles

• Requête

GET  https://api.yanport.com/similar-properties/percentiles?marketingType=SALE&propertyType=HOUSE&price=696800&minDocCount=10&surface=145&cityIds=50605099&roomCount=6&percentiles=50&percentiles=25&percentiles=75&field=DURATION_DAYS

•  Réponse

{
  "count": 53,
  "values": {
    "75.0": 179.0,
    "25.0": 29.0,
    "50.0": 90.0
  }
}

• Consommation: 4 SKU (soit 0.04 €)

Le nombre de SKU est égale au nombre de percentiles demandés (q25, q50, q75) plus le total des biens (propriété count).