An API Wrapper for Steem written in Java
Clone or download
Latest commit 6271b36 Sep 27, 2018

README.md

SteemJ Logo

This project allows you to easily access data stored in the Steem blockchain. The project has been initialized by dez1337 on steemit.com.

The latest 0.4.x STABLE can be obtained via jitpack.io:

Example below is for latest 0.4.x. Visit https://jitpack.io/#marvin-we/steem-java-api-wrapper/0.4.6-20180926-01PRE/steemj-core to get a list of available builds.

Gradle

	allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}
    dependencies {
	        compile 'com.github.marvin-we.steem-java-api-wrapper:steemj-core:0.4.x-SNAPSHOT'
	}

Maven

File: pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>
    ...
	<dependency>
	    <groupId>com.github.marvin-we.steem-java-api-wrapper</groupId>
	    <artifactId>steemj-core</artifactId>
	    <version>0.4.x-SNAPSHOT</version>
	</dependency>

Full Documentation

  • Please have a look at the Wiki for full documentation, examples, operational details and other information.
  • Or have a look at the JavaDoc.

Communication

Contributors

  • philip-healy took care of the "simplified operations".
  • ray66rus is testing SteemJ for Android and provided a lot of improvements.
  • inertia provided a bunch of unit tests to this project.
  • An article from Kyle has been used to improve the documentation of the methods.
  • The guide from xeroc shows how to create and sign transactions.

Binaries

SteemJ binaries are pushed into the maven central repository and can be integrated with a bunch of build management tools like Maven.

Please have a look at the Wiki to find examples for Maven, Ivy, Gradle and others.

How to build the project

The project requires Maven and Java to be installed on your machine. It can be build with the default maven command:

mvn clean package

The resulting JAR can be found in the target directory as usual. Please notice that some integration tests require different private keys. Please provide them as -D parameter or use the properties file ( src/test/resources/accountDetailsUsedDuringTests.properties ) to define them. If you do not want to execute tests at all add "-Dmaven.test.skip" to the mvn call which skips the test execution during the build.

Bugs and Feedback

For bugs or feature requests please create a GitHub Issue.

For general discussions or questions you can also:

Example

The sample module of the SteemJ project provides showcases for the most common acitivies and operations users want to perform.

Beside that you can find a lot of snippets and examples in the different Wiki sections.