Freenet FUNK API

Archived

Since I don't use freenet funk anymore, I am not able to maintain this api any longer. If you want to become the new maintainer, feel free to fork this repo.

Introduction

Freenet FUNK is cellphone plan that offers unlimited (or 1 GB of) 4G data. The plan is can be started, stopped and paused daily.

To make the most out of this flexibility, I reverse engineered the API to give anyone the ability to develop amazing apps on their own!

Prerequisites

Python >=3.2
pip3 (or just pip on windows)

Installation

Install from pypi

pip3 install funkapi

Install from source

git clone https://github.com/lagmoellertim/freenet-funk-api.git

cd freenet-funk-api

pip3 install -r requirements.txt

python3 setup.py install

Build

git clone https://github.com/lagmoellertim/freenet-funk-api.git

cd freenet-funk-api

pip3 install -r requirements.txt

python3 setup.py sdist bdist_wheel

Usage

Initialize the API

from funkapi import FunkAPI
api = FunkAPI("*username*", "*password*")

Get a Token (not really necessary to do that manually but I left the option)

token = api.getToken()

Initialize the API with a predefined Token

from funkapi import FunkAPI
api = FunkAPI("", "", token="*token*")

Check the validity of a Token (also not really necessary to do manually)

isValid = api.testToken("*token*")

Get Dashboard Data (includes every piece of data FUNK stores of you)

data = api.getData()

Get Personal Information (email, name, birthday, …)

personalInfo = api.getPersonalInfo()

Get a List of your ordered Products

products = api.getOrderedProducts()

Get the currently active Plan

currentPlan = api.getCurrentPlan()

Order the 1GB Plan

status = api.order1GBPlan()

Order the unlimited Plan

status = api.orderUnlimitedPlan()

Start a Pause

status = api.startPause()

Stop the latest Product (includes stopping a break)

status = api.stopLatestPlan()

Documentation

If you get stuck at some point while trying to use the API, take a look the code. It is fully commented and well-labeled, so that should help you understand what's going on.

Contributing

If you are missing a feature or have new idea, go for it! That is what open-source is for!

Author

Tim-Luca Lagmöller (@lagmoellertim)

Donations / Sponsors

I'm part of the official GitHub Sponsors program where you can support me on a monthly basis.

You can also contribute by buying me a coffee (this is a one-time donation).

Thank you for your support!

License

MIT License

lagmoellertim/freenet-funk-api