Skip to content

Latest commit

 

History

History
119 lines (77 loc) · 2.69 KB

endpoints.md

File metadata and controls

119 lines (77 loc) · 2.69 KB

⚠️ Disclaimer:

  • API Documentation has yet to come

Account

  • GET /api/v1/accountSummary (Retrieves account balances) ✔️
client.get_account_balances()

Pairs

  • GET /api/v1/pairs (Gets a list of all pairs, min and max amounts.) ✔️
client.get_pairs()

Quote

  • GET /api/v1/pairs (Gets a price quote.) ✔️
client.get_price_quote(pair="BTC/ETH", amount="1.0", side="buy")

Order

  • POST /api/v1/orders (Places an order.) ✔️
client.place_order(pair="BTC/ETH", quantity="1.0", side="buy")
  • POST /api/v1/orders/cancel (Cancels an order.) ✔️
def cancel_order(self, "8037298b-3ba4-41f9-8718-8a7bf87560f6")
  • POST /api/v1/orders/cancel/all (Cancels all orders for a pair) ✔️
def cancel_all_orders(self, "ETH/USDT")
  • POST /api/v1/orders/trigger (Places a trigger order.) ✔️
client.place_trigger_order(pair="BTC/ETH", trigger_type="takeProfit", side="buy", trigger_price="15.0", amount="2.0")
  • POST /api/v1/orders/advanced (Places an advanced order.) ✔️
client.place_advanced_order(pair="BTC/USDT", side="buy", stop_loss_price="18000", tak_profit_price="22000", amount="0.001")
  • POST /api/v1/orders/twap (Places a TWAP order.) ❌
client.place_twap_order(pair="BTC/USDT", side="buy", execution_interval="10", splits="100", quantity="0.001")

History

  • GET /api/v1/orders (Gets order history.) ✔️
client.get_order_history(pairs=["BTC/ETH", "BTC/USDT"], start_date="1232424242424", end_date="131415535356", page_size="30", page_num="3")
  • GET /api/v1/orderDetails (Gets details of specific order.) ✔️
client.get_order_details(id="1324")
  • GET /api/v1/trades (Retrieves trades history.) ✔️
client.get_trade_history(pairs=["BTC/ETH", "BTC/USDT"], start_date="1232424242424", end_date="131415535356", page_size="30", page_num="3")
  • GET /api/v1/transactionInfo (Gets a transaction information.) ❌
client.get_price_quote(transaction_id="22442")

Futures

  • GET /api/v1/futures/instruments (Retrieves futures instruments) ✔️
client.get_all_future_instruments()
  • GET /api/v1/futures/positions (Retrieves futures positions) ✔️
client.get_future_positions(status="any")
  • POST /api/v1/futures/order (Places a futures order) ✔️
client.place_future_order()
  • POST /api/v1/future/close-all-positions (Closes all future positions) ❌
client.close_all_future_positions()