Skip to content
Factern Java Client
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


For more information, please visit


Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle


To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:


Gradle users

Add this dependency to your project's build file:

compile "com.factern:factern-java-client:1.0.58"


At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/factern-java-client-1.0.SNAPSHOT.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.factern.*;
import com.factern.auth.*;
import com.factern.model.*;
import com.factern.api.FactsApi;

import java.util.*;

public class FactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        FactsApi apiInstance = new FactsApi();
        String login = "login_example"; // String | 
        String representing = "representing_example"; // String | 
        CreateMemberRequest createMemberRequest = new CreateMemberRequest(); // CreateMemberRequest | 
        try {
            CreateMemberResponse result = apiInstance.addMember(login, representing, createMemberRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling FactsApi#addMember");

Documentation for API Endpoints

All URIs are relative to

Class Method HTTP request Description
FactsApi addMember POST /createmember Create Member
FactsApi bid POST /createbid Create Bid
FactsApi createAlias POST /createalias Create Alias
FactsApi createApplication POST /createapplication Create Application
FactsApi createDomain POST /createdomain Create Domain
FactsApi createEntity POST /createentity Create Entity
FactsApi createField POST /createfield Create Field
FactsApi createFilter POST /createfilter Create Filter
FactsApi createGroup POST /creategroup Create Group
FactsApi createInformation POST /createinformation Create Information
FactsApi createInterface POST /createinterface Create Interface
FactsApi createLabelList POST /createlabellist Create Label List
FactsApi createLogin POST /createlogin Create Login
FactsApi createMirror POST /createmirror Create Mirror
FactsApi createPrice POST /createprice Create Price
FactsApi createScope POST /createscope Create Scope
FactsApi createStatement POST /createstatement Create Statement
FactsApi createTemplate POST /createtemplate Create Template
FactsApi delete POST /delete Deleting
FactsApi deleteNode POST /deletenode Delete Node
FactsApi describe POST /describe Describe
FactsApi history POST /history History
FactsApi label POST /label Label a Node
FactsApi obliterate POST /obliterate Obliterating Information Nodes
FactsApi permission POST /permission Create Permission
FactsApi read POST /read Reading
FactsApi readInformation POST /readinformation Read Information
FactsApi replaceInformation POST /replaceinformation Replace
FactsApi requestPermission POST /requestpermission Request Permission
FactsApi resetLogin POST /resetlogin Changing Login Password
FactsApi searchAlias POST /searchalias Search For Alias
FactsApi searchEntity POST /searchentity Search For Entity
FactsApi settleAccount POST /settleaccount Settle Account
FactsApi updateApplication POST /updateapplication Resetting Application Secret
FactsApi updateStatus POST /updatestatus Enabling/Disabling Nodes
FactsApi watch POST /watch Create Watch Trigger
FactsApi write POST /write Writing by Template

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:


  • Type: OAuth
  • Flow: accessCode
  • Authorization URL:
  • Scopes:
    • profile: Grants read and write access to administrative information
    • openid: Grants read and write access to administrative information
    • email: Grants read and write access to administrative information
    • phone: Grants write access
    • address: Grants read access


It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.


You can’t perform that action at this time.