YourSuperAPI 0.0.2

Python wrapper for the YourSuper API

PythonYourSuperAPI

Python wrapper for the Australian Taxation Office YourSuper API

Installation

pip install YourSuperAPI

Available Options

amountRange (default=9999)

Indicate how many results to return accepts integer between 1 and 9999 or array of two values to indicate range to return.

age (default=0)

Positive integer less than 100 to set account holder age.

balance (default=50000)

Positive Integer or Float value to set account balance, used to determine fees for each product.

private (default=False)

Boolean value to determine if private super funds will be returned.

Examples

Fetch all products

from YourSuperAPI import YourSuperAPI

data = YourSuperAPI.get_data()

print(data)

Fetch first 5 products

from YourSuperAPI import YourSuperAPI

data = YourSuperAPI.get_data(amountRange=5)

print(data)

Fetch 10th - 20th products

from YourSuperAPI import YourSuperAPI

data = YourSuperAPI.get_data(amountRange=[10,20])

print(data)

Fetch with custom account balance ($1000.56)

from YourSuperAPI import YourSuperAPI

data = YourSuperAPI.get_data(balance=1000.56)

print(data)

Fetch with custom account holder age (42 years)

from YourSuperAPI import YourSuperAPI

data = YourSuperAPI.get_data(age=42)

print(data)

Fetch without private funds

from YourSuperAPI import YourSuperAPI

data = YourSuperAPI.get_data(private=True)

print(data)