https://github.com/merge-api/merge-java-client
The JVM SDK for accessing various Merge Unified APIs
https://github.com/merge-api/merge-java-client
Last synced: 4 months ago
JSON representation
The JVM SDK for accessing various Merge Unified APIs
- Host: GitHub
- URL: https://github.com/merge-api/merge-java-client
- Owner: merge-api
- License: other
- Created: 2023-05-10T15:29:38.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-16T21:34:41.000Z (5 months ago)
- Last Synced: 2026-01-17T06:38:53.485Z (5 months ago)
- Language: Java
- Size: 61.8 MB
- Stars: 7
- Watchers: 8
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Merge Java Library
[](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fmerge-api%2Fmerge-java-client)
[](https://central.sonatype.com/artifact/dev.merge/merge-java-client)
The Merge Java library provides convenient access to the Merge APIs from Java.
## Documentation
API documentation is available at [here](https://docs.merge.dev/basics/authentication/).
## Installation
### Gradle
Add the dependency in your `build.gradle` file:
```groovy
dependencies {
implementation 'dev.merge:merge-java-client'
}
```
### Maven
Add the dependency in your `pom.xml` file:
```xml
dev.merge
merge-java-client
5.0.1
```
## Instantiation
```java
MergeApiClient mergeClient = MergeApiClient.builder()
.accountToken("ACCOUNT_TOKEN")
.apiKey("API_KEY")
.build();
```
## Request Options
Every endpoint has an overloaded equivalent which takes [RequestOptions](./src/main/java/com/merge/api/core/RequestOptions.java)
that allow you to override the account token and api key.
```java
import com.merge.api.MergeApiClient;
import com.merge.api.resources.ats.types.Candidate;
import com.merge.api.resources.ats.candidates.requests.CandidatesRetrieveRequest;
import com.merge.api.core.RequestOptions;
MergeApiClient mergeClient = MergeApiClient.builder()
.accountToken("ACCOUNT_TOKEN")
.apiKey("API_KEY")
.build();
Candidate candidate = mergeClient.ats().candidates().retrieve(
"",
CandidatesRetrieveRequest.builder()
.includeRemoteData(true)
.build(),
RequestOptions.builder()
.accountToken("OVERRIDE_ACCOUNT_TOKEN")
.build());
```
## Usage
Instantiate and use the client with the following:
```java
package com.example.usage;
import com.merge.api.MergeApiClient;
MergeApiClient client = MergeApiClient
.builder()
.build();
client.ats().accountDetails().retrieve(...);
```
## Environments
This SDK allows you to configure different environments for API requests.
```java
import com.merge.api.MergeApiClient;
import com.merge.api.core.Environment;
MergeApiClient client = MergeApiClient
.builder()
.environment(Environment.Production)
.build();
```
## Base Url
You can set a custom base URL when constructing the client.
```java
import com.merge.api.MergeApiClient;
MergeApiClient client = MergeApiClient
.builder()
.url("https://example.com")
.build();
```
## Exception Handling
When the API returns a non-success status code (4xx or 5xx response), an API exception will be thrown.
```java
import com.merge.api.core.ApiError;
try {
client.ats().accountDetails().retrieve(...);
} catch (ApiError e) {
// Do something with the API exception...
}
```
## Advanced
### Custom Client
This SDK is built to work with any instance of `OkHttpClient`. By default, if no client is provided, the SDK will construct one.
However, you can pass your own client like so:
```java
import com.merge.api.MergeApiClient;
import okhttp3.OkHttpClient;
OkHttpClient customClient = ...;
MergeApiClient client = MergeApiClient
.builder()
.httpClient(customClient)
.build();
```
### Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
retry limit (default: 2).
A request is deemed retryable when any of the following HTTP status codes is returned:
- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
Use the `maxRetries` client option to configure this behavior.
```java
import com.merge.api.MergeApiClient;
MergeApiClient client = MergeApiClient
.builder()
.maxRetries(1)
.build();
```
### Timeouts
The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
```java
import com.merge.api.MergeApiClient;
import com.merge.api.core.RequestOptions;
// Client level
MergeApiClient client = MergeApiClient
.builder()
.timeout(10)
.build();
// Request level
client.ats().accountDetails().retrieve(
...,
RequestOptions
.builder()
.timeout(10)
.build()
);
```
### Custom Headers
The SDK allows you to add custom headers to requests. You can configure headers at the client level or at the request level.
```java
import com.merge.api.MergeApiClient;
import com.merge.api.core.RequestOptions;
// Client level
MergeApiClient client = MergeApiClient
.builder()
.addHeader("X-Custom-Header", "custom-value")
.addHeader("X-Request-Id", "abc-123")
.build();
;
// Request level
client.ats().accountDetails().retrieve(
...,
RequestOptions
.builder()
.addHeader("X-Request-Header", "request-value")
.build()
);
```
## Contributing
While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code,
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
## Reference
A full reference for this library is available [here](https://github.com/merge-api/merge-java-client/blob/HEAD/./reference.md).