Python wrapper for the 3taps API.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
threetaps
.gitignore
LICENSE
MANIFEST.in
README.rst
requirements.txt
setup.py
test_threetaps.py

README.rst

3taps

A Python interface for the 3taps API.

The goal of this library is to map 3taps' endpoints one-to-one. Calls to 3taps are made with clean, Pythonic methods. It only handles raw data, allowing you to define your own models.

Dependencies:

  • requests

Installation

Install via pip:

$ pip install threetaps

Install from source:

$ git clone https://github.com/mkolodny/3taps.git
$ cd 3taps
$ python setup.py install

Usage

Instantiating a client:

>>> client = threetaps.Threetaps('YOUR_API_KEY')

Examples

Reference

Sources:

>>> client.reference.sources()

Category Groups:

>>> client.reference.category_groups()

Categories:

>>> client.reference.categories()

Locations:

>>> client.reference.locations('locality', params={'city': 'USA-NYM-NEY'})

Locations Lookup:

>>> client.reference.location_lookup('CAN-YUL')

Search

Search:

>>> client.search.search(params={'location.city': 'USA-NYM-NEY'})

Count:

>>> client.search.count('category', params={'status': 'for_sale'})

Polling

Anchor:

>>> utc_dt = datetime.today()
>>> client.polling.anchor(utc_dt)

Poll:

>>> client.polling.poll(params={'anchor': '306785687'})