Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/builtbybit/api-wrapper-codegen-java

A Java API wrapper code-generated from our OpenAPI specification.
https://github.com/builtbybit/api-wrapper-codegen-java

Last synced: 3 months ago
JSON representation

A Java API wrapper code-generated from our OpenAPI specification.

Awesome Lists containing this project

README 

          
# openapi-java-client



BuiltByBit API

- API version: v2

  - Build date: 2026-04-07T04:25:00.633408Z[Etc/UTC]



All operations not tagged 'free' require an active [Ultimate](https://builtbybit.com/account/ultimate) subscription or invite-only permissions.



V2 documentation: https://builtbybit.com/wiki/api-v2/ \\

OAuth2 documentation: https://builtbybit.com/wiki/oauth2/



  For more information, please visit [https://builtbybit.com/ticket](https://builtbybit.com/ticket)



*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*



## Requirements



Building the API client library requires:

1. Java 1.8+

2. Maven (3.8.3+)/Gradle (7.2+)



## Installation



To install the API client library to your local Maven repository, simply execute:



```shell

mvn clean install

```



To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:



```shell

mvn clean deploy

```



Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.



### Maven users



Add this dependency to your project's POM:



```xml



  org.openapitools

  openapi-java-client

  v2

  compile



```



### Gradle users



Add this dependency to your project's build file:



```groovy

  repositories {

    mavenCentral()     // Needed if the 'openapi-java-client' jar has been published to maven central.

    mavenLocal()       // Needed if the 'openapi-java-client' jar has been published to the local maven repo.

  }



  dependencies {

     implementation "org.openapitools:openapi-java-client:v2"

  }

```



### Others



At first generate the JAR by executing:



```shell

mvn clean package

```



Then manually install the following JARs:



* `target/openapi-java-client-v2.jar`

* `target/lib/*.jar`



## Getting Started



Please follow the [installation](#installation) instruction and execute the following Java code:



```java



// Import classes:

import org.openapitools.client.ApiClient;

import org.openapitools.client.ApiException;

import org.openapitools.client.Configuration;

import org.openapitools.client.auth.*;

import org.openapitools.client.models.*;

import org.openapitools.client.api.AnalyticsApi;



public class Example {

  public static void main(String[] args) {

    ApiClient defaultClient = Configuration.getDefaultApiClient();

    defaultClient.setBasePath("https://api.builtbybit.com");

    

    // Configure API key authorization: token

    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");

    token.setApiKey("YOUR API KEY");

    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)

    //token.setApiKeyPrefix("Token");



    AnalyticsApi apiInstance = new AnalyticsApi(defaultClient);

    try {

      GetV2Analytics200Response result = apiInstance.getV2Analytics();

      System.out.println(result);

    } catch (ApiException e) {

      System.err.println("Exception when calling AnalyticsApi#getV2Analytics");

      System.err.println("Status code: " + e.getCode());

      System.err.println("Reason: " + e.getResponseBody());

      System.err.println("Response headers: " + e.getResponseHeaders());

      e.printStackTrace();

    }

  }

}



```



## Documentation for API Endpoints



All URIs are relative to *https://api.builtbybit.com*



Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*AnalyticsApi* | [**getV2Analytics**](docs/AnalyticsApi.md#getV2Analytics) | **GET** /v2/analytics | Fetch a list of analytics definitions

*AnalyticsApi* | [**getV2AnalyticsGraph**](docs/AnalyticsApi.md#getV2AnalyticsGraph) | **GET** /v2/analytics/graph | Fetch analytics graph data

*AnalyticsApi* | [**getV2AnalyticsSingle**](docs/AnalyticsApi.md#getV2AnalyticsSingle) | **GET** /v2/analytics/single | Fetch a single analytics value

*DefaultApi* | [**getV2ResourcesCreatorBatch**](docs/DefaultApi.md#getV2ResourcesCreatorBatch) | **GET** /v2/resources/creator/batch | Fetch a list of your batches edits

*DefaultApi* | [**postV2ResourcesCreatorBatch**](docs/DefaultApi.md#postV2ResourcesCreatorBatch) | **POST** /v2/resources/creator/batch | Submit a new batch edit

*EventsApi* | [**getV2Events**](docs/EventsApi.md#getV2Events) | **GET** /v2/events | Fetch a list of pending events

*EventsApi* | [**postV2EventsComplete**](docs/EventsApi.md#postV2EventsComplete) | **POST** /v2/events/complete | Mark events as complete

*HealthApi* | [**getV2Health**](docs/HealthApi.md#getV2Health) | **GET** /v2/health | Retrieve a health status

*Oauth2Api* | [**getOauth2Token**](docs/Oauth2Api.md#getOauth2Token) | **POST** /oauth2/token | Request an access token using an existing grant

*Oauth2Api* | [**getOauth2TokenRevoke**](docs/Oauth2Api.md#getOauth2TokenRevoke) | **POST** /oauth2/token/revoke | Revoke an existing access or refresh token

*ResourcesBuyerApi* | [**getV2ResourcesBuyerLatest**](docs/ResourcesBuyerApi.md#getV2ResourcesBuyerLatest) | **GET** /v2/resources/buyer/latest | Fetches the latest versions & license information

*ResourcesCreatorApi* | [**getV2ResourcesCreatorAddons**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorAddons) | **GET** /v2/resources/creator/addons | Fetch a list of your resources' addons

*ResourcesCreatorApi* | [**getV2ResourcesCreatorBundles**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorBundles) | **GET** /v2/resources/creator/bundles | Fetch a list of your bundles

*ResourcesCreatorApi* | [**getV2ResourcesCreatorCoupons**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorCoupons) | **GET** /v2/resources/creator/coupons | Fetch a list of your coupons

*ResourcesCreatorApi* | [**getV2ResourcesCreatorLicenses**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorLicenses) | **GET** /v2/resources/creator/licenses | Fetch a list of your resources' licenses

*ResourcesCreatorApi* | [**getV2ResourcesCreatorPurchases**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorPurchases) | **GET** /v2/resources/creator/purchases | Fetch a list of your resources' purchases

*ResourcesCreatorApi* | [**getV2ResourcesCreatorResources**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorResources) | **GET** /v2/resources/creator/resources | Fetch a list of your resources

*ResourcesCreatorApi* | [**getV2ResourcesCreatorReviews**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorReviews) | **GET** /v2/resources/creator/reviews | Fetch a list of your resources' reviews

*ResourcesCreatorApi* | [**getV2ResourcesCreatorSaleEvents**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorSaleEvents) | **GET** /v2/resources/creator/sale-events | Fetch a list of your sale events

*ResourcesCreatorApi* | [**getV2ResourcesCreatorStores**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorStores) | **GET** /v2/resources/creator/stores | Fetch a list of your stores

*ResourcesCreatorApi* | [**getV2ResourcesCreatorUpdates**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorUpdates) | **GET** /v2/resources/creator/updates | Fetch a list of your resource's updates

*ResourcesCreatorApi* | [**getV2ResourcesCreatorVersions**](docs/ResourcesCreatorApi.md#getV2ResourcesCreatorVersions) | **GET** /v2/resources/creator/versions | Fetch a list of your resources' versions

*ResourcesCreatorApi* | [**postV2ResourcesCreatorUpdate**](docs/ResourcesCreatorApi.md#postV2ResourcesCreatorUpdate) | **POST** /v2/resources/creator/update | Post a resource update

*ResourcesDiscoveryApi* | [**getResourcesDiscoverCategories**](docs/ResourcesDiscoveryApi.md#getResourcesDiscoverCategories) | **GET** /v2/resources/discover/categories | Fetch a list of categories

*ResourcesDiscoveryApi* | [**getResourcesDiscoverResources**](docs/ResourcesDiscoveryApi.md#getResourcesDiscoverResources) | **GET** /v2/resources/discover/resources | Fetch a list of resources

*ResourcesDiscoveryApi* | [**getV2ResourcesDiscoverCartView**](docs/ResourcesDiscoveryApi.md#getV2ResourcesDiscoverCartView) | **GET** /v2/resources/discover/cart/view | View the user's cart items

*ResourcesDiscoveryApi* | [**getV2ResourcesDiscoverLicenses**](docs/ResourcesDiscoveryApi.md#getV2ResourcesDiscoverLicenses) | **GET** /v2/resources/discover/licenses | Fetch a list of the user's licenses

*ResourcesDiscoveryApi* | [**postV2ResourcesDiscoverCartAdd**](docs/ResourcesDiscoveryApi.md#postV2ResourcesDiscoverCartAdd) | **POST** /v2/resources/discover/cart/add | Add items to a user's cart

*ResourcesDiscoveryApi* | [**postV2ResourcesDiscoverCartCheckout**](docs/ResourcesDiscoveryApi.md#postV2ResourcesDiscoverCartCheckout) | **POST** /v2/resources/discover/cart/checkout | Initiate a checkout of a user's cart

*ResourcesDiscoveryApi* | [**postV2ResourcesDiscoverCartCouponAdd**](docs/ResourcesDiscoveryApi.md#postV2ResourcesDiscoverCartCouponAdd) | **POST** /v2/resources/discover/cart/coupon/add | Add a coupon to the user's cart

*ResourcesDiscoveryApi* | [**postV2ResourcesDiscoverCartCouponRemove**](docs/ResourcesDiscoveryApi.md#postV2ResourcesDiscoverCartCouponRemove) | **POST** /v2/resources/discover/cart/coupon/remove | Remove a coupon from the user's cart

*ResourcesDiscoveryApi* | [**postV2ResourcesDiscoverCartRemove**](docs/ResourcesDiscoveryApi.md#postV2ResourcesDiscoverCartRemove) | **POST** /v2/resources/discover/cart/remove | Remove an item from the user's cart



## Documentation for Models



 - [Addon](docs/Addon.md)

 - [Analytic](docs/Analytic.md)

 - [AnalyticFiltersValue](docs/AnalyticFiltersValue.md)

 - [AnalyticGraphData](docs/AnalyticGraphData.md)

 - [AnalyticGraphDataPeriod](docs/AnalyticGraphDataPeriod.md)

 - [AnalyticGraphDataPoint](docs/AnalyticGraphDataPoint.md)

 - [Batch](docs/Batch.md)

 - [Bundle](docs/Bundle.md)

 - [CartItem](docs/CartItem.md)

 - [CartItemDiscountsInner](docs/CartItemDiscountsInner.md)

 - [CartSummary](docs/CartSummary.md)

 - [Category](docs/Category.md)

 - [Coupon](docs/Coupon.md)

 - [Event](docs/Event.md)

 - [Filter](docs/Filter.md)

 - [FilterChoice](docs/FilterChoice.md)

 - [FilterValue](docs/FilterValue.md)

 - [GetOauth2Token200Response](docs/GetOauth2Token200Response.md)

 - [GetOauth2TokenRevoke200Response](docs/GetOauth2TokenRevoke200Response.md)

 - [GetResourcesDiscoverCategories200Response](docs/GetResourcesDiscoverCategories200Response.md)

 - [GetResourcesDiscoverCategories200ResponseData](docs/GetResourcesDiscoverCategories200ResponseData.md)

 - [GetResourcesDiscoverResources200Response](docs/GetResourcesDiscoverResources200Response.md)

 - [GetResourcesDiscoverResources200ResponseData](docs/GetResourcesDiscoverResources200ResponseData.md)

 - [GetResourcesDiscoverResources4XXResponse](docs/GetResourcesDiscoverResources4XXResponse.md)

 - [GetResourcesDiscoverResources4XXResponseError](docs/GetResourcesDiscoverResources4XXResponseError.md)

 - [GetV2Analytics200Response](docs/GetV2Analytics200Response.md)

 - [GetV2Analytics200ResponseData](docs/GetV2Analytics200ResponseData.md)

 - [GetV2AnalyticsGraph200Response](docs/GetV2AnalyticsGraph200Response.md)

 - [GetV2AnalyticsSingle200Response](docs/GetV2AnalyticsSingle200Response.md)

 - [GetV2AnalyticsSingle200ResponseData](docs/GetV2AnalyticsSingle200ResponseData.md)

 - [GetV2AnalyticsSingle200ResponseDataPeriod](docs/GetV2AnalyticsSingle200ResponseDataPeriod.md)

 - [GetV2Events200Response](docs/GetV2Events200Response.md)

 - [GetV2Events200ResponseData](docs/GetV2Events200ResponseData.md)

 - [GetV2Health200Response](docs/GetV2Health200Response.md)

 - [GetV2ResourcesBuyerLatest200Response](docs/GetV2ResourcesBuyerLatest200Response.md)

 - [GetV2ResourcesBuyerLatest200ResponseData](docs/GetV2ResourcesBuyerLatest200ResponseData.md)

 - [GetV2ResourcesCreatorAddons200Response](docs/GetV2ResourcesCreatorAddons200Response.md)

 - [GetV2ResourcesCreatorAddons200ResponseData](docs/GetV2ResourcesCreatorAddons200ResponseData.md)

 - [GetV2ResourcesCreatorBatch200Response](docs/GetV2ResourcesCreatorBatch200Response.md)

 - [GetV2ResourcesCreatorBatch200ResponseData](docs/GetV2ResourcesCreatorBatch200ResponseData.md)

 - [GetV2ResourcesCreatorBundles200Response](docs/GetV2ResourcesCreatorBundles200Response.md)

 - [GetV2ResourcesCreatorBundles200ResponseData](docs/GetV2ResourcesCreatorBundles200ResponseData.md)

 - [GetV2ResourcesCreatorCoupons200Response](docs/GetV2ResourcesCreatorCoupons200Response.md)

 - [GetV2ResourcesCreatorCoupons200ResponseData](docs/GetV2ResourcesCreatorCoupons200ResponseData.md)

 - [GetV2ResourcesCreatorLicenses200Response](docs/GetV2ResourcesCreatorLicenses200Response.md)

 - [GetV2ResourcesCreatorLicenses200ResponseData](docs/GetV2ResourcesCreatorLicenses200ResponseData.md)

 - [GetV2ResourcesCreatorPurchases200Response](docs/GetV2ResourcesCreatorPurchases200Response.md)

 - [GetV2ResourcesCreatorPurchases200ResponseData](docs/GetV2ResourcesCreatorPurchases200ResponseData.md)

 - [GetV2ResourcesCreatorResources200Response](docs/GetV2ResourcesCreatorResources200Response.md)

 - [GetV2ResourcesCreatorResources200ResponseData](docs/GetV2ResourcesCreatorResources200ResponseData.md)

 - [GetV2ResourcesCreatorReviews200Response](docs/GetV2ResourcesCreatorReviews200Response.md)

 - [GetV2ResourcesCreatorReviews200ResponseData](docs/GetV2ResourcesCreatorReviews200ResponseData.md)

 - [GetV2ResourcesCreatorSaleEvents200Response](docs/GetV2ResourcesCreatorSaleEvents200Response.md)

 - [GetV2ResourcesCreatorSaleEvents200ResponseData](docs/GetV2ResourcesCreatorSaleEvents200ResponseData.md)

 - [GetV2ResourcesCreatorStores200Response](docs/GetV2ResourcesCreatorStores200Response.md)

 - [GetV2ResourcesCreatorStores200ResponseData](docs/GetV2ResourcesCreatorStores200ResponseData.md)

 - [GetV2ResourcesCreatorUpdates200Response](docs/GetV2ResourcesCreatorUpdates200Response.md)

 - [GetV2ResourcesCreatorUpdates200ResponseData](docs/GetV2ResourcesCreatorUpdates200ResponseData.md)

 - [GetV2ResourcesCreatorVersions200Response](docs/GetV2ResourcesCreatorVersions200Response.md)

 - [GetV2ResourcesCreatorVersions200ResponseData](docs/GetV2ResourcesCreatorVersions200ResponseData.md)

 - [GetV2ResourcesDiscoverCartView200Response](docs/GetV2ResourcesDiscoverCartView200Response.md)

 - [GetV2ResourcesDiscoverCartView200ResponseData](docs/GetV2ResourcesDiscoverCartView200ResponseData.md)

 - [GetV2ResourcesDiscoverLicenses200Response](docs/GetV2ResourcesDiscoverLicenses200Response.md)

 - [GetV2ResourcesDiscoverLicenses200ResponseData](docs/GetV2ResourcesDiscoverLicenses200ResponseData.md)

 - [License](docs/License.md)

 - [ListStats](docs/ListStats.md)

 - [Member](docs/Member.md)

 - [PostV2EventsComplete200Response](docs/PostV2EventsComplete200Response.md)

 - [PostV2EventsCompleteRequest](docs/PostV2EventsCompleteRequest.md)

 - [PostV2ResourcesCreatorBatch200Response](docs/PostV2ResourcesCreatorBatch200Response.md)

 - [PostV2ResourcesCreatorBatch200ResponseData](docs/PostV2ResourcesCreatorBatch200ResponseData.md)

 - [PostV2ResourcesCreatorBatchRequest](docs/PostV2ResourcesCreatorBatchRequest.md)

 - [PostV2ResourcesCreatorBatchRequestChangesInner](docs/PostV2ResourcesCreatorBatchRequestChangesInner.md)

 - [PostV2ResourcesCreatorUpdate200Response](docs/PostV2ResourcesCreatorUpdate200Response.md)

 - [PostV2ResourcesCreatorUpdate200ResponseData](docs/PostV2ResourcesCreatorUpdate200ResponseData.md)

 - [PostV2ResourcesCreatorUpdateRequest](docs/PostV2ResourcesCreatorUpdateRequest.md)

 - [PostV2ResourcesCreatorUpdateRequestFile](docs/PostV2ResourcesCreatorUpdateRequestFile.md)

 - [PostV2ResourcesCreatorUpdateRequestUpdate](docs/PostV2ResourcesCreatorUpdateRequestUpdate.md)

 - [PostV2ResourcesDiscoverCartAdd2XXResponse](docs/PostV2ResourcesDiscoverCartAdd2XXResponse.md)

 - [PostV2ResourcesDiscoverCartAddRequest](docs/PostV2ResourcesDiscoverCartAddRequest.md)

 - [PostV2ResourcesDiscoverCartCheckout200Response](docs/PostV2ResourcesDiscoverCartCheckout200Response.md)

 - [PostV2ResourcesDiscoverCartCheckout200ResponseData](docs/PostV2ResourcesDiscoverCartCheckout200ResponseData.md)

 - [PostV2ResourcesDiscoverCartCouponAdd200Response](docs/PostV2ResourcesDiscoverCartCouponAdd200Response.md)

 - [PostV2ResourcesDiscoverCartCouponAddRequest](docs/PostV2ResourcesDiscoverCartCouponAddRequest.md)

 - [PostV2ResourcesDiscoverCartCouponRemove200Response](docs/PostV2ResourcesDiscoverCartCouponRemove200Response.md)

 - [PostV2ResourcesDiscoverCartCouponRemoveRequest](docs/PostV2ResourcesDiscoverCartCouponRemoveRequest.md)

 - [PostV2ResourcesDiscoverCartRemove200Response](docs/PostV2ResourcesDiscoverCartRemove200Response.md)

 - [PostV2ResourcesDiscoverCartRemoveRequest](docs/PostV2ResourcesDiscoverCartRemoveRequest.md)

 - [Price](docs/Price.md)

 - [Purchase](docs/Purchase.md)

 - [Resource](docs/Resource.md)

 - [Review](docs/Review.md)

 - [RichText](docs/RichText.md)

 - [SaleEvent](docs/SaleEvent.md)

 - [SaleEventEntry](docs/SaleEventEntry.md)

 - [Store](docs/Store.md)

 - [Update](docs/Update.md)

 - [Version](docs/Version.md)





## Documentation for Authorization



Authentication schemes defined for the API:



### token



- **Type**: API key

- **API key parameter name**: Authorization

- **Location**: HTTP header





### oauth2



- **Type**: OAuth

- **Flow**: accessCode

- **Authorization URL**: https://builtbybit.com/account/external/authorize

- **Scopes**: N/A



## Recommendation



It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.



## Author