Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 3.21 KB

README.md

File metadata and controls

68 lines (51 loc) · 3.21 KB
Raw

Charles Schwab Java API Client

Java Spring Boot reactive rest client for the Charles Schwab API that covers all endpoints of the Schwab Market Data API and the Accounts and Trading API.

  • Javadocs and Source is included when building the jar or by downloading it as a dependency from Maven.
  • How-To Guide on the Wiki shows specifics on how to use this Java API.
  • Simple Client Example - Simple Spring Boot Java and Maven example project.

Required Information

You'll need a Schwab API client ID and client secret to get started. See User Registration for help creating a Schwab developer account and Create an App for help with creating an app on the Schwab Developer Portal.

Build

To build the jar from a commandline, run the following:

git clone https://github.com/gporter0205/schwab-api-client.git
cd schwab-api-client
mvn clean install

You do not need to build the project to use it. The latest release is available on Maven Central, so just include the dependency in your Maven pom or Gradle build file.

Integration Tests

Integration tests do require a client app ID and refresh token to run.

To run unit tests, you will need create the file src/test/resources/application-unittest.yml and fill in the necessary Schwab properties:

schwab-api:
  oauth2:
    userId: <ANY-USERID-LIKE-STRING>
    refreshToken: <VALID-REFRESH-TOKEN>
    refreshExpiration: <yyyy-mm-ddThh:mm:ss.ffffff>
    clientId: <VALID-CLIENT-ID>
    clientSecret: <VALID-CLIENT-SECRET>
    redirect-uri: <VALID-REDIRECT-URI>

POJO otherfields Property

In order to keep additions to the Schwab API from being breaking, and given that some of the documentation is out of sync with the actual responses, an otherfields Map is contained in most model classes where you can get any new or undocumented fields using code similar to the following:

Mono<QuoteResponse> quoteMono = schwabMarketDataApiClient
        .fetchQuoteToMono("msft");
quoteMono
        .map(quoteResponse -> (String) quoteResponse.getOtherFields().get("someField"))
        .subscribe(System.out::println);

Error Handling

If a Refresh Token is invalid or expired or a 401 error is returned from an API call, a RefreshTokenException is thrown. This is the trigger that should start whatever your flow is to retrieve a refresh token.

Certain fetch methods throw custom exceptions in specific situations. For example, fetchQuote will throw a SymbolNotFoundException if (obviously) the symbol is not valid and the API can't return a quote. See the JavaDocs for specific exception info.

Logging

The API uses the Lombok @Slf4j annotation to instantiate a log object.

TODO

  • Add the Schwab streamer API