FinFusion

A TypeScript library for integrating with multiple financial and cryptocurrency exchange APIs.

Features

• GMOCoin SDK: Complete integration with GMOCoin exchange
  • Public API (tickers, orderbooks, trades, klines)
  • Private API (trading, positions, account management)
  • WebSocket support for real-time data
  • Rate limiting and error handling
  • Full TypeScript support

Installation

npm install finfusion

Quick Start

GMOCoin SDK

Public API

import { GMOCoinClient } from 'finfusion/gmocoin';

const client = new GMOCoinClient();

// Get ticker
const ticker = await client.public.getTicker('BTC_JPY');
console.log(ticker);

// Get orderbook
const orderbook = await client.public.getOrderbook('BTC_JPY');
console.log(orderbook);

Private API

import { GMOCoinClient } from 'finfusion/gmocoin';

const client = new GMOCoinClient({
  apiKey: 'YOUR_API_KEY',
  apiSecret: 'YOUR_API_SECRET',
});

// Get account balance
const assets = await client.private.getAssets();
console.log(assets);

// Place an order
const order = await client.private.createOrder({
  symbol: 'BTC_JPY',
  side: 'BUY',
  executionType: 'LIMIT',
  size: '0.001',
  price: '5000000',
});

WebSocket

const ws = client.createPublicWebSocket();

ws.on('ticker', (ticker) => {
  console.log('Ticker update:', ticker);
});

await ws.connect();
ws.subscribeTicker('BTC_JPY');

API Documentation

GMOCoinClient

Main client class for interacting with GMOCoin API.

Constructor Options

• apiKey (string, optional): API key for private endpoints
• apiSecret (string, optional): API secret for private endpoints
• baseURL (string, optional): Base URL for API requests
• timeout (number, optional): Request timeout in milliseconds
• tier (1 | 2, optional): Rate limit tier based on trading volume
• enableRateLimiter (boolean, optional): Enable/disable rate limiting

Public API Methods

• getStatus(): Get exchange status
• getTicker(symbol?): Get ticker information
• getOrderbook(symbol): Get orderbook/depth
• getTrades(symbol): Get recent trades
• getKlines(params): Get kline/candlestick data
• getSymbols(): Get trading rules for all symbols

Private API Methods

Account:

• getMargin(): Get margin information
• getAssets(): Get asset balances
• getTradingVolume(): Get trading volume and fee tier

Orders:

• createOrder(params): Create new order
• cancelOrder(orderId): Cancel order
• getActiveOrders(params?): Get active orders

Positions:

• getOpenPositions(params?): Get open positions
• getPositionSummary(params?): Get position summary
• changeLosscutPrice(params): Change losscut price
• closePosition(params): Close specific position

Executions:

• getExecutions(params?): Get execution history
• getLatestExecutions(params): Get latest executions

Development

# Install dependencies
npm install

# Run tests
npm test

# Build
npm run build

# Format code
npm run format

# Lint
npm run lint

Examples

See the examples/ directory for more detailed usage examples.

License

MIT