Bright-data API

This project is a Java client for the BrightData API, which allows you to access the BrightData API from your Java application without having to deal with the HTTP requests.

How to install locally ?

Requirements

You need to have maven installed on your machine, and make sure you have a JDK 8 installed. Follow this link to install maven: https://maven.apache.org/install.html

How to install the package locally ?

This installation skip the tests, because the tests need a valid API key to run.

mvn clean install -Dmaven.test.skip=true

If you want to run the tests, you need to set the API key in the environment variable:

BRIGHT_DATA_API_KEY: Your API key.
BRIGHT_DATA_ZONE_NAME: The zone name you want to use for the tests.
BRIGHT_DATA_CUSTOMER_ID: The customer id you want to use for the tests.

mvn clean install

How to get the java documentation ?

To generete the site for the java documentation please use the following command:

mvn javadoc:javadoc

How to use ?

Add the dependency in your pom.xml:

<dependency>
    <groupId>net.botlify.brightdata</groupId>
    <artifactId>bright-data-api</artifactId>
    <version>LATEST</version>
</dependency>

Instantiate the BrightDataAPI class with your API key.

String brightDataApiKey = "youApiKey";
BrightDataAPI api = new BrightDataAPI(brightDataApiKey);

If you want more example of usage, you can check the wiki at the following link here.

Additional information about rate limiting

The BrightData API is a REST API is rate limited to 1 request per second per API key. This api includes a rate limiter to avoid reaching the limit, this rate limiter is configured to allow 1 request every 1.5 seconds.