Μετάβαση στο κύριο περιεχόμενο

Τεκμηρίωση

Ό,τι χρειάζεστε για την ενσωμάτωση

Ο οδηγός, η τεκμηρίωση αναφοράς και η προδιαγραφή παράγονται από ένα ενιαίο αρχείο OpenAPI, ώστε να συμφωνούν πάντα μεταξύ τους. Τα αναγνωριστικά είναι ίδια σε κάθε γλώσσα.

  • Οδηγός ενσωμάτωσης

    Απόκτηση κλειδιού, έλεγχος ταυτότητας, φίλτρα, σελιδοποίηση, όρια και σφάλματα, στη γλώσσα σας.

    Άνοιγμα του οδηγού

  • Προδιαγραφή OpenAPI

    Το αρχείο OpenAPI 3.1 από το οποίο παράγεται η τεκμηρίωση αναφοράς, για γεννήτριες κώδικα και εργαλεία API.

    Λήψη της προδιαγραφής

  • Οδηγός σε PDF

    Ο οδηγός ενσωμάτωσης σε ένα ενιαίο έγγραφο, για να τον διαβάσετε εκτός σύνδεσης ή να τον μοιραστείτε με την ομάδα σας.

    Λήψη του PDF

Η τεκμηρίωση είναι δημόσια. Χρειάζεστε κλειδί μόνο για να καλέσετε το API.

Γρήγορη εκκίνηση

Ελέγξτε το κλειδί σας και τη διεύθυνση που βλέπουμε
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"
Διαβάστε την πρώτη σελίδα αγγελιών για μια χώρα
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/properties?country=TH&listing_type=sale&property_type=condominium&limit=100"

Με μια ματιά

Βασική URL
https://api.housingmarketapi.com
Έλεγχος ταυτότητας
Το κλειδί στην κεφαλίδα x-api-key, σταλμένο από τη διεύθυνση διακομιστή που έχει καταχωριστεί για αυτό.

Endpoints

EndpointΕπίπεδοΠεριγραφή
GET /v1/pingStandardΕπιβεβαιώνει ότι το κλειδί σας λειτουργεί από τη διεύθυνση στην οποία είναι καταχωρισμένο και επιστρέφει αυτή τη διεύθυνση.
GET /v1/propertiesStandardΔημοσιευμένες αγγελίες για μια χώρα που καλύπτει το κλειδί σας, μία σελίδα κάθε φορά.
GET /v1/insights/*AdvancedΣυγκεντρωτικά δεδομένα αγοράς ανά τοποθεσία και περίοδο, για κλειδιά Advanced. Σύντομα διαθέσιμα: αυτά τα endpoints δεν είναι ακόμη ενεργά.

Κωδικοί σφαλμάτων

Κάθε σφάλμα φέρει μια κατάσταση HTTP και έναν από αυτούς τους κωδικούς. Βασίστε τη λογική σας στον κωδικό, όχι στο μήνυμα.

  • invalid_parameter
  • invalid_cursor
  • unauthenticated
  • ip_not_allowed
  • key_paused
  • country_not_entitled
  • upgrade_required
  • not_found
  • method_not_allowed
  • rate_limited
  • quota_exceeded
  • internal_error
  • not_configured
  • service_unavailable
Αποκτήστε το κλειδί API σαςΔείτε τις τιμές