Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/tiagosiebler/gateio-api/llms.txt

Use this file to discover all available pages before exploring further.

The RestClient is the single entry point for every Gate.com REST API. One class covers spot trading, margin borrowing, perpetual and delivery futures, options contracts, cross-exchange (CrossEx) routing, Alpha meme-token trading, OTC conversions, and all wallet/account management operations. Every request is fully typed — parameters and responses are defined in TypeScript interfaces so your IDE can autocomplete field names and flag type errors before you deploy.

​
Installation

Install the SDK from npm and import RestClient in your project: 
npm install gateio-api

import { RestClient } from 'gateio-api';

​
Instantiation

Construct a RestClient by passing your API credentials through RestClientOptions. For public (unauthenticated) endpoints you can omit the credentials entirely. 
import { RestClient } from 'gateio-api';

// Authenticated client — API key and secret are automatically signed on every private request
const client = new RestClient({
  apiKey: process.env.API_KEY,
  apiSecret: process.env.API_SECRET,
});

// Public-only client — no credentials required
const publicClient = new RestClient();
Credentials are read once at construction time. Never hard-code secrets in source code — use environment variables or a secrets manager.

​
Configuration Options

RestClient accepts a RestClientOptions object as its first argument. The most commonly used fields are:
OptionTypeDefaultDescription
apiKeystring—Your Gate.com API key
apiSecretstring—Your Gate.com API secret
baseUrlstringGate productionOverride the API base URL (e.g. for a proxy)
baseUrlKeyGateBaseUrlKey—Select a named base-URL preset built into the SDK
recvWindownumber—Global request-window override in milliseconds
strictParamValidationbooleanfalseThrow on undefined parameters before signing
parseExceptionsbooleantruePost-process Axios errors into structured exceptions
keepAlivebooleanfalseEnable HTTP keep-alive on the underlying Axios agent
customSignMessageFnfunction—Provide a custom HMAC signer (e.g. Node.js createHmac)

​
Authentication

Authentication is handled automatically. When you provide apiKey and apiSecret, the client signs every private request with an HMAC-SHA512 signature before it leaves your machine. You never need to construct sign, timestamp, or KEY headers yourself. 
// This private call is signed automatically — no extra work needed
const account = await client.getFuturesAccount({ settle: 'usdt' });
Public endpoints (market data, tickers, order books) work without credentials: 
const tickers = await client.getSpotTicker({ currency_pair: 'BTC_USDT' });

​
Finding the Right Method

Every REST endpoint in the Gate.com API maps to a dedicated method on RestClient. The SDK ships with a full endpoint-to-function mapping in docs/endpointFunctionList.md. Search that file for an endpoint URL or an HTTP method name to find the corresponding SDK function. 
// Endpoint: GET /futures/{settle}/tickers
// → client.getFuturesTickers({ settle: 'usdt' })

// Endpoint: POST /spot/orders
// → client.submitSpotOrder({ currency_pair: 'BTC_USDT', side: 'buy', ... })

​
Error Handling

The client uses Axios internally. When Gate.com returns a non-2xx status code the SDK throws an Axios error. Wrap calls in try/catch to handle failures gracefully: 
import { RestClient } from 'gateio-api';

const client = new RestClient({ apiKey: '...', apiSecret: '...' });

try {
  const order = await client.submitSpotOrder({
    currency_pair: 'BTC_USDT',
    side: 'buy',
    type: 'limit',
    amount: '0.001',
    price: '60000',
  });
  console.log('Order placed:', order);
} catch (err: any) {
  // err.response.data contains the Gate.com error body
  console.error('Gate API error:', err.response?.data ?? err.message);
}
Always handle errors in production code. Unhandled promise rejections will crash Node.js processes.

​
Market Areas Covered

Spot Trading

Place limit and market orders, query balances, fetch tickers and candles, and use price-triggered orders on Gate.com spot markets.

Margin Trading

Manage isolated and cross margin accounts, borrow and repay loans, and query interest records.

Futures Trading

Trade perpetual and delivery futures contracts, manage positions and leverage, and access funding rates.

Options Trading

List option contracts by expiry, manage option positions and orders, and query settlement history.

CrossEx Trading

Route orders across Binance, OKX, Bybit, Kraken, and Gate from a single unified account.

Alpha & OTC

Trade meme tokens and new listings via Gate Alpha, or execute stablecoin and fiat conversions via OTC.

Wallet & Account

Manage deposits, withdrawals, sub-accounts, cross-account transfers, and unified account settings.

​
Checking Server Latency

The RestClient includes a built-in latency helper that measures round-trip time to Gate’s servers and warns you if your system clock is drifting: 
await client.fetchLatencySummary();
// Logs one-way and round-trip latency, and warns if clock offset > 500 ms
If you see timestamp outside recvWindow errors, run fetchLatencySummary() to check your clock offset. A drift of more than 500 ms will cause authentication failures.

Build docs developers (and LLMs) love

Get started for freeTalk to us