Tarification

• PRIVATE_PROPERTY : applicable uniquement pour les biens provenant d'annonces publiés par des particuliers (marketing.dealer.type = PRIVATE).
• PROPERTY :  applicable pour les autres biens.

Endpoints

Endpoint : /properties : rechercher des biens par critères

• Requête

GET https://api.yanport.com/properties?size=5&dealerTypes=AGENCY&quarterIds=3704052656192512

• Réponse

{
  "total": 8936,
  "hits": [
    {
      "id": "d90600d0-b506-11e7-98bc-2bff2fe30e30",
      "source": "AD",
      "ads": [],
      "type": "APARTMENT"
    },
    {
      "id": "054b73f1-ad99-11e4-8be6-1100e6029c1e",
      "source": "AD",
      "ads": [],
      "type": "APARTMENT"
    },
    {
      "id": "b8d4e220-a2ad-11e6-807a-abf6d3bf8a25",
      "source": "AD",
      "ads": [],
      "type": "APARTMENT"
    },
    {
      "id": "718ea1b0-51ee-11e9-9abc-fd93b12bc2e2",
      "source": "AD",
      "ads": [],
      "type": "PREMISES"
    },
    {
      "id": "63861930-9f67-11e7-a91b-6717c31acb87",
      "source": "AD",
      "ads": [],
      "properties": [],
      "type": "APARTMENT"
    }
  ]
}

• Consommation : 5 SKU 

Le nombre de SKU est égal au nombre de biens renvoyés dans la réponse HTTP. L'exemple de requête utilisé ici renvoi uniquement des biens publiés par des professionnels et occasionnera donc une consommation de 5 SKU PROPERTY.

Dans le contexte d'une autre recherche, en admettant que la réponse contienne 3 biens provenant d'annonces de particuliers et 2 biens provenant d'annonces de professionnels, alors la consommation enregistrée serait de 3 SKU PRIVATE_PROPERTY et 2 SKU PROPERTY. 

Endpoint : /properties/{id} : récupérer un bien précis
 

• Requête

GET https://api.yanport.com/properties/d90600d0-b506-11e7-98bc-2bff2fe30e30

•  Réponse

{
  "id": "d90600d0-b506-11e7-98bc-2bff2fe30e30",
  "source": "AD",
  "ads": [],
  "type": "APARTMENT"
}

• Consommation: 1 SKU 

1 SKU pour chaque réponse HTTP sans erreur. Compte pour 1 SKU PRIVATE_PROPERTY si le bien demandé est issu d'une annonce de particulier, sinon 1 SKU PROPERTY.

Endpoint : /properties/ids : récupérer des biens précis
 

• Requête

GET https://api.yanport.com/properties/ids?ids=d90600d0-b506-11e7-98bc-2bff2fe30e30&ids=63861930-9f67-11e7-a91b-6717c31acb87 

•  Réponse

[
  {
    "id": "63861930-9f67-11e7-a91b-6717c31acb87",
    "source": "AD",
    "ads": [],
    "type": "APARTMENT"
  },
  {
    "id": "d90600d0-b506-11e7-98bc-2bff2fe30e30",
    "source": "AD",
    "ads": [],
    "type": "APARTMENT"
  }
]

• Consommation: 2 SKU 

Le nombre de SKU est égal au nombre de biens renvoyés dans la réponse HTTP.

Le type de SKU consommé dépendra de la source de chaque bien :

• PRIVATE_PROPERTY pour chaque bien publié par un particulier
• PROPERTY pour les autres

Endpoint : /properties/ads/urls : récupérer des biens avec l'URL

• Requête

GET https://api.yanport.com/properties/ads/urls?url=https://www.logic-immo.com/detail-vente-6641b8f6-e7e3-e44e-d0e0-d9965f991b98.htm

• Réponse

{
  "id": "9d064a60-d806-11ea-b28a-1b6a75606a9a",
  "source": "AD",
  "subType": "SHOP",
  "type": "PREMISES"
}

• Consommation: 1 SKU 

Le nombre de SKU est égal au nombre de biens renvoyés dans la réponse HTTP.

Le type de SKU consommé dépendra de la source de chaque bien :

• PRIVATE_PROPERTY pour un bien publié par un particulier
• PROPERTY pour les autres type d'annonce