sudakatux / api-v1-client-java Goto Github PK

#Blockchain API library (Java, v1)

An official Java library for interacting with the Blockchain.info API (Java 1.6 required).

###Getting started

If you prefer building from source:

$ git clone https://github.com/blockchain/api-v1-client-java
$ cd api-v1-client-java
$ mvn install

We also provide a snapshot Maven repository for users who prefer managing dependencies that way.

Add the following repository to your pom.xml:

    <repository>
        <id>api-v1-client-java-mvn-repo</id>
        <url>https://raw.githubusercontent.com/blockchain/api-v1-client-java/mvn-repo/</url>
        <snapshots>
            <enabled>true</enabled>
            <updatePolicy>always</updatePolicy>
        </snapshots>
    </repository>

Add the following dependency to your pom.xml:

  <dependency>
  	<groupId>info.blockchain</groupId>
  	<artifactId>api</artifactId>
  	<version>1.0.1</version> <!-- for the latest version see the latest project tag -->
  </dependency>

Note that the above procedures require Maven. If you do not wish to use Maven, please compile the source manually.

The library consists of the following packages:

• info.blockchain.api.blockexplorer (docs) (api/blockchain_api)
• info.blockchain.api.createwallet (docs) (api/create_wallet)
• info.blockchain.api.exchangerates (docs) (api/exchange_rates_api)
• info.blockchain.api.receive (docs) (api/api_receive)
• info.blockchain.api.statistics (docs) (api/charts_api)
• info.blockchain.api.wallet (docs) (api/blockchain_wallet_api)

###Error handling

All methods may throw exceptions caused by incorrectly passed parameters or other problems. If a call is rejected server-side, the APIException exception will be thrpwn. In case of a network error, the IOException exception will be thrown.

###Request limits and API keys

In order to prevent abuse some API methods require an API key approved with some basic contact information and a description of its intended use. Please request an API key here.

The same API key can be used to bypass the request limiter.