Nestoria API - XML Schema

xml schema

For our XML data which we return from the API we have an XML schema which describes the layout of the data. The XML schema may change with the release of a new API version; the current version of the API (and therefore the XML schema) is 1.21.

<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="opt"> <xs:complexType> <xs:sequence> <xs:element name="request" maxOccurs="1" minOccurs="1"> <xs:complexType> <xs:attribute name="action" type="xs:string" use="optional"/> <xs:attribute name="country" type="xs:string" use="optional"/> <xs:attribute name="encoding" type="xs:string" use="optional"/> <xs:attribute name="guid" type="xs:string" use="optional"/> <xs:attribute name="language" type="xs:string" use="optional"/> <xs:attribute name="location" type="xs:string" use="optional"/> <xs:attribute name="num_res" type="xs:integer" use="optional"/> <xs:attribute name="offset" type="xs:integer" use="optional"/> <xs:attribute name="output" type="xs:string" use="optional"/> <xs:attribute name="page" type="xs:integer" use="optional"/> <xs:attribute name="product_type" type="xs:string" use="optional"/> <xs:attribute name="property_type" type="xs:string" use="optional"/> <xs:attribute name="sort" type="xs:string" use="optional"/> </xs:complexType> </xs:element> <xs:element name="response" minOccurs="1" maxOccurs="1"> <xs:complexType> <xs:complexContent> <xs:restriction base="xs:anyType"> <xs:choice> <xs:sequence> <xs:element name="attribution" minOccurs="0" maxOccurs="1"> <xs:complexType> <xs:attribute name="img_height" type="xs:integer" use="optional"/> <xs:attribute name="img_url" type="xs:string" use="optional"/> <xs:attribute name="img_width" type="xs:integer" use="optional"/> <xs:attribute name="link_to_img" type="xs:string" use="optional"/> </xs:complexType> </xs:element> <xs:choice> <xs:sequence> <xs:element name="listings" minOccurs="0" maxOccurs="unbounded"> <xs:complexType> <xs:attribute name="bathroom_number" type="xs:string" use="required"/> <xs:attribute name="bedroom_number" type="xs:string" use="required"/> <xs:attribute name="car_spaces" type="xs:integer" use="optional"/> <xs:attribute name="commission" type="xs:decimal" use="optional"/> <xs:attribute name="construction_year" type="xs:integer" use="optional"/> <xs:attribute name="datasource_name" type="xs:string" use="required"/> <xs:attribute name="guid" type="xs:string" use="required"/> <xs:attribute name="img_height" type="xs:integer" use="required"/> <xs:attribute name="img_url" type="xs:string" use="required"/> <xs:attribute name="img_width" type="xs:integer" use="required"/> <xs:attribute name="keywords" type="xs:string" use="required"/> <xs:attribute name="land_size" type="xs:string" use="optional"/> <xs:attribute name="land_size_unit" type="xs:string" use="optional"/> <xs:attribute name="latitude" type="xs:decimal" use="optional"/> <xs:attribute name="lister_name" type="xs:string" use="required"/> <xs:attribute name="lister_url" type="xs:string" use="required"/> <xs:attribute name="listing_type" type="xs:string" use="required"/> <xs:attribute name="location_accuracy" type="xs:integer" use="optional"/> <xs:attribute name="longitude" type="xs:decimal" use="optional"/> <xs:attribute name="price" type="xs:integer" use="required"/> <xs:attribute name="price_currency" type="xs:string" use="required"/> <xs:attribute name="price_formatted" type="xs:string" use="required"/> <xs:attribute name="price_coldrent" type="xs:string" use="optional"/> <xs:attribute name="price_high" type="xs:integer" use="required"/> <xs:attribute name="price_low" type="xs:integer" use="required"/> <xs:attribute name="price_type" type="xs:string" use="required"/> <xs:attribute name="property_type" type="xs:string" use="required"/> <xs:attribute name="room_number" type="xs:integer" use="optional"/> <xs:attribute name="size" type="xs:string" use="optional"/> <xs:attribute name="size_unit" type="xs:string" use="optional"/> <xs:attribute name="summary" type="xs:string" use="required"/> <xs:attribute name="thumb_height" type="xs:integer" use="required"/> <xs:attribute name="thumb_url" type="xs:string" use="required"/> <xs:attribute name="thumb_width" type="xs:integer" use="required"/> <xs:attribute name="title" type="xs:string" use="required"/> <xs:attribute name="updated_in_days" type="xs:decimal" use="required"/> <xs:attribute name="updated_in_days_formatted" type="xs:string" use="required"/> </xs:complexType> </xs:element> <xs:element name="locations" minOccurs="0" maxOccurs="unbounded"> <xs:complexType> <xs:attribute name="center_lat" type="xs:decimal" use="required"/> <xs:attribute name="center_long" type="xs:decimal" use="required"/> <xs:attribute name="long_title" type="xs:string" use="required"/> <xs:attribute name="place_name" type="xs:string" use="required"/> <xs:attribute name="title" type="xs:string" use="required"/> </xs:complexType> </xs:element> </xs:sequence> <xs:element name="metadata" minOccurs="0" maxOccurs="unbounded"> <xs:complexType> <xs:complexContent> <xs:restriction base="xs:anyType"> <xs:sequence> <xs:element name="data" minOccurs="1" maxOccurs="unbounded"> <xs:complexType> <xs:attribute name="name" type="xs:string" use="required"/> <xs:attribute name="avg_price" type="xs:string" use="required"/> <xs:attribute name="datapoints" type="xs:integer" use="required"/> <xs:attribute name="month" type="xs:string" use="required"/> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="currency" type="xs:string" use="required"/> <xs:attribute name="listing_type" type="xs:string" use="required"/> <xs:attribute name="metadata_name" type="xs:string" use="required"/> <xs:attribute name="num_beds" type="xs:string" use="required"/> <xs:attribute name="num_rooms" type="xs:string" use="required"/> <xs:attribute name="price_type" type="xs:string" use="required"/> <xs:attribute name="property_type" type="xs:string" use="required"/> <xs:attribute name="url" type="xs:string" use="required"/> </xs:restriction> </xs:complexContent> </xs:complexType> </xs:element> </xs:choice> </xs:sequence> <xs:element name="labels" minOccurs="0" maxOccurs="unbounded"> <xs:complexType mixed="true"> <xs:attribute name="english" type="xs:string" use="required"/> <xs:attribute name="keyword" type="xs:string" use="required"/> </xs:complexType> </xs:element> </xs:choice> <xs:attribute name="action" type="xs:string" use="optional"/> <xs:attribute name="application_response_code" type="xs:integer" use="optional"/> <xs:attribute name="application_response_text" type="xs:string" use="optional"/> <xs:attribute name="country" type="xs:string" use="optional"/> <xs:attribute name="created_http" type="xs:string" use="required"/> <xs:attribute name="created_unix" type="xs:integer" use="required"/> <xs:attribute name="encoding" type="xs:string" use="optional"/> <xs:attribute name="keywords" type="xs:string" use="optional"/> <xs:attribute name="link_to_url" type="xs:string" use="optional"/> <xs:attribute name="most_recent_month" type="xs:string" use="optional"/> <xs:attribute name="most_recent_quarter" type="xs:string" use="optional"/> <xs:attribute name="page" type="xs:integer" use="optional"/> <xs:attribute name="sort" type="xs:string" use="optional"/> <xs:attribute name="status_code" type="xs:integer" use="required"/> <xs:attribute name="status_text" type="xs:string" use="required"/> <xs:attribute name="thanks" type="xs:string" use="optional"/> <xs:attribute name="total_pages" type="xs:integer" use="optional"/> <xs:attribute name="total_results" type="xs:integer" use="optional"/> </xs:restriction> </xs:complexContent> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>

This is also available as a XSD file here.

Nestoria only displays listings provided under agreement with our partners.

Copyright © 2013 Lokku Ltd.  and Powered by OpenCage Data.