gate-api

Gate API v4

• API version: 4.21.4
• SDK version: 6.21.4

Welcome to Gate.io API

APIv4 provides spot, margin and futures trading operations. There are public APIs to retrieve the real-time market statistics, and private APIs which needs authentication to trade on user's behalf.

For more information, please visit https://www.gate.io/page/contacts

Automatically generated by the OpenAPI Generator

Versioning

Trying our best to follow the semantic versioning, while enjoying recent features provided by programming language and libraries, from 4.15.2, one major versioning difference will be introduced:

If extra code rewrite is required when you upgrade the SDK, such as:

• some outdated programming language version support is dropped
• API method signature has breaking changes.

the MAJOR version will be incremented, but the MINOR and PATCH version are still following REST API's instead of resetting to 0, so that you can recognize it has some breaking changes, but still getting the idea of from which REST API version the change is introduced.

For example, the previous REST API and SDK version are both 4.14.0. But if we decide to introduce some breaking changes in SDK along with REST API 4.15.2 upgrade, then the version of next SDK release will be 5.15.2(the MAJOR version is incremented to denote breaking changes, but the MINOR and PATCH version are identical to REST API's instead of resetting them to 0)

If MAJOR version is incremented, make sure you read the release note on Releases page

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven/Gradle

Installation

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

mvn clean install

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

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>io.gate</groupId>
    <artifactId>gate-api</artifactId>
    <version>6.21.4</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.gate:gate-api:6.21.4"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/gate-api-6.21.4.jar
• target/lib/*.jar

Getting Started

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

// Import classes:
import io.gate.gateapi.ApiClient;
import io.gate.gateapi.ApiException;
import io.gate.gateapi.Configuration;
import io.gate.gateapi.GateApiException;
import io.gate.gateapi.models.*;
import io.gate.gateapi.api.DeliveryApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.gateio.ws/api/v4");

        DeliveryApi apiInstance = new DeliveryApi(defaultClient);
        String settle = "usdt"; // String | Settle currency
        try {
            List<DeliveryContract> result = apiInstance.listDeliveryContracts(settle);
            System.out.println(result);
        } catch (GateApiException e) {
            System.err.println(String.format("Gate api exception, label: %s, message: %s", e.getErrorLabel(), e.getMessage()));
            e.printStackTrace();
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliveryApi#listDeliveryContracts");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

For a more complete API usage example, refer to the demo application in example directory

Documentation for API Endpoints

All URIs are relative to https://api.gateio.ws/api/v4

Documentation for Models

• AutoRepaySetting
• BatchOrder
• CancelOrder
• CancelOrderResult
• Contract
• ContractStat
• CrossMarginAccount
• CrossMarginAccountBook
• CrossMarginBalance
• CrossMarginCurrency
• CrossMarginLoan
• CrossMarginRepayRequest
• CrossMarginRepayment
• Currency
• CurrencyPair
• DeliveryContract
• DeliverySettlement
• DepositAddress
• FundingAccount
• FundingBookItem
• FundingRateRecord
• FuturesAccount
• FuturesAccountBook
• FuturesCandlestick
• FuturesInitialOrder
• FuturesLiquidate
• FuturesOrder
• FuturesOrderBook
• FuturesOrderBookItem
• FuturesPriceTrigger
• FuturesPriceTriggeredOrder
• FuturesTicker
• FuturesTrade
• InsuranceRecord
• LedgerRecord
• Loan
• LoanPatch
• LoanRecord
• MarginAccount
• MarginAccountBook
• MarginAccountCurrency
• MarginCurrencyPair
• MultiChainAddressItem
• MyFuturesTrade
• OpenOrders
• Order
• OrderBook
• Position
• PositionClose
• PositionCloseOrder
• RepayRequest
• Repayment
• SpotAccount
• SpotPricePutOrder
• SpotPriceTrigger
• SpotPriceTriggeredOrder
• SubAccountBalance
• SubAccountTransfer
• Ticker
• Trade
• TradeFee
• Transfer
• TriggerOrderResponse
• WithdrawStatus

Documentation for Authorization

Authentication schemes defined for the API:

apiv4

• Type: Gate APIv4

Recommendation

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

Author

support@mail.gate.io