@coinset/gate.io v1.0.0-beta.1

@coinset/gate.io

Universal gate.io API client

:children_crossing: This is not official

Public API

A request for an entry point that does not require authentication.

fetchCurrencies

List all currencies' details.Docs

example

import { fetchCurrencies } from "https://deno.land/x/gate_io@$VERSION/mod.ts";
await fetchCurrencies();

returns

type CurrenciesResponse = {
  currency: string;
  delisted: boolean;
  withdraw_disabled: boolean;
  withdraw_delayed: boolean;
  deposit_disabled: boolean;
  trade_disabled: boolean;
}[];

fetchCurrency

Get details of a specific currency.Docs

example

import { fetchCurrency } from "https://deno.land/x/gate_io@$VERSION/mod.ts";
await fetchCurrency("GT");

returns

type CurrencyResponse = {
  currency: string;
  delisted: boolean;
  withdraw_disabled: boolean;
  withdraw_delayed: boolean;
  deposit_disabled: boolean;
  trade_disabled: boolean;
}[];

fetchPairs

List all currency pairs supported.Docs

example

import { fetchPairs } from "https://deno.land/x/gate_io@$VERSION/mod.ts";
await fetchPairs();

returns

type PairsResponse = {
  id: `${string}_${string}`;
  base: string;
  quote: string;
  fee: number;
  min_base_amount?: number | undefined;
  min_quote_amount?: number | undefined;
  amount_precision: number;
  precision: number;
  trade_status: "tradable" | "untradable" | "sellable";
  sell_start: number;
  buy_start: number;
}[];

fetchPair

Get details of a specific order.Docs

example

import { fetchPair } from "https://deno.land/x/gate_io@$VERSION/mod.ts";
await fetchPair("BTC_USD");

parameters

returns

type PairResponse = {
  id: `${string}_${string}`;
  base: string;
  quote: string;
  fee: number;
  min_base_amount?: number | undefined;
  min_quote_amount?: number | undefined;
  amount_precision: number;
  precision: number;
  trade_status: "tradable" | "untradable" | "sellable";
  sell_start: number;
  buy_start: number;
};

fetchTicker

Retrieve ticker information.Docs

example

import { fetchTicker } from "https://deno.land/x/gate_io@$VERSION/mod.ts";
await fetchTicker("BTC_USD");

parameters

returns

type TickerResponse = {
  currency_pair: `${string}_${string}`;
  last: number;
  lowest_ask: number;
  highest_bid: number;
  change_percentage: number;
  base_volume: number;
  quote_volume: number;
  high_24h: number;
  low_24h: number;
};

fetchTickers

Retrieve tickers information.Docs

example

import { fetchTickers } from "https://deno.land/x/gate_io@$VERSION/mod.ts";
await fetchTicker();

returns

type TickerResponse = {
  currency_pair: `${string}_${string}`;
  last: number;
  lowest_ask: number;
  highest_bid: number;
  change_percentage: number;
  base_volume: number;
  quote_volume: number;
  high_24h: number;
  low_24h: number;
  etf_net_value?: number | undefined;
  etf_pre_net_value?: number | undefined;
  etf_pre_timestamp?: number | undefined;
  etf_leverage?: number | undefined;
}[];

fetchOrderBook

Retrieve order book.Docs

example

import { fetchOrderBook } from "https://deno.land/x/gate_io@$VERSION/mod.ts";
await fetchOrderBook("BTC_USD");

parameters

type OrderBookOptions = {
  interval: number;
  limit: number;
  with_id: boolean;
};

returns

type OrderBookResponse = {
  id?: number | undefined;
  current: number;
  update: number;
  asks: [number, number][];
  bids: [number, number][];
};

fetchTrades

Retrieve market trades.Docs

example

import { fetchOrderBook } from "https://deno.land/x/gate_io@$VERSION/mod.ts";
await fetchOrderBook("BTC_USD");

parameters

type TradesOptions = Partial<{
  limit: number;
  lastId: string;
  reverse: boolean;
  from: number;
  to: number;
  page: number;
}>;

returns

type TradesResponse = {
  id: string;
  create_time: number;
  create_time_ms: number;
  order_id?: string | undefined;
  side: "buy" | "sell";
  role?: "maker" | "taker" | undefined;
  amount: number;
  price: number;
  fee?: number | undefined;
  fee_currency?: string | undefined;
  point_fee?: number | undefined;
  gt_fee?: number | undefined;
}[];

fetchCandlesticks

Market candlesticks.Docs

example

import { fetchCandlesticks } from "https://deno.land/x/gate_io@$VERSION/mod.ts";
await fetchCandlesticks("BTC_USD");

parameters

type CandlestickOptions = Partial<{
  limit: number;
  interval:
    | "10s"
    | "1m"
    | "5m"
    | "15m"
    | "30m"
    | "1h"
    | "4h"
    | "8h"
    | "1d"
    | "7d";
  from: number;
  to: number;
}>;

returns

type CandlesticksResponse = {
  timestamp: number;
  volume: number;
  open: number;
  high: number;
  low: number;
  close: number;
}[];