मुख्य सामग्री पर जाएँ

दस्तावेज़

इंटीग्रेशन के लिए आपको जो कुछ भी चाहिए

गाइड, रेफ़रेंस और स्पेसिफ़िकेशन एक ही 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 हेडर में कुंजी, जो उसके लिए पंजीकृत सर्वर पते से भेजी जाती है।

एंडपॉइंट

एंडपॉइंटटियरविवरण
GET /v1/pingस्टैंडर्डपुष्टि करता है कि आपकी कुंजी उस पते से काम करती है जिसके लिए वह पंजीकृत है, और वही पता लौटाता है।
GET /v1/propertiesस्टैंडर्डआपकी कुंजी में शामिल किसी देश की प्रकाशित लिस्टिंग, एक बार में एक पेज।
GET /v1/insights/*एडवांस्डजगह और अवधि के अनुसार एकत्रित बाज़ार डेटा, एडवांस्ड कुंजियों के लिए। जल्द आ रहा है: ये एंडपॉइंट अभी लाइव नहीं हैं।

त्रुटि कोड

हर त्रुटि में एक 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 कुंजी पाएँकीमतें देखें