GET v1/listings?key={key}&accountNames={accountNames}&loginNames={loginNames}&propertyType={propertyType}&htmlEncoded={htmlEncoded}&page={page}

Request Information

URI Parameters

Name	Type	Additional information
key	string	None.
accountNames	string	None.
loginNames	string	None.
propertyType	PropertyType	None.
htmlEncoded	boolean	None.
page	integer	None.

Body Parameters

None.

Response Information

Resource Description

ListingsData

Name	Type	Additional information
options	ListingsOptions	None.
recordCount	integer	None.
listings	Collection of Listing	None.

Response Formats

application/json, text/json

Sample:

{
  "options": {
    "key": "sample string 1",
    "accountNames": "sample string 2",
    "loginNames": "sample string 3",
    "propertyType": 0,
    "htmlEncoded": true,
    "page": 5
  },
  "recordCount": 1,
  "listings": [
    {
      "id": 1,
      "sourceUniqueID": "sample string 2",
      "agent": "sample string 3",
      "streetNo": "sample string 4",
      "street": "sample string 5",
      "suburb": "sample string 6",
      "state": "sample string 7",
      "country": "sample string 8",
      "postcode": "sample string 9",
      "latitude": 10.1,
      "longitude": 11.1,
      "price": 12.1,
      "bond": 1.1,
      "displayPrice": "sample string 13",
      "categoryGroupID": 14,
      "bedrooms": 15,
      "bathrooms": 16,
      "garages": 17,
      "carports": 18,
      "availableDate": "sample string 19",
      "bookLink": "sample string 20",
      "iFrameBookLink": "sample string 21",
      "websiteLink": "sample string 22",
      "headline": "sample string 23",
      "description": "sample string 24",
      "mainImageUrl": "sample string 25",
      "images": [
        "sample string 1",
        "sample string 2"
      ],
      "imagesWithType": [
        {
          "url": "sample string 1",
          "isFloorPlan": true,
          "isMainImage": true,
          "imageType": "sample string 4"
        },
        {
          "url": "sample string 1",
          "isFloorPlan": true,
          "isMainImage": true,
          "imageType": "sample string 4"
        }
      ],
      "videoLink": "sample string 26",
      "listingAgent": {
        "number": 1,
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "mobile": "sample string 4",
        "phone": "sample string 5",
        "email": "sample string 6"
      },
      "listingAgents": [
        {
          "number": 1,
          "firstName": "sample string 2",
          "lastName": "sample string 3",
          "mobile": "sample string 4",
          "phone": "sample string 5",
          "email": "sample string 6"
        },
        {
          "number": 1,
          "firstName": "sample string 2",
          "lastName": "sample string 3",
          "mobile": "sample string 4",
          "phone": "sample string 5",
          "email": "sample string 6"
        }
      ]
    },
    {
      "id": 1,
      "sourceUniqueID": "sample string 2",
      "agent": "sample string 3",
      "streetNo": "sample string 4",
      "street": "sample string 5",
      "suburb": "sample string 6",
      "state": "sample string 7",
      "country": "sample string 8",
      "postcode": "sample string 9",
      "latitude": 10.1,
      "longitude": 11.1,
      "price": 12.1,
      "bond": 1.1,
      "displayPrice": "sample string 13",
      "categoryGroupID": 14,
      "bedrooms": 15,
      "bathrooms": 16,
      "garages": 17,
      "carports": 18,
      "availableDate": "sample string 19",
      "bookLink": "sample string 20",
      "iFrameBookLink": "sample string 21",
      "websiteLink": "sample string 22",
      "headline": "sample string 23",
      "description": "sample string 24",
      "mainImageUrl": "sample string 25",
      "images": [
        "sample string 1",
        "sample string 2"
      ],
      "imagesWithType": [
        {
          "url": "sample string 1",
          "isFloorPlan": true,
          "isMainImage": true,
          "imageType": "sample string 4"
        },
        {
          "url": "sample string 1",
          "isFloorPlan": true,
          "isMainImage": true,
          "imageType": "sample string 4"
        }
      ],
      "videoLink": "sample string 26",
      "listingAgent": {
        "number": 1,
        "firstName": "sample string 2",
        "lastName": "sample string 3",
        "mobile": "sample string 4",
        "phone": "sample string 5",
        "email": "sample string 6"
      },
      "listingAgents": [
        {
          "number": 1,
          "firstName": "sample string 2",
          "lastName": "sample string 3",
          "mobile": "sample string 4",
          "phone": "sample string 5",
          "email": "sample string 6"
        },
        {
          "number": 1,
          "firstName": "sample string 2",
          "lastName": "sample string 3",
          "mobile": "sample string 4",
          "phone": "sample string 5",
          "email": "sample string 6"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ListingsData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models">
  <listings>
    <Listing>
      <agent>sample string 3</agent>
      <availableDate>sample string 19</availableDate>
      <bathrooms>16</bathrooms>
      <bedrooms>15</bedrooms>
      <bond>1.1</bond>
      <bookLink>sample string 20</bookLink>
      <carports>18</carports>
      <categoryGroupID>14</categoryGroupID>
      <country>sample string 8</country>
      <description>sample string 24</description>
      <displayPrice>sample string 13</displayPrice>
      <garages>17</garages>
      <headline>sample string 23</headline>
      <iFrameBookLink>sample string 21</iFrameBookLink>
      <id>1</id>
      <images xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </images>
      <imagesWithType>
        <ListingImage>
          <imageType>sample string 4</imageType>
          <isFloorPlan>true</isFloorPlan>
          <isMainImage>true</isMainImage>
          <url>sample string 1</url>
        </ListingImage>
        <ListingImage>
          <imageType>sample string 4</imageType>
          <isFloorPlan>true</isFloorPlan>
          <isMainImage>true</isMainImage>
          <url>sample string 1</url>
        </ListingImage>
      </imagesWithType>
      <latitude>10.1</latitude>
      <listingAgent>
        <email>sample string 6</email>
        <firstName>sample string 2</firstName>
        <lastName>sample string 3</lastName>
        <mobile>sample string 4</mobile>
        <number>1</number>
        <phone>sample string 5</phone>
      </listingAgent>
      <listingAgents>
        <StaffMember>
          <email>sample string 6</email>
          <firstName>sample string 2</firstName>
          <lastName>sample string 3</lastName>
          <mobile>sample string 4</mobile>
          <number>1</number>
          <phone>sample string 5</phone>
        </StaffMember>
        <StaffMember>
          <email>sample string 6</email>
          <firstName>sample string 2</firstName>
          <lastName>sample string 3</lastName>
          <mobile>sample string 4</mobile>
          <number>1</number>
          <phone>sample string 5</phone>
        </StaffMember>
      </listingAgents>
      <longitude>11.1</longitude>
      <mainImageUrl>sample string 25</mainImageUrl>
      <postcode>sample string 9</postcode>
      <price>12.1</price>
      <sourceUniqueID>sample string 2</sourceUniqueID>
      <state>sample string 7</state>
      <street>sample string 5</street>
      <streetNo>sample string 4</streetNo>
      <suburb>sample string 6</suburb>
      <videoLink>sample string 26</videoLink>
      <websiteLink>sample string 22</websiteLink>
    </Listing>
    <Listing>
      <agent>sample string 3</agent>
      <availableDate>sample string 19</availableDate>
      <bathrooms>16</bathrooms>
      <bedrooms>15</bedrooms>
      <bond>1.1</bond>
      <bookLink>sample string 20</bookLink>
      <carports>18</carports>
      <categoryGroupID>14</categoryGroupID>
      <country>sample string 8</country>
      <description>sample string 24</description>
      <displayPrice>sample string 13</displayPrice>
      <garages>17</garages>
      <headline>sample string 23</headline>
      <iFrameBookLink>sample string 21</iFrameBookLink>
      <id>1</id>
      <images xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </images>
      <imagesWithType>
        <ListingImage>
          <imageType>sample string 4</imageType>
          <isFloorPlan>true</isFloorPlan>
          <isMainImage>true</isMainImage>
          <url>sample string 1</url>
        </ListingImage>
        <ListingImage>
          <imageType>sample string 4</imageType>
          <isFloorPlan>true</isFloorPlan>
          <isMainImage>true</isMainImage>
          <url>sample string 1</url>
        </ListingImage>
      </imagesWithType>
      <latitude>10.1</latitude>
      <listingAgent>
        <email>sample string 6</email>
        <firstName>sample string 2</firstName>
        <lastName>sample string 3</lastName>
        <mobile>sample string 4</mobile>
        <number>1</number>
        <phone>sample string 5</phone>
      </listingAgent>
      <listingAgents>
        <StaffMember>
          <email>sample string 6</email>
          <firstName>sample string 2</firstName>
          <lastName>sample string 3</lastName>
          <mobile>sample string 4</mobile>
          <number>1</number>
          <phone>sample string 5</phone>
        </StaffMember>
        <StaffMember>
          <email>sample string 6</email>
          <firstName>sample string 2</firstName>
          <lastName>sample string 3</lastName>
          <mobile>sample string 4</mobile>
          <number>1</number>
          <phone>sample string 5</phone>
        </StaffMember>
      </listingAgents>
      <longitude>11.1</longitude>
      <mainImageUrl>sample string 25</mainImageUrl>
      <postcode>sample string 9</postcode>
      <price>12.1</price>
      <sourceUniqueID>sample string 2</sourceUniqueID>
      <state>sample string 7</state>
      <street>sample string 5</street>
      <streetNo>sample string 4</streetNo>
      <suburb>sample string 6</suburb>
      <videoLink>sample string 26</videoLink>
      <websiteLink>sample string 22</websiteLink>
    </Listing>
  </listings>
  <options>
    <accountNames>sample string 2</accountNames>
    <htmlEncoded>true</htmlEncoded>
    <key>sample string 1</key>
    <loginNames>sample string 3</loginNames>
    <page>5</page>
    <propertyType>Rental</propertyType>
  </options>
  <recordCount>1</recordCount>
</ListingsData>

multipart/form-data

Sample:

<ListingsData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRE.API.Models"><listings><Listing><agent>sample string 3</agent><availableDate>sample string 19</availableDate><bathrooms>16</bathrooms><bedrooms>15</bedrooms><bond>1.1</bond><bookLink>sample string 20</bookLink><carports>18</carports><categoryGroupID>14</categoryGroupID><country>sample string 8</country><description>sample string 24</description><displayPrice>sample string 13</displayPrice><garages>17</garages><headline>sample string 23</headline><iFrameBookLink>sample string 21</iFrameBookLink><id>1</id><images xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d4p1:string>sample string 1</d4p1:string><d4p1:string>sample string 2</d4p1:string></images><imagesWithType><ListingImage><imageType>sample string 4</imageType><isFloorPlan>true</isFloorPlan><isMainImage>true</isMainImage><url>sample string 1</url></ListingImage><ListingImage><imageType>sample string 4</imageType><isFloorPlan>true</isFloorPlan><isMainImage>true</isMainImage><url>sample string 1</url></ListingImage></imagesWithType><latitude>10.1</latitude><listingAgent><email>sample string 6</email><firstName>sample string 2</firstName><lastName>sample string 3</lastName><mobile>sample string 4</mobile><number>1</number><phone>sample string 5</phone></listingAgent><listingAgents><StaffMember><email>sample string 6</email><firstName>sample string 2</firstName><lastName>sample string 3</lastName><mobile>sample string 4</mobile><number>1</number><phone>sample string 5</phone></StaffMember><StaffMember><email>sample string 6</email><firstName>sample string 2</firstName><lastName>sample string 3</lastName><mobile>sample string 4</mobile><number>1</number><phone>sample string 5</phone></StaffMember></listingAgents><longitude>11.1</longitude><mainImageUrl>sample string 25</mainImageUrl><postcode>sample string 9</postcode><price>12.1</price><sourceUniqueID>sample string 2</sourceUniqueID><state>sample string 7</state><street>sample string 5</street><streetNo>sample string 4</streetNo><suburb>sample string 6</suburb><videoLink>sample string 26</videoLink><websiteLink>sample string 22</websiteLink></Listing><Listing><agent>sample string 3</agent><availableDate>sample string 19</availableDate><bathrooms>16</bathrooms><bedrooms>15</bedrooms><bond>1.1</bond><bookLink>sample string 20</bookLink><carports>18</carports><categoryGroupID>14</categoryGroupID><country>sample string 8</country><description>sample string 24</description><displayPrice>sample string 13</displayPrice><garages>17</garages><headline>sample string 23</headline><iFrameBookLink>sample string 21</iFrameBookLink><id>1</id><images xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d4p1:string>sample string 1</d4p1:string><d4p1:string>sample string 2</d4p1:string></images><imagesWithType><ListingImage><imageType>sample string 4</imageType><isFloorPlan>true</isFloorPlan><isMainImage>true</isMainImage><url>sample string 1</url></ListingImage><ListingImage><imageType>sample string 4</imageType><isFloorPlan>true</isFloorPlan><isMainImage>true</isMainImage><url>sample string 1</url></ListingImage></imagesWithType><latitude>10.1</latitude><listingAgent><email>sample string 6</email><firstName>sample string 2</firstName><lastName>sample string 3</lastName><mobile>sample string 4</mobile><number>1</number><phone>sample string 5</phone></listingAgent><listingAgents><StaffMember><email>sample string 6</email><firstName>sample string 2</firstName><lastName>sample string 3</lastName><mobile>sample string 4</mobile><number>1</number><phone>sample string 5</phone></StaffMember><StaffMember><email>sample string 6</email><firstName>sample string 2</firstName><lastName>sample string 3</lastName><mobile>sample string 4</mobile><number>1</number><phone>sample string 5</phone></StaffMember></listingAgents><longitude>11.1</longitude><mainImageUrl>sample string 25</mainImageUrl><postcode>sample string 9</postcode><price>12.1</price><sourceUniqueID>sample string 2</sourceUniqueID><state>sample string 7</state><street>sample string 5</street><streetNo>sample string 4</streetNo><suburb>sample string 6</suburb><videoLink>sample string 26</videoLink><websiteLink>sample string 22</websiteLink></Listing></listings><options><accountNames>sample string 2</accountNames><htmlEncoded>true</htmlEncoded><key>sample string 1</key><loginNames>sample string 3</loginNames><page>5</page><propertyType>Rental</propertyType></options><recordCount>1</recordCount></ListingsData>