Housing Market API इंटीग्रेशन गाइड
संदर्भ तालिकाएँ, एंडपॉइंट विवरण, त्रुटि कोड और उदाहरण API विनिर्देश से जनरेट किए जाते हैं और हर भाषा में अंग्रेज़ी में ही रहते हैं। नाम, पैरामीटर और कोड हर जगह एक जैसे हैं।
पेजिनेशन
हर सूची एंडपॉइंट कर्सर का उपयोग करता है। रिस्पॉन्स में data, next_cursor और has_more होते हैं।
एक रिस्पॉन्स का next_cursor अगले अनुरोध में cursor के रूप में भेजें, और जब has_more का मान false हो जाए तो रुक जाएँ।
कोई कुल संख्या नहीं है और कोई पेज नंबर नहीं हैं। ऐसा जानबूझकर किया गया है: API लिस्टिंग खोजने के लिए बनाया गया है, डेटाबेस की प्रतिलिपि बनाने के लिए नहीं।
limit पैरामीटर पेज का आकार तय करता है। इसका डिफ़ॉल्ट मान 50 है और यह 100 से अधिक नहीं हो सकता।
कर्सर अपारदर्शी होता है। इसे पार्स न करें, खुद न बनाएँ और बाद के लिए न रखें। यह आपकी कुंजी और उसे बनाने वाले अनुरोध के फ़िल्टर से जुड़ा होता है, और अमान्य कर्सर को invalid_cursor के साथ अस्वीकार कर दिया जाता है।
पेजों के एक ही क्रमिक दौर के भीतर परिणाम एक स्थिर क्रम में आते हैं, लेकिन उस क्रम का कोई अर्थ नहीं है। उस पर निर्भर न रहें।
Response shape
| Field | Type | Description |
|---|---|---|
data required | array | The items on this page. |
next_cursor required | string | null | Pass as cursor to get the next page. Null on the last page. |
has_more required | boolean | False when there is no further page. |
Request parameters
| Parameter | Type | Required | Values | Description |
|---|---|---|---|---|
limit | integer | no | default 50min 1max 100 | Page size. At most the maximum shown; larger values are refused with invalid_parameter. |
cursor | string | no | The next_cursor of the previous page. Opaque: do not parse it, store
it, or build one. It is bound to your key and to the filters of the
request that produced it, and a cursor used with different filters is
refused with invalid_cursor. |