Gate.io API Client

A TypeScript/JavaScript client for the Gate.io API v4, providing a simple and intuitive interface for interacting with the Gate.io cryptocurrency exchange.

Features

• Full TypeScript support with comprehensive type definitions
• Support for all Gate.io Spot API endpoints
• Automatic request signing for authenticated endpoints
• Comprehensive error handling
• Well-documented API methods
• Test coverage for all endpoints

Installation

1npm install gateio-api-client

Usage

1import { GateioClient } from "gateio-api-client";
2
3// Create a client instance
4const client = new GateioClient({
5  apiKey: "your-api-key",
6  apiSecret: "your-api-secret",
7});
8
9// Public API examples
10async function publicApiExamples() {
11  // Get all trading pairs
12  const pairs = await client.getTradingPairs();
13  console.log("Trading pairs:", pairs);
14
15  // Get ticker for a specific pair
16  const ticker = await client.getTicker("BTC_USDT");
17  console.log("BTC/USDT ticker:", ticker);
18
19  // Get order book
20  const orderBook = await client.getOrderBook("BTC_USDT");
21  console.log("Order book:", orderBook);
22}
23
24// Private API examples
25async function privateApiExamples() {
26  // Get account balances
27  const balances = await client.getBalances();
28  console.log("Account balances:", balances);
29
30  // Place a limit order
31  const order = await client.createOrder({
32    currency_pair: "BTC_USDT",
33    side: "buy",
34    amount: "0.001",
35    price: "45000",
36    type: "limit",
37  });
38  console.log("Created order:", order);
39
40  // Get open orders
41  const openOrders = await client.getOpenOrders();
42  console.log("Open orders:", openOrders);
43}
44
45// Stop order examples
46async function stopOrderExamples() {
47  // Create a stop order
48  const stopOrder = await client.createStopOrder({
49    currency_pair: "BTC_USDT",
50    type: "stop",
51    side: "sell",
52    amount: "0.001",
53    stop_price: "44000",
54    price: "43900",
55  });
56  console.log("Created stop order:", stopOrder);
57
58  // Get stop orders
59  const stopOrders = await client.getStopOrders();
60  console.log("Stop orders:", stopOrders);
61}

API Documentation

The client provides access to the following API endpoints:

Public APIs

• getTradingPairs(): Get list of all trading pairs
• getTicker(symbol): Get ticker information for a specific trading pair
• getAllTickers(): Get ticker information for all trading pairs
• getOrderBook(symbol): Get order book for a specific trading pair
• getTrades(symbol): Get recent trades for a specific trading pair
• getCandles(symbol): Get candlestick data for a specific trading pair

Private APIs

• getBalances(): Get all account balances
• getBalance(currency): Get balance for a specific currency
• createOrder(params): Create a new spot order
• cancelOrder(orderId): Cancel an existing spot order
• getOrder(orderId): Get details of a specific order
• getOpenOrders(): Get list of open orders
• getTransactionHistory(): Get deposit or withdrawal history

Stop Order APIs

• createStopOrder(params): Create a new stop order
• getStopOrders(): Get list of stop orders
• getStopOrder(orderId): Get details of a specific stop order
• cancelStopOrder(orderId): Cancel an existing stop order

Error Handling

The client includes comprehensive error handling. All API errors are wrapped in a GateioError class with additional context:

1try {
2  await client.createOrder({
3    // Invalid order parameters
4  });
5} catch (error) {
6  if (error instanceof GateioError) {
7    console.error("API Error:", error.message);
8    console.error("Error Label:", error.label);
9    console.error("Error Data:", error.data);
10  }
11}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.