API - aplikacja dla Twojego serwisu internetowego

API serwisu hiposzukacz.pl umożliwia w łatwy i szybki sposób dostarczenie wiarygodnych i aktualnych danych o możliwości i koszcie kredytowania zakupu nieruchomości oraz daje bezpośredni i wygodny dostęp do narzędzia umożliwiającego Twoim użytkownikom dokonanie szczegółowej analizy dostępnych dla niego ofert banków.

Uwaga! Jeżeli chcesz skorzystać z gotowego rozwiązania, użyj w tym celu WTYCZKI portalu hiposzukacz.pl. Przejdź do dokumentacji...

Dostęp do API

API seriwsu hiposzukacz.pl dedykowana jest przede wszystkim do serwisów internetowych prezentujących oferty sprzedaży nieruchomości (m.in. biur nieruchomości, deweloperów, portali z ogłoszeniami ofert sprzedaży nieruchomości). W celu uzyskania bezpłatnego dostępu do API prosimy o nawiązanie kontaktu z nami.

Format zapytań do API

Zapytania do API generowane są przy pomocy wywołania następującego adresu:

https://www.hiposzukacz.pl/api/index/u/[username]/p/[password]/c/[collateral]/co/[collateralObject]/t/[loanTerm]/l/[ltv]/r/[returnFormat]

Czerwonym kolorem zaznaczone są parametry, które powinny przyjąć następujące wartości:

Parametry obowiązkowe:

• [username] - nazwa użytkownika (dostarczana przez nas po założeniu konta)
• [password] - hasło (dostarczana przez nas po założeniu konta)
• [collateral] - wartość nieruchomości (od 0 do 5.000.000, ułamek dziesiętny oznaczany kropoką)
• [collateralObject] - rodzaj nieruchomości - akceptowane wartości:
  • flat (mieszkanie)
  • flatPrimary (mieszkanie - pierwotny)
  • house (dom)
  • housePrimary (dom - pierwotny)
  • houseBuild (dom w budowie)
  • lodge (dom letniskowy całoroczny)
  • buildingParcel (działka budowlana)
  • recreationParcel (działka rekreacyjna)
  • agriculturalParcel (działka rolna)
  • dwelling (siedlisko)
  • commercialFloor (powierzchnia komercyjna)

Parametry nieobowiązkowe:

• [loanTerm] - okres kredytowania w latach (od 5 do 35, tylko liczby całkowite, standardowa wartość: 30)
• [ltv] - wysokość kredytu do wartości nieruchomosci w % (jak dużo pieniędzy na transakcje ma być pożyczone z banku) wyrażone w % (od 5 do 90, ułamek dziesiętny oznaczany kropoką, standardowa wartość: 90)
• [returnFormat] - format w jakim API ma zwrócić wynik zapytania
  • json (standardowa wartość)
  • dodatkowe formaty będą oferowane wraz ze zgłoszeniem zapotrzebowania na nie - jeżeli potrzebny jest format, którego jeszcze nie oferujemy, prosimy o kontakt z nami

Format odpowiedzi API

Odpowiedzią na zadane do API pytanie jest tablica z następującymi parami kluczy i wartości:

• min - najniższa możliwa rata
• max - najwyższa możliwa rata
• amountOffers - ilość wszystkich dostępnych ofert na rynku dla danej transakcji (dostępność kredytu na daną transakcję)
• url - link do strony hiposzukacz.pl z wypełnionymi wszystkimi znanymi parametrami
• errors - tablica z komunikatami błędów

Przykład użycia API w PHP

Zapytanie wielokrotne

Jeżeli na jednej stronie znajduje się kilka nieruchomości i dla każdej z nich powinny być wyliczone raty kredytu, istnieje możliwość dokonania zapytania wielokrotnego w taki sposób, aby jednym zapytaniem uzyskać dane dla wszystkich nieruchomości. W tym celu parametry pojedynczych zapytań należy połączyć przecinkami w jeden parametr wg. następującego schematu:

https://www.hiposzukacz.pl/api/index/u/username/p/password/co/collateralObject1,collateralObject2/c/collateral1,collateral2/t/loanTerm1,loanTerm2/l/ltv1,ltv2/r/returnFormat

W odpowiedzi API dostarczy tablicę z danymi dla każdej nieruchomości z zapytania.