Skip to content

Latest commit

 

History

History
 
 

android

README.md

swagger-android-client

Requirements

Building the API client library requires Maven to be installed.

Installation

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

mvn install

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

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-android-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-android-client:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/swagger-android-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import io.swagger.client.api.APIkeyApi;

public class APIkeyApiExample {

    public static void main(String[] args) {
        APIkeyApi apiInstance = new APIkeyApi();
        try {
            Object result = apiInstance.aPIkeyInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APIkeyApi#aPIkeyInfo");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api-testnet.bybit.com

Class Method HTTP request Description
APIkeyApi aPIkeyInfo GET /open-api/api-key Get account api-key information.
CommonApi commonGet GET /v2/public/time Get bybit server time.
ConditionalApi conditionalCancel POST /open-api/stop-order/cancel Cancel conditional order.
ConditionalApi conditionalCancelAll POST /v2/private/stop-order/cancelAll Cancel conditional order.
ConditionalApi conditionalGetOrders GET /open-api/stop-order/list Get my conditional order list.
ConditionalApi conditionalNew POST /open-api/stop-order/create Place a new conditional order.
ConditionalApi conditionalReplace POST /open-api/stop-order/replace Replace conditional order. Only incomplete orders can be modified.
ExecutionApi executionGetTrades GET /v2/private/execution/list Get user’s trade records.
FundingApi fundingGetRate GET /open-api/funding/prev-funding Funding settlement occurs every 8 hours at 00:00 UTC, 08:00 UTC and 16:00 UTC. The current interval's fund fee settlement is based on the previous interval's fund rate. For example, at 16:00, the settlement is based on the fund rate generated at 8:00. The fund rate generated at 16:00 will be used at 0:00 on the next day.
FundingApi fundingPredicted GET /open-api/funding/predicted-funding Get predicted funding rate and funding fee.
FundingApi fundingPredictedRate GET /open-api/funding/prev-funding-rate Get predicted funding rate and funding fee.
KlineApi klineGet GET /v2/public/kline/list Query historical kline.
MarketApi marketOrderbook GET /v2/public/orderBook/L2 Get the orderbook.
MarketApi marketSymbolInfo GET /v2/public/tickers Get the latest information for symbol.
OrderApi orderCancel POST /open-api/order/cancel Get my active order list.
OrderApi orderCancelAll POST /v2/private/order/cancelAll Get my active order list.
OrderApi orderCancelV2 POST /v2/private/order/cancel Get my active order list.
OrderApi orderGetOrders GET /open-api/order/list Get my active order list.
OrderApi orderNew POST /open-api/order/create Place active order
OrderApi orderNewV2 POST /v2/private/order/create Place active order
OrderApi orderQuery GET /v2/private/order Get my active order list.
OrderApi orderReplace POST /open-api/order/replace Replace active order. Only incomplete orders can be modified.
PositionsApi positionsChangeMargin POST /position/change-position-margin Update margin.
PositionsApi positionsMyPosition GET /position/list Get my position list.
PositionsApi positionsMyPositionV2 GET /v2/private/position/list Get my position list.
PositionsApi positionsSaveLeverage POST /user/leverage/save Change user leverage.
PositionsApi positionsTradingStop POST /open-api/position/trading-stop Set Trading-Stop Condition.
PositionsApi positionsUserLeverage GET /user/leverage Get user leverage setting.
SymbolApi symbolGet GET /v2/public/symbols Query Symbols.
WalletApi walletGetRecords GET /open-api/wallet/fund/records Get wallet fund records
WalletApi walletGetRiskLimit GET /open-api/wallet/risk-limit/list Get risk limit.
WalletApi walletSetRiskLimit POST /open-api/wallet/risk-limit Set risk limit
WalletApi walletWithdraw GET /open-api/wallet/withdraw/list Get wallet fund records

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

apiKey

  • Type: API key
  • API key parameter name: api_key
  • Location: URL query string

apiSignature

  • Type: API key
  • API key parameter name: sign
  • Location: URL query string

timestamp

  • Type: API key
  • API key parameter name: timestamp
  • Location: URL query string

Recommendation

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

Author

[email protected]