Skip to content

README.md

Latest commit

 

History

History
81 lines (57 loc) · 2.7 KB

README.md

File metadata and controls

81 lines (57 loc) · 2.7 KB
Raw

Example Application

This is a demo application using gate-api to show how Gate APIv4 works. Instead of running it, it is recommended to read the source code to get a general idea of how this SDK is used. However, you can modify this code directly to implement your own logic.

Preparation

  1. Clone this project
  2. Run mvn clean install to install the library into local repository

Build

Maven users

sh example/maven-build.sh

Gradle users

sh example/gradle-build.sh

if gradle run output shows "Missing required options", but reports "Task :run FAILED" error, just ignore the error.

Run

READ THIS BEFORE YOU RUN ANYTHING

This application is shown for demo only. It will try to use your input API key and secret to place/cancel orders and transfer collateral in the spot/futures commands. Make sure you know exactly what it does before running it.

Maven users

# run futures demo against TestNet
LOCATION="example/target/gateapi-demo-1.0-SNAPSHOT.jar"
java -jar $LOCATION futures -k <YOUR_TESTNET_API_KEY> -s <YOUR_TESTNET_API_SECRET> -u fx-api-testnet.gateio.ws

# run futures demo against real trading
java -jar $LOCATION futures -k <YOUR_API_KEY> -s <YOUR_API_SECRET>

# run spot demo
java -jar $LOCATION spot -k <YOUR_API_KEY> -s <YOUR_API_SECRET>

# run margin demo
java -jar $LOCATION margin -k <YOUR_API_KEY> -s <YOUR_API_SECRET>

Gradle users

cd example
# run futures demo against TestNet
gradle run --args="futures -k <YOUR_TESTNET_API_KEY> -s <YOUR_TESTNET_API_SECRET> -u fx-api-testnet.gateio.ws"

# run futures demo against real trading
gradle run --args="futures -k <YOUR_API_KEY> -s <YOUR_API_SECRET>"

# run spot demo
gradle run --args="spot -k <YOUR_API_KEY> -s <YOUR_API_SECRET>"

# run margin demo
gradle run --args="margin -k <YOUR_API_KEY> -s <YOUR_API_SECRET>"

The generator binds Maven/Gradle dependencies to the version of the adjacent SDK; its package must first be installed locally (the supplied build scripts do this). Maven and Gradle compile the Java sources actually present in this example folder. Public examples share one Key/Secret initializer. Internal SDK examples refuse this public CLI credential flow; use existing trusted user-ID auth inside your trusted service instead, never a public API key as a user ID.

The margin command is read-only and demonstrates current MarginUni market, capacity, loan and account queries. Legacy P2P Loan/lending endpoints were removed; no substitute financial write is executed automatically. Position lookup errors stop futures writes, cancellation retains its contract filter, and all financial write errors propagate without automatic retries. Inspect history before retrying.