Pulse API - Getting Started

Welcome to the Pulse API Getting Started guide. This repository provides an introduction and practical examples to help you integrate and utilize the Pulse API effectively by using simple python instrumentation.

Table of Contents

• Introduction
• Requirements
• Installation
• Usage
• Contributing
• License

Introduction

The Pulse API allows you to access various real estate data and analytics. This guide includes Jupyter Notebooks demonstrating different selected use cases, from securing your access to making various types of queries.

Requirements

• Python 3.6 or higher
• Docker (optional for containerized execution)

Installation

1. Clone the repository:

   git clone https://github.com/urbandataanalytics/pulse-api-getting-started.git
   cd pulse-api-getting-started

2. Install the required packages:

   pip install -r requirements.txt

Usage

This repository includes Jupyter Notebooks with detailed examples on how to use the Pulse API:

1. 1-Securing.ipynb - How to secure your API access.
2. 2-Search.ipynb - Examples of search queries.
3. 3-Usage.ipynb - Usage statistics and analytics.
4. ...

To start the Jupyter Notebook server, run:

jupyter notebook

Contributing

We welcome contributions to improve our examples and documentation. Please fork the repository, make your changes, and submit a pull request.

License

This project is licensed under the Apache-2.0 License. See the LICENSE file for details.