Mapaprop

Getting started with Feeds API

Query thru thousands of properties to build your portal.

1. Obtain your access token

Register your application and follow Getting Started.

2. Basic workflow

We are trying to provide the quickest way to update the list of properties we can provide. A basic workflow should be something like:

  1. Day 1 of your app with us you call GET /api/action/feed-v1/get-total to see the total number of properties we have.
  2. Once you know the total number, start requesting data in batches of 500 properties using GET /api/action/feed-v1/get-properties. We throttle the amount of requests received so avoid making more than 2 concurrent calls to get the list of properties or you will start getting HTTP 503 errors.
  3. Now, day after day just call GET /api/action/feed-v1/get-delta to get the difference (added vs removed) for the following day and avoid re-reading large amounts of data. Note that the delta function has a date, so if you miss a day you can go back in time and ask what changed that particular date.

The agencyId (agency identifier)

Every property in the feed includes the agency object with its id field (called agencyId in other methods): a unique, stable, opaque identifier of the publishing agency. Treat it as an opaque string: store it exactly as you receive it and never try to parse or interpret it.

What it is for:

  1. Grouping properties by agency: all properties of the same agency share the same agency.id.
  2. Returning leads: send the value as-is in POST submit-question.
  3. Linking an agency with its account on your portal: when an agency signs up on your portal with its email, you can get its agencyId via Customer API (GET /api/action/customer-v1/{email}) and link its account with its feed properties. The email never travels in the feed: the agency provides it itself when registering.

The same identifier is used across Feeds API, Network API and Customer API.

Image downloads

Because costs in data transfer are pretty high today all images must be served from your hosts. In order to do that you will need to download images from our servers. To prevent misuse of images we need to know what user agent you are using to request images or what IP range you are coming from. Contact Mapaprop to provide this information. We will block all anonymous and suspicious traffic. (User-Agent example is Company/Version like Mapaprop/1.2.3)

After you get an access token from Mapaprop you will be able to access the Feeds API. Browse the different methods below

GET /api/action/feed-v1/get-total

GET /api/action/feed-v1/get-properties

GET /api/action/feed-v1/get-delta

GET /api/action/feed-v1/get-delta-network

POST /api/action/feed-v1/submit-question

4. Copyright

The copyright of the images and data belongs to Mapaprop. Through the feed agreement, Mapaprop allows all consumers to use these two items.