fritzbox-rest-api

This is a project that aims to provide fritzbox data as rest api.

Note: The REST api of fritzbox is not documented. So this library could lack some features!

Requirements

• JDK 11 or above

• Fritz!OS 7.20 or above

Current features

• get internet information
  • ipv4 (+ status)
  • ipv6 (+ status)
  • provider name
  • upstream bits (+ medium)
  • downstream bits (+ medium)
• force reconnect (get/request new ip address)
• get information about fritz os
  • current version
  • date of last update
  • date of last automatic availability check
• get log events

Please submit requested features as new issue!

Usage

public class TestLaunch {

    public static void main(String[] args) {
        FritzBox fritzBox = new FritzBox(
                "fritz.box",
                "your_username",
                "your_password"
        );

        // Log into your fritzbox
        fritzBox.login();

        // Get the current information about the internet connections.
        InternetInfo internetInfo = fritzBox.getInternetInfo().get(0);
        System.out.println(internetInfo.isConnected());
        System.out.println(internetInfo.isIpv4Connected());
        System.out.println(internetInfo.isIpv4Connected());
        System.out.println(internetInfo.getIpv6());
        System.out.println(internetInfo.isIpv6Connected());
        System.out.println(internetInfo.getProviderName());
        System.out.println(internetInfo.getUpstreamBits());
        System.out.println(internetInfo.getMediumUpstreamBits());
        System.out.println(internetInfo.getDownstreamBits());
        System.out.println(internetInfo.getMediumDownstreamBits());

        // Force a reconnect to get/request a new ip address
        fritzBox.reconnect();

        // Request the information of the current fritz os
        FritzOS fritzOS = fritzBox.getFritzOS();
        System.out.println(fritzOS.getVersion());
        System.out.println(fritzOS.getDateOfLastUpdate());
        System.out.println(fritzOS.getDateOfLastAutomaticCheck());

        // Request the log event entries
        List<LogEntry> logEntryList = fritzbox.getLogEvents();
        LogEntry logEntry = logEntryList.get(0);
        System.out.println(logEntry.getHelpLink());
        System.out.println(logEntry.getTime());
        System.out.println(logEntry.getDate());
        System.out.println(logEntry.getGroup());
        System.out.println(logEntry.getId());
        System.out.println(logEntry.getMessage());
        System.out.println(logEntry.getGroup());
        System.out.println(logEntry.getNoHelp());
    }
}

Maven / Gradle

fritzbox-rest-api is deployed at the maven central repository.

Maven:

<dependency>
    <groupId>eu.koboo</groupId>
    <artifactId>fritzbox-rest-api</artifactId>
    <version>1.0.1</version>
</dependency>

Gradle:

implementation 'eu.koboo:fritzbox-rest-api:1.0.1'

Credits

• Basic structure of fritzbox api
• MD5 javascript hashing