loklak/loklak_jlib_api

Name: loklak_jlib_api

Owner: loklak

Description: One Library to find them, One Library to bring them all

Created: 2016-02-01 13:22:43.0

Updated: 2018-05-25 06:02:19.0

Pushed: 2017-07-27 17:27:50.0

Homepage: null

Size: 931

Language: Java

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

loklak_jlib_api

This is the Loklak Java API. One Library to find them, One Library to bring them all.

What is loklak?

Loklak server scrapes data from multiple social networking websites, primarily from Twitter. The scraped data is open and can be accessed by anyone without the need of an API key!!! For more please visit http://loklak.org.

What can I do with it?

You can anonymously use the data provided by Loklak server using this library. Currently it supports the following API endpoints:

• search
• suggest
• peers
• hello
• crawler
• status
• user
• apps
• push

Dependencies

It depends on joda and json libraries which are included in android by default. If you want to use this library in an android project, you therefore have zero dependencies. If you want to use this library in any other java project, just include the jar files in the lib folder.

How to build the library

After successful build using `maven, jar file can be found in ``target``` folder. Building and testing in command line and different IDEs:

• Using command line:

  n clean package # to build
  n clean compile test # to run unit-test
  

• In eclipse:

  • Right click on Project name in package explorer > Run as > Maven Build … > Write `clean package` in goals. Use the created run configuration to generate the jar file.
  • Right click on Project name > Run as > Maven Test

• In IntelliJ IDEA:

  • View > Tool Windows > Maven Projects > Lifecycle > Select the required lifecycle.

How to use it?

Its as simple as:

ic class LoklakApiUse {

public static void main(String[] argv) {
    String baseUrl = "https://api.loklak.org";
    // API methods are generated by the library.
    LoklakAPI loklakApi = APIGenerator.createApiMethods(LoklakAPI.class, baseUrl);

    // using the hello API endpoint, request url: http://api.loklak.org/api/hello.json
    JSONOBject helloReply = loklakApi.hello(); // use the required API endpoint with parameters
    System.out.println(helloReply.toString());

    // similarly search API endpoint, request url: https://api.loklak.org/api/search.json?q=fossasia
    JSONObject searchReply = loklakApi.search("fossasia");
    System.out.println(searchReply.toString());
}