TradePatio uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy.

Module 'trade'

Module 'trade'

Содержит функции необходимые для торговли на биржах.

Функции:

create_limit_fok(ex: EX_ID, pair_source: string, quantity: number, price: number,is_buy: boolean) return: order_id: string(может пробросить ошибку)

Создаёт на бирже ордер по политике FOK.

  • ex - id биржи. Используй константу EX_ID
  • pair_source  - краткое биржевое имя пары.
  • quantity  - объём ордера.
  • price  - цена ордера.
  • is_buy  - сторона ордера.
  • order_id - id ордера. Используя его можно получить информацию по  ордеру или закрыть его.
  • Пробросит ошибку если ордер с заданными параметрами невозможен на данной бирже.
create_limit_gtc(ex: EX_ID, pair_source: string, quantity: number, price: number,is_buy: boolean) return: order_id: string(может пробросить ошибку)

Создаёт на бирже ордер по политике GTC.

  • ex - id биржи. Используй константу EX_ID
  • pair_source  - краткое биржевое имя пары.
  • quantity  - объём ордера.
  • price  - цена ордера.
  • is_buy  - сторона ордера.
  • order_id - id ордера.
  • Пробросит ошибку если ордер с заданными параметрами невозможен на данной бирже.
close_limit_gtc(ex:EX_ID, order_id: string, skip_check?: boolean) return: quantity_done: number(может пробросить ошибку)

Закрывает на бирже ордер.

  • ex - id биржи. Используй константу EX_ID
  • order_id  - id ордера .
  • skip_check  - если false: ордер не будет закрыт, если он уже частично выполнен.
  • quantity_done  - выполненный объём ордера.
  • Пробросит ошибку если закрытие ордера невозможно.
get_order(ex: EX_ID, order_id: string) return: order: Order(может пробросить ошибку)

Получить данные ордера.

  • ex - id биржи. Используй константу EX_ID
  • order_id  - id ордера.
  • order  - Lua объект содержащий информацию о ордере. Смотри модель Order.
get_orders(ex: EX_ID) return: orders: []Order(может пробросить ошибку)

Получить данные всех ордеров на бирже.

  • ex - id биржи. Используй константу EX_ID
  • orders  - массив с Lua объектами. Смотри модель Order.
get_orders_by_pair_source(ex: EX_ID, pair_source: string, status: ORDER_STATUS) return: orders: []Order(может пробросить ошибку)

Получить данные всех ордеров на бирже по определённой паре

  • ex - id биржи. Используй константу EX_ID
  • pair_source  - краткое биржевое имя пары.
  • status - статус ордера. Используй константу ORDER_STATUS
  • orders  - массив с Lua объектами. Смотри модель Order.
pair_source_to_pair(ex: EX_ID, pair_source: string) return: pair: string(может пробросить ошибку)

Переводит краткое имя пары в полное.

  • ex - id биржи. Используй константу EX_ID
  • pair_source  - краткое биржевое имя пары.
  • pair - полное имя пары.
  • Пробросит ошибку если у биржи нет такого  pair_source .
pair_to_pair_source(ex: EX_ID, pair: string) return: pair_source: string(может пробросить ошибку)

Переводит полное имя пары в краткое.

  • ex - id биржи. Используй константу EX_ID
  • pair  -полное имя пары.
  • pair_source - краткое биржевое имя пары.
  • Пробросит ошибку если у биржи нет такой  pair .
currency_to_long(ex: EX_ID, currency: string) return: long: string(может пробросить ошибку)

Переводит краткое имя монеты в полное.

  • ex - id биржи. Используй константу EX_ID
  • currency - краткое биржевое имя монеты.
  • long - полное имя монеты.
  • Пробросит ошибку если у биржи нет такой  currency .
currency_to_long(ex: EX_ID, long: string) return:currency: string(может пробросить ошибку)

Переводит краткое имя монеты в полное.

  • ex - id биржи. Используй константу EX_ID
  • long - полное имя монеты.
  • currency - краткое биржевое имя монеты.
  • Пробросит ошибку если у биржи нет такой  long .
get_balance(ex: EX_ID) return: balance: map[string]: number(может пробросить ошибку)

Получить массив с информацией по балансу на бирже.

  • ex - id биржи. Используй константу EX_ID
  • balance map[currency]: quantity
    • currency - краткое биржевое имя монеты.
    • quantity  - количество монеты.
get_balance_by_currency(ex: EX_ID, currency: string) return: balance: number(может пробросить ошибку)

Получить баланс по определённой монете.

  • ex - id биржи. Используй константу EX_ID
  • currency - краткое биржевое имя монеты.
  • balance -количество монеты.
long_coin_to_btc(ex: EX_ID, long: string, value: number) return: btc: number(может пробросить ошибку)

Узнать соотношение монеты к биткоину.

  • ex - id биржи. Используй константу EX_ID
  • long - полное имя монеты.
  • value - объём монеты.
  • btc - объём в биткоине.
btc_to_long_coin(ex: EX_ID, long: string, btc: number) return: value: number(может пробросить ошибку)

Узнать соотношение биткоина к монете.

  • ex - id биржи. Используй константу EX_ID
  • long - полное имя монеты.
  • btc - объём биткоина.
  • value - объём в монете.
is_allow_withdrawal_by_currency(ex: EX_ID, currency: string) return: is_allow: boolean(может пробросить ошибку)

Узнать возможен ли вывод монеты из биржи.

  • ex - id биржи. Используй константу EX_ID
  • currency - полное имя монеты.
  • is_allow - возможен вывод.
is_allow_deposit_by_currency(ex: EX_ID, currency: string) return: is_allow: boolean(может пробросить ошибку)

Узнать возможен ли ввод монеты на биржу.

  • ex - id биржи. Используй константу EX_ID
  • currency - полное имя монеты.
  • is_allow - возможен ввод.

 

Константы:

EX_ID
map[string - ex_name]:number - ex_id

EX_NAME
map[number - ex_id]:string - ex_name
ORDER_STATUS
{
skip,
work,
done,
close
}

 

Модели:

Order
id: string;
ex_id: EX_ID;
pair_source: string;
is_buy: boolean;
status: ORDER_STATUS;
quantity: number;
price: number;
executed_quantity: number;
total: number;
timestamp_nano: number;