XChange
XChange is a Java library providing a simple and consistent API for interacting with 30+ Bitcoin exchanges providing a consistent interface for trading and accessing market data.
Important!
The world of Bitcoin changes quickly and XChange is no exception. The best way to stay updated on important announcements is to follow tweets on Xeiam's Twitter page. For the latest bugfixes and features you should use the [snapshot jars] (https://oss.sonatype.org/content/groups/public/com/xeiam/xchange/) or build yourself from the DEVELOP branch. See below for more details about building with Maven. To report bugs and see what issues people are currently working on see the issues page. There are also most likely some open bounties to be had as well.
Description
XChange is a library providing a simple and consistent API for interacting with a diverse set of financial security exchanges, including support for Bitcoin.
A complete list of implemented exchanges, data providers and brokers can be found on our Exchange Support page.
Usage is very simple: Create an Exchange instance, get the appropriate service, and request data.
Example
Exchange bitstamp = ExchangeFactory.INSTANCE.createExchange(BitstampExchange.class.getName());
PollingMarketDataService marketDataService = bitstamp.getPollingMarketDataService();
Ticker ticker = marketDataService.getTicker(CurrencyPair.BTC_USD);
System.out.println(ticker.toString());
All exchange implementations expose the same API, but you can also directly access the raw data.
Now go ahead and study some more examples, download the thing and provide feedback.
Features
- MIT license
- consistent API across all implemented exchanges
- active development
- very minimal 3rd party dependencies
- modular components
- polling and streaming capability
More Info
Project Site: http://xeiam.com/xchange
Example Code: http://xeiam.com/xchange-example-code
Change Log: http://xeiam.com/xchange-change-log
Java Docs: http://xeiam.com/javadocs/xchange/index.html
Wiki
Home: https://github.com/timmolter/XChange/wiki
Design Notes: https://github.com/timmolter/XChange/wiki/Design-Notes
Milestones: https://github.com/timmolter/XChange/wiki/Milestones
Exchange Support: https://github.com/timmolter/XChange/wiki/Exchange-support
New Implementation Best Practices: https://github.com/timmolter/XChange/wiki/New-Implementation-Best-Practices
Installing SSL Certificates into TrustStore: https://github.com/timmolter/XChange/wiki/Installing-SSL-Certificates-into-TrustStore
Getting Started with XChange for Noobies: https://github.com/timmolter/XChange/wiki/Getting-Started-with-XChange-for-Noobies
Continuous Integration
Getting Started
Non-Maven
Download XChange Release Jars: http://search.maven.org/#search%7Cga%7C1%7Cxeiam%20xchange Download XChange Snapshot Jars: https://oss.sonatype.org/content/groups/public/com/xeiam/xchange/
Compile Dependencies
| +- org.java-websocket:Java-WebSocket:jar:1.3.0:compile
| +- org.slf4j:slf4j-api:jar:1.7.7:compile
| \- com.github.mmazi:rescu:jar:1.7.1:compile
| +- com.fasterxml.jackson.core:jackson-databind:jar:2.3.2:compile
| | +- com.fasterxml.jackson.core:jackson-annotations:jar:2.3.0:compile
| | \- com.fasterxml.jackson.core:jackson-core:jar:2.3.2:compile
| +- javax.ws.rs:jsr311-api:jar:1.1.1:compile
| \- com.google.code.findbugs:jsr305:jar:2.0.3:compile
Test Dependencies
+- junit:junit:jar:4.11:test
| \- org.hamcrest:hamcrest-core:jar:1.3:test
\- org.easytesting:fest-assert-core:jar:2.0M10:test
\- org.easytesting:fest-util:jar:1.2.5:test
Other Dependencies for Some Examples
+- ch.qos.logback:logback-classic:jar:1.1.2:runtime
| \- ch.qos.logback:logback-core:jar:1.1.2:runtime
+- com.xeiam.xchart:xchart:jar:2.4.0:compile
| \- org.bouncycastle:bcprov-jdk15on:jar:1.50:compile
| +- org.apache.commons:commons-lang3:jar:3.3.2:compile
\- com.github.nkzawa:socket.io-client:jar:0.2.0:compile
+- com.github.nkzawa:engine.io-client:jar:0.3.0:compile
\- org.json:json:jar:20090211:compile
\- com.pusher:pusher-java-client:jar:0.3.1:compile
\- com.google.code.gson:gson:jar:2.2.2:compile
Maven
The XChange release artifacts are hosted on Maven Central.
Add the following dependencies in your pom.xml file. You will need at least xchange-core. Add the additional dependencies for the exchange modules you are interested in (XYZ shown only for a placeholder). There is example code for all the modules in xchange-examples.
<dependency>
<groupId>com.xeiam.xchange</groupId>
<artifactId>xchange-core</artifactId>
<version>2.1.0</version>
</dependency>
<dependency>
<groupId>com.xeiam.xchange</groupId>
<artifactId>xchange-examples</artifactId>
<version>2.1.0</version>
</dependency>
<dependency>
<groupId>com.xeiam.xchange</groupId>
<artifactId>xchange-XYZ</artifactId>
<version>2.1.0</version>
</dependency>
For snapshots, add the following repository to your pom.xml file.
<repository>
<id>sonatype-oss-snapshot</id>
<snapshots/>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</repository>
The current snapshot version is:
2.2.0-SNAPSHOT
Building with Maven
install in local Maven repo: mvn clean install
create project javadocs: mvn javadoc:aggregate
generate dependency tree: mvn dependency:tree
Bugs
Please report any bugs or submit feature requests to XChange's Github issue tracker.
Contributing
If you'd like to submit a new implementation for another exchange, please take a look at New Implementation Best Practices first, as there are lots of time-saving tips!
For more information such as a contributor list and a list of known projects depending on XChange, visit the Main Project Wiki.
Donations
1MHMpzFxx4fRSaeYGSxhyEcgux7j4Gqwsc
All donations will be used to pay bounties for new features, refactoring, etc. Please consider donating or even posting your own bounties on our Issues Page. Open bounties and bounties paid thus far can be found on Xeiam's bounties page.