The Scrapegraphai Java SDK provides convenient access to the Scrapegraphai REST API from applications written in Java.
It is generated with Stainless.
The REST API documentation can be found on scrapegraphai.com. Javadocs are available on javadoc.io.
implementation("com.scrapegraphai.api:scrapegraphai-java:0.0.2")
<dependency>
<groupId>com.scrapegraphai.api</groupId>
<artifactId>scrapegraphai-java</artifactId>
<version>0.0.2</version>
</dependency>
This library requires Java 8 or later.
import com.scrapegraphai.api.client.ScrapegraphaiClient;
import com.scrapegraphai.api.client.okhttp.ScrapegraphaiOkHttpClient;
import com.scrapegraphai.api.models.smartscraper.CompletedSmartscraper;
import com.scrapegraphai.api.models.smartscraper.SmartscraperCreateParams;
// Configures using the `scrapegraphai.apiKey` and `scrapegraphai.baseUrl` system properties
// Or configures using the `SCRAPEGRAPHAI_API_KEY` and `SCRAPEGRAPHAI_BASE_URL` environment variables
ScrapegraphaiClient client = ScrapegraphaiOkHttpClient.fromEnv();
SmartscraperCreateParams params = SmartscraperCreateParams.builder()
.userPrompt("Extract the product name, price, and description")
.build();
CompletedSmartscraper completedSmartscraper = client.smartscraper().create(params);
Configure the client using system properties or environment variables:
import com.scrapegraphai.api.client.ScrapegraphaiClient;
import com.scrapegraphai.api.client.okhttp.ScrapegraphaiOkHttpClient;
// Configures using the `scrapegraphai.apiKey` and `scrapegraphai.baseUrl` system properties
// Or configures using the `SCRAPEGRAPHAI_API_KEY` and `SCRAPEGRAPHAI_BASE_URL` environment variables
ScrapegraphaiClient client = ScrapegraphaiOkHttpClient.fromEnv();
Or manually:
import com.scrapegraphai.api.client.ScrapegraphaiClient;
import com.scrapegraphai.api.client.okhttp.ScrapegraphaiOkHttpClient;
ScrapegraphaiClient client = ScrapegraphaiOkHttpClient.builder()
.apiKey("My API Key")
.build();
Or using a combination of the two approaches:
import com.scrapegraphai.api.client.ScrapegraphaiClient;
import com.scrapegraphai.api.client.okhttp.ScrapegraphaiOkHttpClient;
ScrapegraphaiClient client = ScrapegraphaiOkHttpClient.builder()
// Configures using the `scrapegraphai.apiKey` and `scrapegraphai.baseUrl` system properties
// Or configures using the `SCRAPEGRAPHAI_API_KEY` and `SCRAPEGRAPHAI_BASE_URL` environment variables
.fromEnv()
.apiKey("My API Key")
.build();
See this table for the available options:
Setter | System property | Environment variable | Required | Default value |
---|---|---|---|---|
apiKey |
scrapegraphai.apiKey |
SCRAPEGRAPHAI_API_KEY |
true | - |
baseUrl |
scrapegraphai.baseUrl |
SCRAPEGRAPHAI_BASE_URL |
true | "https://api.scrapegraphai.com/v1" |
System properties take precedence over environment variables.
Tip
Don't create more than one client in the same application. Each client has a connection pool and thread pools, which are more efficient to share between requests.
To temporarily use a modified client configuration, while reusing the same connection and thread pools, call withOptions()
on any client or service:
import com.scrapegraphai.api.client.ScrapegraphaiClient;
ScrapegraphaiClient clientWithOptions = client.withOptions(optionsBuilder -> {
optionsBuilder.baseUrl("https://example.com");
optionsBuilder.maxRetries(42);
});
The withOptions()
method does not affect the original client or service.
To send a request to the Scrapegraphai API, build an instance of some Params
class and pass it to the corresponding client method. When the response is received, it will be deserialized into an instance of a Java class.
For example, client.smartscraper().create(...)
should be called with an instance of SmartscraperCreateParams
, and it will return an instance of CompletedSmartscraper
.
Each class in the SDK has an associated builder or factory method for constructing it.
Each class is immutable once constructed. If the class has an associated builder, then it has a toBuilder()
method, which can be used to convert it back to a builder for making a modified copy.
Because each class is immutable, builder modification will never affect already built class instances.
The default client is synchronous. To switch to asynchronous execution, call the async()
method:
import com.scrapegraphai.api.client.ScrapegraphaiClient;
import com.scrapegraphai.api.client.okhttp.ScrapegraphaiOkHttpClient;
import com.scrapegraphai.api.models.smartscraper.CompletedSmartscraper;
import com.scrapegraphai.api.models.smartscraper.SmartscraperCreateParams;
import java.util.concurrent.CompletableFuture;
// Configures using the `scrapegraphai.apiKey` and `scrapegraphai.baseUrl` system properties
// Or configures using the `SCRAPEGRAPHAI_API_KEY` and `SCRAPEGRAPHAI_BASE_URL` environment variables
ScrapegraphaiClient client = ScrapegraphaiOkHttpClient.fromEnv();
SmartscraperCreateParams params = SmartscraperCreateParams.builder()
.userPrompt("Extract the product name, price, and description")
.build();
CompletableFuture<CompletedSmartscraper> completedSmartscraper = client.async().smartscraper().create(params);
Or create an asynchronous client from the beginning:
import com.scrapegraphai.api.client.ScrapegraphaiClientAsync;
import com.scrapegraphai.api.client.okhttp.ScrapegraphaiOkHttpClientAsync;
import com.scrapegraphai.api.models.smartscraper.CompletedSmartscraper;
import com.scrapegraphai.api.models.smartscraper.SmartscraperCreateParams;
import java.util.concurrent.CompletableFuture;
// Configures using the `scrapegraphai.apiKey` and `scrapegraphai.baseUrl` system properties
// Or configures using the `SCRAPEGRAPHAI_API_KEY` and `SCRAPEGRAPHAI_BASE_URL` environment variables
ScrapegraphaiClientAsync client = ScrapegraphaiOkHttpClientAsync.fromEnv();
SmartscraperCreateParams params = SmartscraperCreateParams.builder()
.userPrompt("Extract the product name, price, and description")
.build();
CompletableFuture<CompletedSmartscraper> completedSmartscraper = client.smartscraper().create(params);
The asynchronous client supports the same options as the synchronous one, except most methods return CompletableFuture
s.
The scrapegraphai-java-example
module contains comprehensive examples demonstrating all SDK features:
Run the basic example:
./gradlew :scrapegraphai-java-example:run
Run specific examples:
# SmartScraper examples
./gradlew :scrapegraphai-java-example:run -Pexample=Smartscraper
# SearchScraper examples
./gradlew :scrapegraphai-java-example:run -Pexample=Searchscraper
# Crawl examples
./gradlew :scrapegraphai-java-example:run -Pexample=Crawl
# Markdownify examples
./gradlew :scrapegraphai-java-example:run -Pexample=Markdownify
# Async examples
./gradlew :scrapegraphai-java-example:run -Pexample=Async
# Schema Generation examples
./gradlew :scrapegraphai-java-example:run -Pexample=SchemaGeneration
# Utility examples (validation, health, credits)
./gradlew :scrapegraphai-java-example:run -Pexample=Utility
Example | Description | Features Demonstrated |
---|---|---|
Main | Basic SmartScraper usage | Simple scraping, error handling |
SmartscraperExample | Comprehensive scraping scenarios | Custom schemas, pagination, JavaScript rendering, headers/cookies |
SearchscraperExample | Web search + scraping | Multi-source data aggregation, product comparison, news aggregation |
CrawlExample | Website crawling | Site exploration, path filtering, progress monitoring |
MarkdownifyExample | HTML to Markdown conversion | Content formatting, documentation generation |
AsyncExample | Asynchronous operations | Non-blocking requests, parallel processing, error handling |
SchemaGenerationExample | Automatic schema creation | Schema analysis, structured data extraction |
UtilityExample | Service utilities | API validation, health checks, credit monitoring, feedback |
import com.scrapegraphai.api.client.ScrapegraphaiClient;
import com.scrapegraphai.api.client.okhttp.ScrapegraphaiOkHttpClient;
import com.scrapegraphai.api.models.smartscraper.CompletedSmartscraper;
import com.scrapegraphai.api.models.smartscraper.SmartscraperCreateParams;
// Initialize client (reads from SCRAPEGRAPHAI_API_KEY environment variable)
ScrapegraphaiClient client = ScrapegraphaiOkHttpClient.fromEnv();
// Create scraping request
SmartscraperCreateParams params = SmartscraperCreateParams.builder()
.userPrompt("Extract the main heading and description")
.websiteUrl("https://example.com")
.build();
// Execute scraping
CompletedSmartscraper result = client.smartscraper().create(params);
System.out.println("Extracted data: " + result.result());
The SDK defines methods that deserialize responses into instances of Java classes. However, these methods don't provide access to the response headers, status code, or the raw response body.
To access this data, prefix any HTTP method call on a client or service with withRawResponse()
:
import com.scrapegraphai.api.core.http.Headers;
import com.scrapegraphai.api.core.http.HttpResponseFor;
import com.scrapegraphai.api.models.smartscraper.CompletedSmartscraper;
import com.scrapegraphai.api.models.smartscraper.SmartscraperCreateParams;
SmartscraperCreateParams params = SmartscraperCreateParams.builder()
.userPrompt("Extract the product name, price, and description")
.build();
HttpResponseFor<CompletedSmartscraper> completedSmartscraper = client.smartscraper().withRawResponse().create(params);
int statusCode = completedSmartscraper.statusCode();
Headers headers = completedSmartscraper.headers();
You can still deserialize the response into an instance of a Java class if needed:
import com.scrapegraphai.api.models.smartscraper.CompletedSmartscraper;
CompletedSmartscraper parsedCompletedSmartscraper = completedSmartscraper.parse();
The SDK throws custom unchecked exception types:
-
ScrapegraphaiServiceException
: Base class for HTTP errors. See this table for which exception subclass is thrown for each HTTP status code:Status Exception 400 BadRequestException
401 UnauthorizedException
403 PermissionDeniedException
404 NotFoundException
422 UnprocessableEntityException
429 RateLimitException
5xx InternalServerException
others UnexpectedStatusCodeException
-
ScrapegraphaiIoException
: I/O networking errors. -
ScrapegraphaiRetryableException
: Generic error indicating a failure that could be retried by the client. -
ScrapegraphaiInvalidDataException
: Failure to interpret successfully parsed data. For example, when accessing a property that's supposed to be required, but the API unexpectedly omitted it from the response. -
ScrapegraphaiException
: Base class for all exceptions. Most errors will result in one of the previously mentioned ones, but completely generic errors may be thrown using the base class.
The SDK uses the standard OkHttp logging interceptor.
Enable logging by setting the SCRAPEGRAPHAI_LOG
environment variable to info
:
$ export SCRAPEGRAPHAI_LOG=info
Or to debug
for more verbose logging:
$ export SCRAPEGRAPHAI_LOG=debug
Although the SDK uses reflection, it is still usable with ProGuard and R8 because scrapegraphai-java-core
is published with a configuration file containing keep rules.
ProGuard and R8 should automatically detect and use the published rules, but you can also manually copy the keep rules if necessary.
The SDK depends on Jackson for JSON serialization/deserialization. It is compatible with version 2.13.4 or higher, but depends on version 2.18.2 by default.
The SDK throws an exception if it detects an incompatible Jackson version at runtime (e.g. if the default version was overridden in your Maven or Gradle config).
If the SDK threw an exception, but you're certain the version is compatible, then disable the version check using the checkJacksonVersionCompatibility
on ScrapegraphaiOkHttpClient
or ScrapegraphaiOkHttpClientAsync
.
Caution
We make no guarantee that the SDK works correctly when the Jackson version check is disabled.
The SDK automatically retries 2 times by default, with a short exponential backoff between requests.
Only the following error types are retried:
- Connection errors (for example, due to a network connectivity problem)
- 408 Request Timeout
- 409 Conflict
- 429 Rate Limit
- 5xx Internal
The API may also explicitly instruct the SDK to retry or not retry a request.
To set a custom number of retries, configure the client using the maxRetries
method:
import com.scrapegraphai.api.client.ScrapegraphaiClient;
import com.scrapegraphai.api.client.okhttp.ScrapegraphaiOkHttpClient;
ScrapegraphaiClient client = ScrapegraphaiOkHttpClient.builder()
.fromEnv()
.maxRetries(4)
.build();
Requests time out after 1 minute by default.
To set a custom timeout, configure the method call using the timeout
method:
import com.scrapegraphai.api.models.smartscraper.CompletedSmartscraper;
CompletedSmartscraper completedSmartscraper = client.smartscraper().create(
params, RequestOptions.builder().timeout(Duration.ofSeconds(30)).build()
);
Or configure the default for all method calls at the client level:
import com.scrapegraphai.api.client.ScrapegraphaiClient;
import com.scrapegraphai.api.client.okhttp.ScrapegraphaiOkHttpClient;
import java.time.Duration;
ScrapegraphaiClient client = ScrapegraphaiOkHttpClient.builder()
.fromEnv()
.timeout(Duration.ofSeconds(30))
.build();
To route requests through a proxy, configure the client using the proxy
method:
import com.scrapegraphai.api.client.ScrapegraphaiClient;
import com.scrapegraphai.api.client.okhttp.ScrapegraphaiOkHttpClient;
import java.net.InetSocketAddress;
import java.net.Proxy;
ScrapegraphaiClient client = ScrapegraphaiOkHttpClient.builder()
.fromEnv()
.proxy(new Proxy(
Proxy.Type.HTTP, new InetSocketAddress(
"https://example.com", 8080
)
))
.build();
Note
Most applications should not call these methods, and instead use the system defaults. The defaults include special optimizations that can be lost if the implementations are modified.
To configure how HTTPS connections are secured, configure the client using the sslSocketFactory
, trustManager
, and hostnameVerifier
methods:
import com.scrapegraphai.api.client.ScrapegraphaiClient;
import com.scrapegraphai.api.client.okhttp.ScrapegraphaiOkHttpClient;
ScrapegraphaiClient client = ScrapegraphaiOkHttpClient.builder()
.fromEnv()
// If `sslSocketFactory` is set, then `trustManager` must be set, and vice versa.
.sslSocketFactory(yourSSLSocketFactory)
.trustManager(yourTrustManager)
.hostnameVerifier(yourHostnameVerifier)
.build();
The SDK sends requests to the production by default. To send requests to a different environment, configure the client like so:
import com.scrapegraphai.api.client.ScrapegraphaiClient;
import com.scrapegraphai.api.client.okhttp.ScrapegraphaiOkHttpClient;
ScrapegraphaiClient client = ScrapegraphaiOkHttpClient.builder()
.fromEnv()
.environment1()
.build();
The SDK consists of three artifacts:
scrapegraphai-java-core
- Contains core SDK logic
- Does not depend on OkHttp
- Exposes
ScrapegraphaiClient
,ScrapegraphaiClientAsync
,ScrapegraphaiClientImpl
, andScrapegraphaiClientAsyncImpl
, all of which can work with any HTTP client
scrapegraphai-java-client-okhttp
- Depends on OkHttp
- Exposes
ScrapegraphaiOkHttpClient
andScrapegraphaiOkHttpClientAsync
, which provide a way to constructScrapegraphaiClientImpl
andScrapegraphaiClientAsyncImpl
, respectively, using OkHttp
scrapegraphai-java
- Depends on and exposes the APIs of both
scrapegraphai-java-core
andscrapegraphai-java-client-okhttp
- Does not have its own logic
- Depends on and exposes the APIs of both
This structure allows replacing the SDK's default HTTP client without pulling in unnecessary dependencies.
Customized OkHttpClient
Tip
Try the available network options before replacing the default client.
To use a customized OkHttpClient
:
- Replace your
scrapegraphai-java
dependency withscrapegraphai-java-core
- Copy
scrapegraphai-java-client-okhttp
'sOkHttpClient
class into your code and customize it - Construct
ScrapegraphaiClientImpl
orScrapegraphaiClientAsyncImpl
, similarly toScrapegraphaiOkHttpClient
orScrapegraphaiOkHttpClientAsync
, using your customized client
To use a completely custom HTTP client:
- Replace your
scrapegraphai-java
dependency withscrapegraphai-java-core
- Write a class that implements the
HttpClient
interface - Construct
ScrapegraphaiClientImpl
orScrapegraphaiClientAsyncImpl
, similarly toScrapegraphaiOkHttpClient
orScrapegraphaiOkHttpClientAsync
, using your new client class
The SDK is typed for convenient usage of the documented API. However, it also supports working with undocumented or not yet supported parts of the API.
To set undocumented parameters, call the putAdditionalHeader
, putAdditionalQueryParam
, or putAdditionalBodyProperty
methods on any Params
class:
import com.scrapegraphai.api.core.JsonValue;
import com.scrapegraphai.api.models.smartscraper.SmartscraperCreateParams;
SmartscraperCreateParams params = SmartscraperCreateParams.builder()
.putAdditionalHeader("Secret-Header", "42")
.putAdditionalQueryParam("secret_query_param", "42")
.putAdditionalBodyProperty("secretProperty", JsonValue.from("42"))
.build();
These can be accessed on the built object later using the _additionalHeaders()
, _additionalQueryParams()
, and _additionalBodyProperties()
methods.
To set undocumented parameters on nested headers, query params, or body classes, call the putAdditionalProperty
method on the nested class:
import com.scrapegraphai.api.core.JsonValue;
import com.scrapegraphai.api.models.crawl.CrawlStartParams;
CrawlStartParams params = CrawlStartParams.builder()
.rules(CrawlStartParams.Rules.builder()
.putAdditionalProperty("secretProperty", JsonValue.from("42"))
.build())
.build();
These properties can be accessed on the nested built object later using the _additionalProperties()
method.
To set a documented parameter or property to an undocumented or not yet supported value, pass a JsonValue
object to its setter:
import com.scrapegraphai.api.core.JsonValue;
import com.scrapegraphai.api.models.smartscraper.SmartscraperCreateParams;
SmartscraperCreateParams params = SmartscraperCreateParams.builder()
.userPrompt(JsonValue.from(42))
.build();
The most straightforward way to create a JsonValue
is using its from(...)
method:
import com.scrapegraphai.api.core.JsonValue;
import java.util.List;
import java.util.Map;
// Create primitive JSON values
JsonValue nullValue = JsonValue.from(null);
JsonValue booleanValue = JsonValue.from(true);
JsonValue numberValue = JsonValue.from(42);
JsonValue stringValue = JsonValue.from("Hello World!");
// Create a JSON array value equivalent to `["Hello", "World"]`
JsonValue arrayValue = JsonValue.from(List.of(
"Hello", "World"
));
// Create a JSON object value equivalent to `{ "a": 1, "b": 2 }`
JsonValue objectValue = JsonValue.from(Map.of(
"a", 1,
"b", 2
));
// Create an arbitrarily nested JSON equivalent to:
// {
// "a": [1, 2],
// "b": [3, 4]
// }
JsonValue complexValue = JsonValue.from(Map.of(
"a", List.of(
1, 2
),
"b", List.of(
3, 4
)
));
Normally a Builder
class's build
method will throw IllegalStateException
if any required parameter or property is unset.
To forcibly omit a required parameter or property, pass JsonMissing
:
import com.scrapegraphai.api.core.JsonMissing;
import com.scrapegraphai.api.models.smartscraper.SmartscraperCreateParams;
SmartscraperCreateParams params = SmartscraperCreateParams.builder()
.userPrompt(JsonMissing.of())
.build();
To access undocumented response properties, call the _additionalProperties()
method:
import com.scrapegraphai.api.core.JsonValue;
import java.util.Map;
Map<String, JsonValue> additionalProperties = client.smartscraper().create(params)._additionalProperties();
JsonValue secretPropertyValue = additionalProperties.get("secretProperty");
String result = secretPropertyValue.accept(new JsonValue.Visitor<>() {
@Override
public String visitNull() {
return "It's null!";
}
@Override
public String visitBoolean(boolean value) {
return "It's a boolean!";
}
@Override
public String visitNumber(Number value) {
return "It's a number!";
}
// Other methods include `visitMissing`, `visitString`, `visitArray`, and `visitObject`
// The default implementation of each unimplemented method delegates to `visitDefault`, which throws by default, but can also be overridden
});
To access a property's raw JSON value, which may be undocumented, call its _
prefixed method:
import com.scrapegraphai.api.core.JsonField;
import java.util.Optional;
JsonField<String> userPrompt = client.smartscraper().create(params)._userPrompt();
if (userPrompt.isMissing()) {
// The property is absent from the JSON response
} else if (userPrompt.isNull()) {
// The property was set to literal null
} else {
// Check if value was provided as a string
// Other methods include `asNumber()`, `asBoolean()`, etc.
Optional<String> jsonString = userPrompt.asString();
// Try to deserialize into a custom type
MyClass myObject = userPrompt.asUnknown().orElseThrow().convert(MyClass.class);
}
In rare cases, the API may return a response that doesn't match the expected type. For example, the SDK may expect a property to contain a String
, but the API could return something else.
By default, the SDK will not throw an exception in this case. It will throw ScrapegraphaiInvalidDataException
only if you directly access the property.
If you would prefer to check that the response is completely well-typed upfront, then either call validate()
:
import com.scrapegraphai.api.models.smartscraper.CompletedSmartscraper;
CompletedSmartscraper completedSmartscraper = client.smartscraper().create(params).validate();
Or configure the method call to validate the response using the responseValidation
method:
import com.scrapegraphai.api.models.smartscraper.CompletedSmartscraper;
CompletedSmartscraper completedSmartscraper = client.smartscraper().create(
params, RequestOptions.builder().responseValidation(true).build()
);
Or configure the default for all method calls at the client level:
import com.scrapegraphai.api.client.ScrapegraphaiClient;
import com.scrapegraphai.api.client.okhttp.ScrapegraphaiOkHttpClient;
ScrapegraphaiClient client = ScrapegraphaiOkHttpClient.builder()
.fromEnv()
.responseValidation(true)
.build();
Java enum
classes are not trivially forwards compatible. Using them in the SDK could cause runtime exceptions if the API is updated to respond with a new enum value.
Using JsonField<T>
enables a few features:
- Allowing usage of undocumented API functionality
- Lazily validating the API response against the expected shape
- Representing absent vs explicitly null values
Why don't you use data
classes?
It is not backwards compatible to add new fields to a data class and we don't want to introduce a breaking change every time we add a field to a class.
Checked exceptions are widely considered a mistake in the Java programming language. In fact, they were omitted from Kotlin for this reason.
Checked exceptions:
- Are verbose to handle
- Encourage error handling at the wrong level of abstraction, where nothing can be done about the error
- Are tedious to propagate due to the function coloring problem
- Don't play well with lambdas (also due to the function coloring problem)
This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:
- Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
- Changes that we do not expect to impact the vast majority of users in practice.
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
We are keen for your feedback; please open an issue with questions, bugs, or suggestions.