{"id":17676511,"url":"https://github.com/lukeprior/pythonyoursuperapi","last_synced_at":"2025-07-26T22:13:11.695Z","repository":{"id":62590701,"uuid":"385859166","full_name":"LukePrior/PythonYourSuperAPI","owner":"LukePrior","description":"Python wrapper for the Australian Taxation Office YourSuper API.","archived":false,"fork":false,"pushed_at":"2021-08-31T07:35:05.000Z","size":43,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-26T15:22:03.342Z","etag":null,"topics":["api","australia","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/YourSuperAPI/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LukePrior.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-14T07:55:05.000Z","updated_at":"2023-11-22T12:36:31.000Z","dependencies_parsed_at":"2022-11-04T08:18:22.068Z","dependency_job_id":null,"html_url":"https://github.com/LukePrior/PythonYourSuperAPI","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukePrior%2FPythonYourSuperAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukePrior%2FPythonYourSuperAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukePrior%2FPythonYourSuperAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukePrior%2FPythonYourSuperAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LukePrior","download_url":"https://codeload.github.com/LukePrior/PythonYourSuperAPI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243208698,"owners_count":20254086,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","australia","hacktoberfest"],"created_at":"2024-10-24T07:25:53.182Z","updated_at":"2025-03-12T11:30:37.121Z","avatar_url":"https://github.com/LukePrior.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Python YourSuper API\n\nPython wrapper for the Australian Taxation Office [YourSuper API](https://www.ato.gov.au/YourSuper-Comparison-Tool/)\n\n## Installation \n\n```python\npip install YourSuperAPI\n```\n\n## Available Options\n\n### amountRange (default=All)\n\nIndicate how many results to return accepts integer between 1 and 9999 or array of two values to indicate range to return.\n\n### age (default=0)\n\nPositive integer less than 100 to set account holder age.\n\n### balance (default=50000)\n\nPositive Integer or Float value to set account balance, used to determine fees for each product.\n\n### private (default=False)\n\nBoolean value to determine if private super funds will be returned.\n\n### performance (default=0)\n\nInteger value to determine what [performance tested](https://www.apra.gov.au/quarterly-superannuation-statistics) super funds will be returned.\n- 0 (return all super funds)\n- 1 (return only super funds assessed to meet benchmark)\n- 2 (return only super funds assessed to fail benchmark)\n- 3 (return only super funds not assessed)\n\n\n## Examples\n\n### Fetch all products\n\n```python\nfrom YourSuperAPI import YourSuperAPI\n\ndata = YourSuperAPI.get_data()\n\nprint(data)\n```\n\n### Fetch first 5 products\n\n```python\nfrom YourSuperAPI import YourSuperAPI\n\ndata = YourSuperAPI.get_data(amountRange=5)\n\nprint(data)\n```\n\n### Fetch 10th - 20th products\n\n```python\nfrom YourSuperAPI import YourSuperAPI\n\ndata = YourSuperAPI.get_data(amountRange=[10,20])\n\nprint(data)\n```\n\n### Fetch with custom account balance ($1000.56)\n\n```python\nfrom YourSuperAPI import YourSuperAPI\n\ndata = YourSuperAPI.get_data(balance=1000.56)\n\nprint(data)\n```\n\n### Fetch with custom account holder age (42 years)\n\n```python\nfrom YourSuperAPI import YourSuperAPI\n\ndata = YourSuperAPI.get_data(age=42)\n\nprint(data)\n```\n\n### Fetch without private funds\n\n```python\nfrom YourSuperAPI import YourSuperAPI\n\ndata = YourSuperAPI.get_data(private=True)\n\nprint(data)\n```\n\n### Fetch underperforming funds\n\n```python\nfrom YourSuperAPI import YourSuperAPI\n\ndata = YourSuperAPI.get_data(performance=2)\n\nprint(data)\n```\n\n## Advanced Examples\n\n### Print 7 year net returns for public funds with $200,000 balance and 50 year old account holder\n\n```python\nfrom YourSuperAPI import YourSuperAPI\n\ndata = YourSuperAPI.get_data(private=True, age=50, balance=200000)\n\nfor superfund in data:\n    print(superfund[\"superannuationProviderProductName\"])\n    for subproduct in superfund[\"subProduct\"]:\n        print(subproduct[\"fundNetReturnLastSevenYearsPercentageNumber\"])\n```\n\n## Data Structure\n\nThe API returns a Python list of super funds, the structure of each of these funds follows:\n\n```\n{\n  'performanceRatingCode': 'Performing', \n  'superannuationProviderDetailFundName': 'QSuper', \n  'superannuationProviderProductName': 'QSuper Lifetime', \n  'subProduct': [{\n    'lifeCycleStageName': 'Focus 1 Group', \n    'fundNetReturnLastSevenYearsPercentageNumber': 7.98, \n    'fundNetReturnLastFiveYearsPercentageNumber': 7.37, \n    'fundNetReturnLastThreeYearsPercentageNumber': 8.2, \n    'privateFundIndicator': 'N', \n    'adminFeesDisclosedAmount': 80.0, \n    'riskLevelCode': 'Medium', \n    'internetURLAddress': 'https://qsuper.qld.gov.au/our-products/investment-options/lifetime', \n    'superannuationFundInvestmentStrategyTypeCode': 'Lifecycle', \n    'superannuationProductSubproductID': 724652609, \n    'investmentFeesDisclosedAmount': 195.0, \n    'totalFeesDisclosedAmount': 275.0\n  }]\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukeprior%2Fpythonyoursuperapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flukeprior%2Fpythonyoursuperapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukeprior%2Fpythonyoursuperapi/lists"}