Skip to content

Latest commit

 

History

History
148 lines (119 loc) · 5.62 KB

README.md

File metadata and controls

148 lines (119 loc) · 5.62 KB
Raw

XChange

A Financial Exchange Library for Java

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

// Use the factory to get the version 1 MtGox exchange API using default settings
Exchange mtGox = ExchangeFactory.INSTANCE.createExchange("com.xeiam.xchange.mtgox.v1.MtGoxExchange");

// Interested in the public polling market data feed (no authentication)
PollingMarketDataService marketDataService = mtGox.getPollingMarketDataService();

// Get the latest ticker data showing BTC to USD
Ticker ticker = marketDataService.getTicker(Currencies.BTC, Currencies.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.jsp
Example Code: http://xeiam.com/xchange_examplecode.jsp
Change Log: http://xeiam.com/xchange_changelog.jsp
Java Docs: http://xeiam.com/xchange/javadoc/index.html
Sonar Code Quality: http://sonar.xeiam.com/
Jenkins CI: http://ci.xeiam.com/

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

Getting Started

XChange is semantically versioned: http://semver.org

Non-Maven

Download XChange Jars: http://xeiam.com/xchange.jsp

Compile Dependencies

+- org.slf4j:slf4j-api:jar:1.7.2:compile
+- org.codehaus.jackson:jackson-mapper-asl:jar:1.9.11:compile
|  \- org.codehaus.jackson:jackson-core-asl:jar:1.9.11:compile
+- org.joda:joda-money:jar:0.8:compile
+- javax.ws.rs:jsr311-api:jar:1.1.1:compile

Test Dependencies

\- junit:junit:jar:4.11:test
    \- org.hamcrest:hamcrest-core:jar:1.3:test

Other Dependencies for Some Examples

+- ch.qos.logback:logback-classic:jar:1.0.9:compile
|  \- ch.qos.logback:logback-core:jar:1.0.9:compile
+- com.xeiam.xchart:xchart:jar:1.3.1:compile

Maven

The XChange release artifacts are hosted on Maven Central.

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>

Add the following dependencies in your pom.xml file. You will need at least xchange-core. Add the additional dependencies for the exchange implementations you are interested in. There is example code for all the implementations in xchange-examples.

<dependency>
  <groupId>com.xeiam.xchange</groupId>
  <artifactId>xchange-core</artifactId>
  <version>1.4.0</version>
</dependency>
<dependency>
  <groupId>com.xeiam.xchange</groupId>
  <artifactId>xchange-examples</artifactId>
  <version>1.4.0</version>
</dependency>
<dependency>
  <groupId>com.xeiam.xchange</groupId>
  <artifactId>xchange-mtgox</artifactId>
  <version>1.4.0</version>
</dependency>
<dependency>
  <groupId>com.xeiam.xchange</groupId>
  <artifactId>xchange-cavirtex</artifactId>
  <version>1.4.0</version>
</dependency>
<dependency>
  <groupId>com.xeiam.xchange</groupId>
  <artifactId>xchange-openexchangerates</artifactId>
  <version>1.4.0</version>
</dependency>
<dependency>
  <groupId>com.xeiam.xchange</groupId>
  <artifactId>xchange-btce</artifactId>
  <version>1.4.0</version>
</dependency>
<dependency>
  <groupId>com.xeiam.xchange</groupId>
  <artifactId>xchange-bitstamp</artifactId>
  <version>1.4.0</version>
</dependency>
    <dependency>
  <groupId>com.xeiam.xchange</groupId>
  <artifactId>xchange-campbx</artifactId>
  <version>1.4.0</version>
</dependency>
<dependency>
  <groupId>com.xeiam.xchange</groupId>
  <artifactId>xchange-bitcoincharts</artifactId>
  <version>1.4.0</version>
</dependency>

Building

mvn clean package
mvn javadoc:aggregate
mvn clean integration-test -P run-integration-tests
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

17dQktcAmU4urXz7tGk2sbuiCqykm3WLs6