Skip to content

getting_started.rst

Latest commit

 

History

History
62 lines (46 loc) · 1.55 KB

getting_started.rst

File metadata and controls

62 lines (46 loc) · 1.55 KB
Raw

Getting started

Installation

The last stable release is available on PyPI and can be installed with pip:

$ pip install git+https://github.com/RESOStandards/RESO-WebAPI-Client-Python.git

Requirements

Dependencies

The following Python extensions are required for all the RESO WebAPI Client Python SDK functions to work properly:

Example usage

Simple usage looks like:

reso = RESO(
    client_id='YOUR_CLIENT_ID',
    client_secret='YOUR_CLIENT_SECRET',
    api_auth_url='https://op.api.crmls.org/identity/connect/authorize',
    api_token_url='https://op.api.crmls.org/identity/connect/token',
    api_request_url='https://h.api.crmls.org/RESO/OData/'
)
# Authorize user
req_obj = OpenIDAuthentication(
        redirect_uri='https://openid.reso.org/',
        scope='ODataApi',
        reso=reso
    )
# Get access token
req_obj.auth_code = req_obj.authorize('USERNAME', 'PASSWORD')
reso.access_token = req_obj.request_access_token()
# Retrieve top 10 properties from the RESO API endpoint
http_request = HttpRequest(reso=reso)
result = http_request.request('Property?$top=10', 'json')
# Display records
print(result);