Python based API for Shapeshift.io

shapeshift.py

"""
Shapeshift.io API

Implements all the API calls on Shapeshift.io

All documentation is taken from https://info.shapeshift.io
"""
import requests


BASE_URL = 'https://shapeshift.io/%s'


def _shapeshift_get_request(url_path):
    """
    Combines the provided url_path with Shapeshift's base url and performs a get request.
    """
    url = BASE_URL % url_path
    response = requests.get(url)
    return response.json()


def _shapeshift_post_request(url_path, payload):
    """
    Combines the provided url_path with Shapeshift's base url and performs
    a post request with the provided payoad
    """
    url = BASE_URL % url_path

    # Filter out any values that are None
    payload = {k: v for k, v in payload.items() if v is not None}

    response = requests.post(url, data=payload)
    return response.json()


def get_coins():
    url_path = 'getcoins'
    return _shapeshift_get_request(url_path)


def get_rate(input_coin, output_coin):
    url_path = "rate/{}_{}".format(input_coin, output_coin)
    return _shapeshift_get_request(url_path)


def get_deposit_limit(input_coin, output_coin):
    url_path = "limit/{}_{}".format(input_coin, output_coin)
    return _shapeshift_get_request(url_path)


def get_market_info(input_coin, output_coin):
    url_path = "marketinfo/{}_{}".format(input_coin, output_coin)
    return _shapeshift_get_request(url_path)


def get_recent_tx_list(max_transactions):
    # Condition from shapeshift documentation.
    assert 1 <= max_transactions <= 50
    url_path = "recenttx/{}".format(max_transactions)
    return _shapeshift_get_request(url_path)


def get_tx_status(address):
    url_path = "txStat/{}".format(address)
    return _shapeshift_get_request(url_path)


def get_time_remaining_on_fixed_tx(address):
    url_path = "timeremaining/{}".format(address)
    return _shapeshift_get_request(url_path)


def get_tx_by_api_key(api_key):
    url_path = "txbyapikey/{}".format(api_key)
    return _shapeshift_get_request(url_path)


def get_tx_by_address(address, api_key):
    url_path = "txbyapikey/{}/{}".format(address, api_key)
    return _shapeshift_get_request(url_path)


def validate_address(address, coin_symbol):
    url_path = "validateAddress/{}/{}".format(address, coin_symbol)
    return _shapeshift_get_request(url_path)


def create_normal_tx(withdrawal_address, input_coin, output_coin,
           return_address=None,
           destination_tag=None,
           rs_address=None,
           api_key=None):
    url_path = "shift"

    payload = {
        'withdrawal': withdrawal_address,
        'pair': "{}_{}".format(input_coin, output_coin),
        'returnAddress': return_address,
        'destTag': destination_tag,
        'rsAddress': rs_address,
        'apiKey': api_key
    }

    return _shapeshift_post_request(url_path, payload)


def request_email_receipt(email, tx_id):
    url_path = "mail"

    payload = {
        'email': email,
        'txid': tx_id
    }

    return _shapeshift_post_request(url_path, payload)


def create_fixed_amount_tx(amount, withdrawal_address, input_coin, output_coin,
            return_address=None,
            destination_tag=None,
            rs_address=None,
            api_key=None):
    url_path = "sendamount"

    payload = {
        'amount': amount,
        'withdrawal': withdrawal_address,
        'pair': "{}_{}".format(input_coin, output_coin),
        'returnAddress': return_address,
        'destTag': destination_tag,
        'rsAddress': rs_address,
        'apiKey': api_key
    }

    return _shapeshift_post_request(url_path, payload)


def cancel_tx(address):
    url_path = "cancelpending"

    payload = {
        'address': address,
    }

    return _shapeshift_post_request(url_path, payload)