def get_balance(self) -> any:
"""
Future Account Balance (USER_DATA)
Get /fapi/v1/balance (HMAC SHA256)
"""
return call_sync(self.request_impl.get_balance())
def get_position(self) -> any:
"""
Position Information (USER_DATA)
GET /fapi/v1/positionRisk (HMAC SHA256) Get current account information.
"""
return call_sync(self.request_impl.get_position())
def cancel_all_orders(self, symbol: 'str') -> any:
"""
Cancel All Open Orders (TRADE)
DELETE /fapi/v1/allOpenOrders (HMAC SHA256)
"""
return call_sync(self.request_impl.cancel_all_orders(symbol))
def get_open_interest(self, symbol: 'str') -> any:
"""
Symbol Open Interest (MARKET_DATA)
GET /fapi/v1/openInterest
Get present open interest of a specific symbol.
"""
return call_sync(self.request_impl.get_open_interest(symbol))
def get_symbol_orderbook_ticker(self, symbol: 'str' = None) -> any:
"""
Symbol Order Book Ticker (MARKET_DATA)
GET /fapi/v1/ticker/bookTicker
Best price/qty on the order book for a symbol or symbols.
"""
return call_sync(self.request_impl.get_symbol_orderbook_ticker(symbol))
def get_symbol_price_ticker(self, symbol: 'str' = None) -> any:
"""
Symbol Price Ticker (MARKET_DATA)
GET /fapi/v1/ticker/price
Latest price for a symbol or symbols.
"""
return call_sync(self.request_impl.get_symbol_price_ticker(symbol))
def get_account_information(self) -> any:
"""
Account Information (USER_DATA)
GET /fapi/v1/account (HMAC SHA256)
Get current account information.
"""
return call_sync(self.request_impl.get_account_information())
def get_mark_price(self, symbol: 'str') -> any:
"""
Mark Price (MARKET_DATA)
GET /fapi/v1/premiumIndex
Mark Price and Funding Rate
"""
return call_sync(self.request_impl.get_mark_price(symbol))
def change_position_margin(self, symbol: 'str', amount: 'float',
type: 'int') -> any:
"""
Modify Isolated Position Margin (TRADE)
POST /fapi/v1/positionMargin (HMAC SHA256)
"""
return call_sync(
self.request_impl.change_position_margin(symbol, amount, type))
def get_servertime(self) -> any:
"""
Check Server Time
GET /fapi/v1/time
Test connectivity to the Rest API and get the current server time.
"""
return call_sync(self.request_impl.get_servertime())
def get_order_book(self, symbol: 'str', limit: 'int' = None) -> any:
"""
Order Book (MARKET_DATA)
GET /fapi/v1/depth
Adjusted based on the limit:
"""
return call_sync(self.request_impl.get_order_book(symbol, limit))
def get_exchange_information(self) -> any:
"""
Exchange Information (MARKET_DATA)
GET /fapi/v1/exchangeInfo
Current exchange trading rules and symbol information
"""
return call_sync(self.request_impl.get_exchange_information())
def get_open_orders(self, symbol: 'str' = None) -> any:
"""
Current Open Orders (USER_DATA)
GET /fapi/v1/openOrders (HMAC SHA256)
Get all open orders on a symbol. Careful when accessing this with no symbol.
"""
return call_sync(self.request_impl.get_open_orders(symbol))
def close_user_data_stream(self) -> any:
"""
Close User Data Stream (USER_STREAM)
DELETE /fapi/v1/listenKey (HMAC SHA256)
Close out a user data stream.
"""
return call_sync(self.request_impl.close_user_data_stream())
def change_margin_type(self, symbol: 'str',
marginType: 'FuturesMarginType') -> any:
"""
Change Margin Type (TRADE)
POST /fapi/v1/marginType (HMAC SHA256)
"""
return call_sync(
self.request_impl.change_margin_type(symbol, marginType))
def keep_user_data_stream(self) -> any:
"""
Keepalive User Data Stream (USER_STREAM)
PUT /fapi/v1/listenKey (HMAC SHA256)
Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes.
It's recommended to send a ping about every 60 minutes.
"""
return call_sync(self.request_impl.keep_user_data_stream())
def change_initial_leverage(self, symbol: 'str', leverage: 'int') -> any:
"""
Change Initial Leverage (TRADE)
POST /fapi/v1/leverage (HMAC SHA256)
Change user's initial leverage of specific symbol market.
"""
return call_sync(
self.request_impl.change_initial_leverage(symbol, leverage))
def start_user_data_stream(self) -> any:
"""
Start User Data Stream (USER_STREAM)
POST /fapi/v1/listenKey (HMAC SHA256)
Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent.
If the account has an active listenKey,
that listenKey will be returned and its validity will be extended for 60 minutes.
"""
return call_sync(self.request_impl.start_user_data_stream())
def get_ticker_price_change_statistics(self, symbol: 'str' = None) -> any:
"""
24hr Ticker Price Change Statistics (MARKET_DATA)
GET /fapi/v1/ticker/24hr
24 hour rolling window price change statistics.
Careful when accessing this with no symbol.
"""
return call_sync(
self.request_impl.get_ticker_price_change_statistics(symbol))
def cancel_list_orders(self,
symbol: 'str',
orderIdList: 'list' = None,
origClientOrderIdList: 'list' = None) -> any:
"""
Cancel Multiple Orders (TRADE)
DELETE /fapi/v1/batchOrders (HMAC SHA256)
"""
return call_sync(
self.request_impl.cancel_list_orders(symbol, orderIdList,
origClientOrderIdList))
def get_recent_trades_list(self,
symbol: 'str',
limit: 'int' = None) -> any:
"""
Recent Trades List (MARKET_DATA)
GET /fapi/v1/trades
Get recent trades (up to last 500).
"""
return call_sync(
self.request_impl.get_recent_trades_list(symbol, limit))
def get_old_trade_lookup(self,
symbol: 'str',
limit: 'int' = None,
fromId: 'long' = None) -> any:
"""
Old Trades Lookup (MARKET_DATA)
GET /fapi/v1/historicalTrades
Get older market historical trades.
"""
return call_sync(
self.request_impl.get_old_trade_lookup(symbol, limit, fromId))
def get_liquidation_orders(self,
symbol: 'str' = None,
startTime: 'long' = None,
endTime: 'str' = None,
limit: 'int' = None) -> any:
"""
Get all Liquidation Orders (MARKET_DATA)
GET /fapi/v1/allForceOrders
"""
return call_sync(
self.request_impl.get_liquidation_orders(symbol, startTime,
endTime, limit))
def get_order(self,
symbol: 'str',
orderId: 'long' = None,
origClientOrderId: 'str' = None) -> any:
"""
Query Order (USER_DATA)
GET /fapi/v1/order (HMAC SHA256)
Check an order's status.
"""
return call_sync(
self.request_impl.get_order(symbol, orderId, origClientOrderId))
def get_funding_rate(self,
symbol: 'str',
startTime: 'long' = None,
endTime: 'str' = None,
limit: 'int' = None) -> any:
"""
Get Funding Rate History (MARKET_DATA)
GET /fapi/v1/fundingRate
"""
return call_sync(
self.request_impl.get_funding_rate(symbol, startTime, endTime,
limit))
def cancel_order(self,
symbol: 'str',
orderId: 'long' = None,
origClientOrderId: 'str' = None) -> any:
"""
Cancel Order (TRADE)
DELETE /fapi/v1/order (HMAC SHA256)
Cancel an active order.
"""
return call_sync(
self.request_impl.cancel_order(symbol, orderId, origClientOrderId))
def get_position_margin_change_history(self,
symbol: 'str',
type: 'int' = None,
startTime: 'int' = None,
endTime: 'int' = None,
limit: 'int' = None) -> any:
"""
Get Position Margin Change History (TRADE)
GET /fapi/v1/positionMargin/history (HMAC SHA256)
"""
return call_sync(
self.request_impl.get_position_margin_change_history(
symbol, type, startTime, endTime, limit))
def get_income_history(self,
symbol: 'str' = None,
incomeType: 'IncomeType' = IncomeType.INVALID,
startTime: 'long' = None,
endTime: 'long' = None,
limit: 'int' = None) -> any:
"""
Get Income History(USER_DATA)
GET /fapi/v1/income (HMAC SHA256)
"""
return call_sync(
self.request_impl.get_income_history(symbol, incomeType, startTime,
endTime, limit))
def get_all_orders(self,
symbol: 'str',
orderId: 'long' = None,
startTime: 'long' = None,
endTime: 'long' = None,
limit: 'int' = None) -> any:
"""
All Orders (USER_DATA)
GET /fapi/v1/allOrders (HMAC SHA256)
Get all account orders; active, canceled, or filled.
"""
return call_sync(
self.request_impl.get_all_orders(symbol, orderId, startTime,
endTime, limit))
def get_account_trades(self,
symbol: 'str',
startTime: 'long' = None,
endTime: 'long' = None,
fromId: 'long' = None,
limit: 'int' = None) -> any:
"""
Account Trade List (USER_DATA)
GET /fapi/v1/userTrades (HMAC SHA256)
Get trades for a specific account and symbol.
"""
return call_sync(
self.request_impl.get_account_trades(symbol, startTime, endTime,
fromId, limit))
