GET api/IDXPin?agentid={agentid}&buyerid={buyerid}&cookieId={cookieId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
agentid

integer

Required

buyerid

integer

Required

cookieId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

IDXPinLeadsResult
NameDescriptionTypeAdditional information
PropertiesViewedWhileAnon

integer

None.

PropertiesViewedWhileLoggedIn

integer

None.

SearchRange

LeadsProfileRanges

None.

Listings

Collection of ViewedListings

None.

Response Formats

application/json, text/json

Sample:
{
  "PropertiesViewedWhileAnon": 1,
  "PropertiesViewedWhileLoggedIn": 2,
  "SearchRange": {
    "BedroomRange": {
      "LowRangeBedrooms": 1,
      "HighRangeBedrooms": 2
    },
    "BathroomRange": {
      "LowRangeBathrooms": 1,
      "HighRangeBathrooms": 2
    },
    "PriceRange": {
      "LowRangePrice": 1.1,
      "HighRangePrice": 2.1
    },
    "SizeRange": {
      "LowRangeSize": 1,
      "HighRangeSize": 2
    }
  },
  "Listings": [
    {
      "ListingId": "sample string 1",
      "HomeAsapId": "sample string 2",
      "MlsId": "sample string 3",
      "HowManyTimesViewed": 4,
      "Listing": {
        "AlternativeOfficeAgent": {
          "Name": "sample string 1",
          "Id": "sample string 2",
          "OfficeId": "sample string 3",
          "OfficeName": "sample string 4",
          "OfficePhone": "sample string 5",
          "Phone": "sample string 6",
          "License": "sample string 7",
          "ProfileImageUrl": "sample string 8",
          "MembershipId": 1
        },
        "CityName": "sample string 1",
        "CoAgent": {
          "Name": "sample string 1",
          "Id": "sample string 2",
          "OfficeId": "sample string 3",
          "OfficeName": "sample string 4",
          "OfficePhone": "sample string 5",
          "Phone": "sample string 6",
          "License": "sample string 7",
          "ProfileImageUrl": "sample string 8",
          "MembershipId": 1
        },
        "DaysOnMarket": 1,
        "DefaultImage": "sample string 2",
        "FullStreetAddress": "sample string 3",
        "Id": "sample string 4",
        "ImageCount": 1,
        "ImageLocation": "sample string 5",
        "LandTenure": "sample string 6",
        "ListedOn": "2021-08-03T11:33:18.4116965+00:00",
        "ListingAgent": {
          "Name": "sample string 1",
          "Id": "sample string 2",
          "OfficeId": "sample string 3",
          "OfficeName": "sample string 4",
          "OfficePhone": "sample string 5",
          "Phone": "sample string 6",
          "License": "sample string 7",
          "ProfileImageUrl": "sample string 8",
          "MembershipId": 1
        },
        "ListOnInternet": true,
        "ListPrice": 1.1,
        "LivingSquareFeet": 1,
        "Location": {
          "Lat": 1.1,
          "Lon": 2.1
        },
        "MlsIds": [
          "sample string 1",
          "sample string 2"
        ],
        "OriginatingMls": "sample string 8",
        "PropertyListingId": "sample string 9",
        "RangeHighPrice": 1.1,
        "RangeHighSquareFeet": 1,
        "RangeLowSquareFeet": 1,
        "RangePriceFlag": "sample string 10",
        "REALData": true,
        "SaleType": 1,
        "TotalBaths": 1.1,
        "TotalBedrooms": 1,
        "State": "sample string 11",
        "Status": "sample string 12",
        "StreetAddress": "sample string 13",
        "YearBuilt": 1,
        "ZipCode": "sample string 14",
        "ListingImageLocation": 0
      },
      "DateLastViewed": "2021-08-03T11:33:18.4116965+00:00"
    },
    {
      "ListingId": "sample string 1",
      "HomeAsapId": "sample string 2",
      "MlsId": "sample string 3",
      "HowManyTimesViewed": 4,
      "Listing": {
        "AlternativeOfficeAgent": {
          "Name": "sample string 1",
          "Id": "sample string 2",
          "OfficeId": "sample string 3",
          "OfficeName": "sample string 4",
          "OfficePhone": "sample string 5",
          "Phone": "sample string 6",
          "License": "sample string 7",
          "ProfileImageUrl": "sample string 8",
          "MembershipId": 1
        },
        "CityName": "sample string 1",
        "CoAgent": {
          "Name": "sample string 1",
          "Id": "sample string 2",
          "OfficeId": "sample string 3",
          "OfficeName": "sample string 4",
          "OfficePhone": "sample string 5",
          "Phone": "sample string 6",
          "License": "sample string 7",
          "ProfileImageUrl": "sample string 8",
          "MembershipId": 1
        },
        "DaysOnMarket": 1,
        "DefaultImage": "sample string 2",
        "FullStreetAddress": "sample string 3",
        "Id": "sample string 4",
        "ImageCount": 1,
        "ImageLocation": "sample string 5",
        "LandTenure": "sample string 6",
        "ListedOn": "2021-08-03T11:33:18.4116965+00:00",
        "ListingAgent": {
          "Name": "sample string 1",
          "Id": "sample string 2",
          "OfficeId": "sample string 3",
          "OfficeName": "sample string 4",
          "OfficePhone": "sample string 5",
          "Phone": "sample string 6",
          "License": "sample string 7",
          "ProfileImageUrl": "sample string 8",
          "MembershipId": 1
        },
        "ListOnInternet": true,
        "ListPrice": 1.1,
        "LivingSquareFeet": 1,
        "Location": {
          "Lat": 1.1,
          "Lon": 2.1
        },
        "MlsIds": [
          "sample string 1",
          "sample string 2"
        ],
        "OriginatingMls": "sample string 8",
        "PropertyListingId": "sample string 9",
        "RangeHighPrice": 1.1,
        "RangeHighSquareFeet": 1,
        "RangeLowSquareFeet": 1,
        "RangePriceFlag": "sample string 10",
        "REALData": true,
        "SaleType": 1,
        "TotalBaths": 1.1,
        "TotalBedrooms": 1,
        "State": "sample string 11",
        "Status": "sample string 12",
        "StreetAddress": "sample string 13",
        "YearBuilt": 1,
        "ZipCode": "sample string 14",
        "ListingImageLocation": 0
      },
      "DateLastViewed": "2021-08-03T11:33:18.4116965+00:00"
    }
  ]
}

text/html

Sample:
{"PropertiesViewedWhileAnon":1,"PropertiesViewedWhileLoggedIn":2,"SearchRange":{"BedroomRange":{"LowRangeBedrooms":1,"HighRangeBedrooms":2},"BathroomRange":{"LowRangeBathrooms":1,"HighRangeBathrooms":2},"PriceRange":{"LowRangePrice":1.1,"HighRangePrice":2.1},"SizeRange":{"LowRangeSize":1,"HighRangeSize":2}},"Listings":[{"ListingId":"sample string 1","HomeAsapId":"sample string 2","MlsId":"sample string 3","HowManyTimesViewed":4,"Listing":{"AlternativeOfficeAgent":{"Name":"sample string 1","Id":"sample string 2","OfficeId":"sample string 3","OfficeName":"sample string 4","OfficePhone":"sample string 5","Phone":"sample string 6","License":"sample string 7","ProfileImageUrl":"sample string 8","MembershipId":1},"CityName":"sample string 1","CoAgent":{"Name":"sample string 1","Id":"sample string 2","OfficeId":"sample string 3","OfficeName":"sample string 4","OfficePhone":"sample string 5","Phone":"sample string 6","License":"sample string 7","ProfileImageUrl":"sample string 8","MembershipId":1},"DaysOnMarket":1,"DefaultImage":"sample string 2","FullStreetAddress":"sample string 3","Id":"sample string 4","ImageCount":1,"ImageLocation":"sample string 5","LandTenure":"sample string 6","ListedOn":"2021-08-03T11:33:18.4116965+00:00","ListingAgent":{"Name":"sample string 1","Id":"sample string 2","OfficeId":"sample string 3","OfficeName":"sample string 4","OfficePhone":"sample string 5","Phone":"sample string 6","License":"sample string 7","ProfileImageUrl":"sample string 8","MembershipId":1},"ListOnInternet":true,"ListPrice":1.1,"LivingSquareFeet":1,"Location":{"Lat":1.1,"Lon":2.1},"MlsIds":["sample string 1","sample string 2"],"OriginatingMls":"sample string 8","PropertyListingId":"sample string 9","RangeHighPrice":1.1,"RangeHighSquareFeet":1,"RangeLowSquareFeet":1,"RangePriceFlag":"sample string 10","REALData":true,"SaleType":1,"TotalBaths":1.1,"TotalBedrooms":1,"State":"sample string 11","Status":"sample string 12","StreetAddress":"sample string 13","YearBuilt":1,"ZipCode":"sample string 14","ListingImageLocation":0},"DateLastViewed":"2021-08-03T11:33:18.4116965+00:00"},{"ListingId":"sample string 1","HomeAsapId":"sample string 2","MlsId":"sample string 3","HowManyTimesViewed":4,"Listing":{"AlternativeOfficeAgent":{"Name":"sample string 1","Id":"sample string 2","OfficeId":"sample string 3","OfficeName":"sample string 4","OfficePhone":"sample string 5","Phone":"sample string 6","License":"sample string 7","ProfileImageUrl":"sample string 8","MembershipId":1},"CityName":"sample string 1","CoAgent":{"Name":"sample string 1","Id":"sample string 2","OfficeId":"sample string 3","OfficeName":"sample string 4","OfficePhone":"sample string 5","Phone":"sample string 6","License":"sample string 7","ProfileImageUrl":"sample string 8","MembershipId":1},"DaysOnMarket":1,"DefaultImage":"sample string 2","FullStreetAddress":"sample string 3","Id":"sample string 4","ImageCount":1,"ImageLocation":"sample string 5","LandTenure":"sample string 6","ListedOn":"2021-08-03T11:33:18.4116965+00:00","ListingAgent":{"Name":"sample string 1","Id":"sample string 2","OfficeId":"sample string 3","OfficeName":"sample string 4","OfficePhone":"sample string 5","Phone":"sample string 6","License":"sample string 7","ProfileImageUrl":"sample string 8","MembershipId":1},"ListOnInternet":true,"ListPrice":1.1,"LivingSquareFeet":1,"Location":{"Lat":1.1,"Lon":2.1},"MlsIds":["sample string 1","sample string 2"],"OriginatingMls":"sample string 8","PropertyListingId":"sample string 9","RangeHighPrice":1.1,"RangeHighSquareFeet":1,"RangeLowSquareFeet":1,"RangePriceFlag":"sample string 10","REALData":true,"SaleType":1,"TotalBaths":1.1,"TotalBedrooms":1,"State":"sample string 11","Status":"sample string 12","StreetAddress":"sample string 13","YearBuilt":1,"ZipCode":"sample string 14","ListingImageLocation":0},"DateLastViewed":"2021-08-03T11:33:18.4116965+00:00"}]}

application/xml, text/xml

Sample:
<IDXPinLeadsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NPlay.Common.Models.Services">
  <Listings>
    <ViewedListings>
      <DateLastViewed>2021-08-03T11:33:18.4116965+00:00</DateLastViewed>
      <HomeAsapId>sample string 2</HomeAsapId>
      <HowManyTimesViewed>4</HowManyTimesViewed>
      <Listing>
        <AlternativeOfficeAgent xmlns:d5p1="http://schemas.datacontract.org/2004/07/NPlay.Common.Models">
          <DataProviderListingPrefix xmlns="http://schemas.datacontract.org/2004/07/NPlay.Common.Models.Abstract.MlsData">sample string 9</DataProviderListingPrefix>
          <d5p1:Id>sample string 2</d5p1:Id>
          <d5p1:License>sample string 7</d5p1:License>
          <d5p1:MembershipId>1</d5p1:MembershipId>
          <d5p1:Name>sample string 1</d5p1:Name>
          <d5p1:OfficeId>sample string 3</d5p1:OfficeId>
          <d5p1:OfficeName>sample string 4</d5p1:OfficeName>
          <d5p1:OfficePhone>sample string 5</d5p1:OfficePhone>
          <d5p1:Phone>sample string 6</d5p1:Phone>
          <d5p1:ProfileImageUrl>sample string 8</d5p1:ProfileImageUrl>
        </AlternativeOfficeAgent>
        <CityName>sample string 1</CityName>
        <CoAgent xmlns:d5p1="http://schemas.datacontract.org/2004/07/NPlay.Common.Models">
          <DataProviderListingPrefix xmlns="http://schemas.datacontract.org/2004/07/NPlay.Common.Models.Abstract.MlsData">sample string 9</DataProviderListingPrefix>
          <d5p1:Id>sample string 2</d5p1:Id>
          <d5p1:License>sample string 7</d5p1:License>
          <d5p1:MembershipId>1</d5p1:MembershipId>
          <d5p1:Name>sample string 1</d5p1:Name>
          <d5p1:OfficeId>sample string 3</d5p1:OfficeId>
          <d5p1:OfficeName>sample string 4</d5p1:OfficeName>
          <d5p1:OfficePhone>sample string 5</d5p1:OfficePhone>
          <d5p1:Phone>sample string 6</d5p1:Phone>
          <d5p1:ProfileImageUrl>sample string 8</d5p1:ProfileImageUrl>
        </CoAgent>
        <DaysOnMarket>1</DaysOnMarket>
        <DefaultImage>sample string 2</DefaultImage>
        <FullStreetAddress>sample string 3</FullStreetAddress>
        <GarageSpaces>1</GarageSpaces>
        <Id>sample string 4</Id>
        <ImageCount>1</ImageCount>
        <ImageLocation>sample string 5</ImageLocation>
        <LandTenure>sample string 6</LandTenure>
        <ListOnInternet>true</ListOnInternet>
        <ListPrice>1.1</ListPrice>
        <ListedOn>2021-08-03T11:33:18.4116965+00:00</ListedOn>
        <ListingAgent xmlns:d5p1="http://schemas.datacontract.org/2004/07/NPlay.Common.Models">
          <DataProviderListingPrefix xmlns="http://schemas.datacontract.org/2004/07/NPlay.Common.Models.Abstract.MlsData">sample string 9</DataProviderListingPrefix>
          <d5p1:Id>sample string 2</d5p1:Id>
          <d5p1:License>sample string 7</d5p1:License>
          <d5p1:MembershipId>1</d5p1:MembershipId>
          <d5p1:Name>sample string 1</d5p1:Name>
          <d5p1:OfficeId>sample string 3</d5p1:OfficeId>
          <d5p1:OfficeName>sample string 4</d5p1:OfficeName>
          <d5p1:OfficePhone>sample string 5</d5p1:OfficePhone>
          <d5p1:Phone>sample string 6</d5p1:Phone>
          <d5p1:ProfileImageUrl>sample string 8</d5p1:ProfileImageUrl>
        </ListingAgent>
        <LivingSquareFeet>1</LivingSquareFeet>
        <Location xmlns:d5p1="http://schemas.datacontract.org/2004/07/NPlay.Common.Models">
          <d5p1:Lat>1.1</d5p1:Lat>
          <d5p1:Lon>2.1</d5p1:Lon>
        </Location>
        <MlsIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </MlsIds>
        <OriginatingMls>sample string 8</OriginatingMls>
        <PropertyListingId>sample string 9</PropertyListingId>
        <PropertyType>All</PropertyType>
        <REALData>true</REALData>
        <RangeHighPrice>1.1</RangeHighPrice>
        <RangeHighSquareFeet>1</RangeHighSquareFeet>
        <RangeLowSquareFeet>1</RangeLowSquareFeet>
        <RangePriceFlag>sample string 10</RangePriceFlag>
        <SaleType>Sale</SaleType>
        <State>sample string 11</State>
        <Status>sample string 12</Status>
        <StreetAddress>sample string 13</StreetAddress>
        <TotalBaths>1.1</TotalBaths>
        <TotalBedrooms>1</TotalBedrooms>
        <YearBuilt>1</YearBuilt>
        <ZipCode>sample string 14</ZipCode>
      </Listing>
      <ListingId>sample string 1</ListingId>
      <MlsId>sample string 3</MlsId>
    </ViewedListings>
    <ViewedListings>
      <DateLastViewed>2021-08-03T11:33:18.4116965+00:00</DateLastViewed>
      <HomeAsapId>sample string 2</HomeAsapId>
      <HowManyTimesViewed>4</HowManyTimesViewed>
      <Listing>
        <AlternativeOfficeAgent xmlns:d5p1="http://schemas.datacontract.org/2004/07/NPlay.Common.Models">
          <DataProviderListingPrefix xmlns="http://schemas.datacontract.org/2004/07/NPlay.Common.Models.Abstract.MlsData">sample string 9</DataProviderListingPrefix>
          <d5p1:Id>sample string 2</d5p1:Id>
          <d5p1:License>sample string 7</d5p1:License>
          <d5p1:MembershipId>1</d5p1:MembershipId>
          <d5p1:Name>sample string 1</d5p1:Name>
          <d5p1:OfficeId>sample string 3</d5p1:OfficeId>
          <d5p1:OfficeName>sample string 4</d5p1:OfficeName>
          <d5p1:OfficePhone>sample string 5</d5p1:OfficePhone>
          <d5p1:Phone>sample string 6</d5p1:Phone>
          <d5p1:ProfileImageUrl>sample string 8</d5p1:ProfileImageUrl>
        </AlternativeOfficeAgent>
        <CityName>sample string 1</CityName>
        <CoAgent xmlns:d5p1="http://schemas.datacontract.org/2004/07/NPlay.Common.Models">
          <DataProviderListingPrefix xmlns="http://schemas.datacontract.org/2004/07/NPlay.Common.Models.Abstract.MlsData">sample string 9</DataProviderListingPrefix>
          <d5p1:Id>sample string 2</d5p1:Id>
          <d5p1:License>sample string 7</d5p1:License>
          <d5p1:MembershipId>1</d5p1:MembershipId>
          <d5p1:Name>sample string 1</d5p1:Name>
          <d5p1:OfficeId>sample string 3</d5p1:OfficeId>
          <d5p1:OfficeName>sample string 4</d5p1:OfficeName>
          <d5p1:OfficePhone>sample string 5</d5p1:OfficePhone>
          <d5p1:Phone>sample string 6</d5p1:Phone>
          <d5p1:ProfileImageUrl>sample string 8</d5p1:ProfileImageUrl>
        </CoAgent>
        <DaysOnMarket>1</DaysOnMarket>
        <DefaultImage>sample string 2</DefaultImage>
        <FullStreetAddress>sample string 3</FullStreetAddress>
        <GarageSpaces>1</GarageSpaces>
        <Id>sample string 4</Id>
        <ImageCount>1</ImageCount>
        <ImageLocation>sample string 5</ImageLocation>
        <LandTenure>sample string 6</LandTenure>
        <ListOnInternet>true</ListOnInternet>
        <ListPrice>1.1</ListPrice>
        <ListedOn>2021-08-03T11:33:18.4116965+00:00</ListedOn>
        <ListingAgent xmlns:d5p1="http://schemas.datacontract.org/2004/07/NPlay.Common.Models">
          <DataProviderListingPrefix xmlns="http://schemas.datacontract.org/2004/07/NPlay.Common.Models.Abstract.MlsData">sample string 9</DataProviderListingPrefix>
          <d5p1:Id>sample string 2</d5p1:Id>
          <d5p1:License>sample string 7</d5p1:License>
          <d5p1:MembershipId>1</d5p1:MembershipId>
          <d5p1:Name>sample string 1</d5p1:Name>
          <d5p1:OfficeId>sample string 3</d5p1:OfficeId>
          <d5p1:OfficeName>sample string 4</d5p1:OfficeName>
          <d5p1:OfficePhone>sample string 5</d5p1:OfficePhone>
          <d5p1:Phone>sample string 6</d5p1:Phone>
          <d5p1:ProfileImageUrl>sample string 8</d5p1:ProfileImageUrl>
        </ListingAgent>
        <LivingSquareFeet>1</LivingSquareFeet>
        <Location xmlns:d5p1="http://schemas.datacontract.org/2004/07/NPlay.Common.Models">
          <d5p1:Lat>1.1</d5p1:Lat>
          <d5p1:Lon>2.1</d5p1:Lon>
        </Location>
        <MlsIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </MlsIds>
        <OriginatingMls>sample string 8</OriginatingMls>
        <PropertyListingId>sample string 9</PropertyListingId>
        <PropertyType>All</PropertyType>
        <REALData>true</REALData>
        <RangeHighPrice>1.1</RangeHighPrice>
        <RangeHighSquareFeet>1</RangeHighSquareFeet>
        <RangeLowSquareFeet>1</RangeLowSquareFeet>
        <RangePriceFlag>sample string 10</RangePriceFlag>
        <SaleType>Sale</SaleType>
        <State>sample string 11</State>
        <Status>sample string 12</Status>
        <StreetAddress>sample string 13</StreetAddress>
        <TotalBaths>1.1</TotalBaths>
        <TotalBedrooms>1</TotalBedrooms>
        <YearBuilt>1</YearBuilt>
        <ZipCode>sample string 14</ZipCode>
      </Listing>
      <ListingId>sample string 1</ListingId>
      <MlsId>sample string 3</MlsId>
    </ViewedListings>
  </Listings>
  <PropertiesViewedWhileAnon>1</PropertiesViewedWhileAnon>
  <PropertiesViewedWhileLoggedIn>2</PropertiesViewedWhileLoggedIn>
  <SearchRange>
    <BathroomRange>
      <HighRangeBathrooms>2</HighRangeBathrooms>
      <LowRangeBathrooms>1</LowRangeBathrooms>
    </BathroomRange>
    <BedroomRange>
      <HighRangeBedrooms>2</HighRangeBedrooms>
      <LowRangeBedrooms>1</LowRangeBedrooms>
    </BedroomRange>
    <PriceRange>
      <HighRangePrice>2.1</HighRangePrice>
      <LowRangePrice>1.1</LowRangePrice>
    </PriceRange>
    <SizeRange>
      <HighRangeSize>2</HighRangeSize>
      <LowRangeSize>1</LowRangeSize>
    </SizeRange>
  </SearchRange>
</IDXPinLeadsResult>