ImmoScout24 API class

immoscoutapi.py

import urllib
import oauth2 as oauth
import json


class ImmoScout24Api(object):
    def __init__(self, auth, domain='http://sandbox.immobilienscout24.de', headers=None):
        """
        auth must be a dictionary with the following keys:
        consumer_key, consumer_secret, access_token, access_secret
        """
        consumer = oauth.Consumer(auth['consumer_key'], auth['consumer_secret'])
        token = oauth.Token(auth['access_token'], auth['access_secret'])
        self.headers = {'Accept': 'application/json'}
        if headers is not None:
            self.headers.update(headers)
        self.client = oauth.Client(consumer, token)
        self.domain = domain

    def make_get_request(self, url):
        response = self.client.request(url, headers=self.headers, body=None)
        if response[0]['status'] != '200':
            raise Exception(response)
        try:
            return json.loads(response[1])
        except ValueError:
            raise Exception(response[1])

    def build_url(self, path, **kwargs):
        return "%s%s?%s" % (self.domain, path, urllib.urlencode(kwargs))

    def get(self, path, path_args=None, **kwargs):
        if path_args:
            path = path % path_args
        url = self.build_url(path, **kwargs)
        return self.make_get_request(url)

    def search_iterator(self, func, *args, **kwargs):
        res = func(*args, **kwargs)
        yield res
        while True:
            if not 'paging' in res['resultlist.resultlist']:
                raise StopIteration
            paging = res['resultlist.resultlist']['paging']
            if paging['pageNumber'] == paging['numberOfPages']:
                raise StopIteration
            url = paging['next']['@xlink.href']
            res = self.make_get_request(url)
            yield res

    def radius_search(self, realestatetype, lat, lng, radius, **kwargs):
        return self.get('/restapi/api/search/v1.0/search/radius',
            realestatetype=realestatetype,
            geocoordinates='%s;%s;%s' % (lat, lng, radius), **kwargs)

    def radius_search_list(self, realestatetype, lat, lng, radius, **kwargs):
        return self.search_iterator(self.radius_search, realestatetype, lat, lng, radius, **kwargs)

    def region_search(self, realestatetype, regions, **kwargs):
        if isinstance(regions, list) or isinstance(regions, tuple):
            regions = ','.join(regions)
        return self.get('/restapi/api/search/v1.0/search/region',
                realestatetype=realestatetype,
                geocodes=regions, **kwargs)

    def region_search_list(self, realestatetype, regions, **kwargs):
        return self.search_iterator(self.region_search, realestatetype, regions, **kwargs)

    def expose(self, exposeid):
        return self.get('/restapi/api/search/v1.0/expose/%s', (exposeid,))

    def expose_attachment_list(self, exposeid):
        return self.get('/restapi/api/search/v1.0/expose/%s/attachment', (exposeid,))

    def expose_attachment(self, exposeid, attachmentid):
        return self.get('/restapi/api/search/v1.0/expose/%s/attachment/%s', (exposeid, attachmentid))


if __name__ == '__main__':
    import sys
    (IMMOSCOUT_REST_KEY, IMMOSCOUT_REST_SECRET, IMMOSCOUT_ACCESS_TOKEN,
        IMMOSCOUT_ACCESS_TOKEN_SECRET) = sys.argv[1:]
    is24 = ImmoScout24Api({
        'consumer_key': IMMOSCOUT_REST_KEY,
        'consumer_secret': IMMOSCOUT_REST_SECRET,
        'access_token': IMMOSCOUT_ACCESS_TOKEN,
        'access_secret': IMMOSCOUT_ACCESS_TOKEN_SECRET
    })
    for res in is24.region_search_list('apartmentrent', '1276003001046'):
        print res['resultlist.resultlist']['paging']
    # res = is24.region_search('apartmentrent', '1276003001046')
    # res = is24.expose(61923564)
    # print json.dumps(res, indent=4)