Git Product home page Git Product logo

freenet-funk-api's Introduction

Freenet FUNK API

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
  • pip

Installation

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

cd freenet-funk-api

python3 setup.py install

Build

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

cd freenet-funk-api

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)

Donate

You can also contribute by buying me a coffee.

License

MIT License

Copyright © 2019-present, Tim-Luca Lagmöller

Have fun 🎉

freenet-funk-api's People

Contributors

flobeier avatar kekskurse avatar njannasch avatar

Watchers

 avatar

Forkers

linecomparison

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.