Reorder and rename some method inside _RestAuthenticatedEndpoints class.

bfxapi/rest/_RestAuthenticatedEndpoints.py

@@ -22,9 +22,6 @@ class _RestAuthenticatedEndpoints(_Requests):
 
         return [ serializers.Order.parse(*sub_data) for sub_data in self._POST(endpoint, data={ "id": ids }) ]
 
-    def get_positions(self) -> List[Position]:
-        return [ serializers.Position.parse(*sub_data) for sub_data in self._POST("auth/r/positions") ]
-
     def submit_order(self, type: OrderType, symbol: str, amount: Union[Decimal, float, str], 
                      price: Optional[Union[Decimal, float, str]] = None, lev: Optional[int] = None, 
                      price_trailing: Optional[Union[Decimal, float, str]] = None, price_aux_limit: Optional[Union[Decimal, float, str]] = None, price_oco_stop: Optional[Union[Decimal, float, str]] = None,
@@ -86,6 +83,9 @@ class _RestAuthenticatedEndpoints(_Requests):
 
         return [ serializers.Order.parse(*sub_data) for sub_data in self._POST(endpoint, data=data) ]
 
+    def get_order_trades(self, symbol: str, id: int) -> List[OrderTrade]:
+        return [ serializers.OrderTrade.parse(*sub_data) for sub_data in self._POST(f"auth/r/order/{symbol}:{id}/trades") ]
+
     def get_trades_history(self, symbol: Optional[str] = None, sort: Optional[Sort] = None, start: Optional[str] = None, end: Optional[str] = None, limit: Optional[int] = None) -> List[Trade]:
         if symbol == None:
             endpoint = "auth/r/trades/hist"
@@ -99,22 +99,6 @@ class _RestAuthenticatedEndpoints(_Requests):
 
         return [ serializers.Trade.parse(*sub_data) for sub_data in self._POST(endpoint, data=data) ]
 
-    def get_funding_trades_history(self, symbol: Optional[str] = None, sort: Optional[Sort] = None, start: Optional[str] = None, end: Optional[str] = None, limit: Optional[int] = None) -> List[FundingTrade]:
-        if symbol == None:
-            endpoint = "auth/r/funding/trades/hist"
-        else: endpoint = f"auth/r/funding/trades/{symbol}/hist"
-
-        data = {
-            "sort": sort,
-            "start": start, "end": end,
-            "limit": limit
-        }
-
-        return [ serializers.FundingTrade.parse(*sub_data) for sub_data in self._POST(endpoint, data=data) ]
-
-    def get_order_trades(self, symbol: str, id: int) -> List[OrderTrade]:
-        return [ serializers.OrderTrade.parse(*sub_data) for sub_data in self._POST(f"auth/r/order/{symbol}:{id}/trades") ]
-
     def get_ledgers(self, currency: str, category: Optional[int] = None, start: Optional[str] = None, end: Optional[str] = None, limit: Optional[int] = None) -> List[Ledger]:
         data = {
             "category": category,
@@ -124,6 +108,52 @@ class _RestAuthenticatedEndpoints(_Requests):
 
         return [ serializers.Ledger.parse(*sub_data) for sub_data in self._POST(f"auth/r/ledgers/{currency}/hist", data=data) ]
 
+    def get_base_margin_info(self) -> BaseMarginInfo:
+        return serializers.BaseMarginInfo.parse(*(self._POST(f"auth/r/info/margin/base")[1]))
+
+    def get_symbol_margin_info(self, symbol: str) -> SymbolMarginInfo:
+        response = self._POST(f"auth/r/info/margin/{symbol}")
+
+        return serializers.SymbolMarginInfo.parse(*([response[1]] + response[2]))
+
+    def get_all_symbols_margin_info(self) -> List[SymbolMarginInfo]:
+        return [ serializers.SymbolMarginInfo.parse(*([sub_data[1]] + sub_data[2])) for sub_data in self._POST(f"auth/r/info/margin/sym_all") ]
+
+    def get_positions(self) -> List[Position]:
+       return [ serializers.Position.parse(*sub_data) for sub_data in self._POST("auth/r/positions") ]
+
+    def claim_position(self, id: int, amount: Optional[Union[Decimal, float, str]] = None) -> Notification[PositionClaim]:
+        return serializers._Notification[PositionClaim](serializer=serializers.PositionClaim).parse(
+            *self._POST("auth/w/position/claim", data={ "id": id, "amount": amount })
+        )
+
+    def increase_position(self, symbol: str, amount: Union[Decimal, float, str]) -> Notification[PositionIncrease]:
+        return serializers._Notification[PositionIncrease](serializer=serializers.PositionIncrease).parse(
+            *self._POST("auth/w/position/increase", data={ "symbol": symbol, "amount": amount })
+        )
+
+    def get_increase_position_info(self, symbol: str, amount: Union[Decimal, float, str]) -> PositionIncreaseInfo:
+        response = self._POST(f"auth/r/position/increase/info", data={ "symbol": symbol, "amount": amount })
+
+        return serializers.PositionIncreaseInfo.parse(*(
+            response[0] + [response[1][0]] + response[1][1] + [response[1][2]] + response[4] + response[5]
+        ))
+
+    def get_positions_history(self, start: Optional[str] = None, end: Optional[str] = None, limit: Optional[int] = None) -> List[PositionHistory]:
+        return [ serializers.PositionHistory.parse(*sub_data) for sub_data in self._POST("auth/r/positions/hist", data={ "start": start, "end": end, "limit": limit }) ]
+
+    def get_positions_snapshot(self, start: Optional[str] = None, end: Optional[str] = None, limit: Optional[int] = None) -> List[PositionSnapshot]:
+        return [ serializers.PositionSnapshot.parse(*sub_data) for sub_data in self._POST("auth/r/positions/snap", data={ "start": start, "end": end, "limit": limit }) ]
+
+    def get_positions_audit(self, ids: Optional[List[int]] = None, start: Optional[str] = None, end: Optional[str] = None, limit: Optional[int] = None) -> List[PositionAudit]:
+        return [ serializers.PositionAudit.parse(*sub_data) for sub_data in self._POST("auth/r/positions/audit", data={ "ids": ids, "start": start, "end": end, "limit": limit }) ]
+
+    def set_derivative_position_collateral(self, symbol: str, collateral: Union[Decimal, float, str]) -> DerivativePositionCollateral:
+        return serializers.DerivativePositionCollateral.parse(*(self._POST("auth/w/deriv/collateral/set", data={ "symbol": symbol, "collateral": collateral })[0]))
+
+    def get_derivative_position_collateral_limits(self, symbol: str) -> DerivativePositionCollateralLimits:
+        return serializers.DerivativePositionCollateralLimits.parse(*self._POST("auth/calc/deriv/collateral/limits", data={ "symbol": symbol }))
+
     def get_funding_offers(self, symbol: Optional[str] = None) -> List[FundingOffer]:
         endpoint = "auth/r/funding/offers"
 
@@ -151,6 +181,25 @@ class _RestAuthenticatedEndpoints(_Requests):
             *self._POST("auth/w/funding/offer/cancel/all", data={ "currency": currency })
         )
 
+    def submit_funding_close(self, id: int) -> Notification[Literal[None]]:
+        return serializers._Notification[Literal[None]](serializer=None).parse(
+            *self._POST("auth/w/funding/close", data={ "id": id })
+        )
+
+    def toggle_auto_renew(self, status: bool, currency: str, amount: Optional[str] = None, rate: Optional[int] = None, period: Optional[int] = None) -> Notification[FundingAutoRenew]:
+        return serializers._Notification[FundingAutoRenew](serializer=serializers.FundingAutoRenew).parse(*self._POST("auth/w/funding/auto", data={
+            "status": int(status),
+            "currency": currency, "amount": amount,
+            "rate": rate, "period": period
+        }))
+
+    def toggle_keep(self, type: Literal["credit", "loan"], ids: Optional[List[int]] = None, changes: Optional[Dict[int, bool]] = None) -> Notification[Literal[None]]:
+        return serializers._Notification[Literal[None]](serializer=None).parse(*self._POST("auth/w/funding/keep", data={
+            "type": type,
+            "id": ids,
+            "changes": changes
+        }))
+
     def get_funding_offers_history(self, symbol: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, limit: Optional[int] = None) -> List[FundingOffer]:
         if symbol == None:
             endpoint = "auth/r/funding/offers/hist"
@@ -201,31 +250,25 @@ class _RestAuthenticatedEndpoints(_Requests):
 
         return [ serializers.FundingCredit.parse(*sub_data) for sub_data in self._POST(endpoint, data=data) ]
 
+    def get_funding_trades_history(self, symbol: Optional[str] = None, sort: Optional[Sort] = None, start: Optional[str] = None, end: Optional[str] = None, limit: Optional[int] = None) -> List[FundingTrade]:
+        if symbol == None:
+            endpoint = "auth/r/funding/trades/hist"
+        else: endpoint = f"auth/r/funding/trades/{symbol}/hist"
+
+        data = {
+            "sort": sort,
+            "start": start, "end": end,
+            "limit": limit
+        }
+
+        return [ serializers.FundingTrade.parse(*sub_data) for sub_data in self._POST(endpoint, data=data) ]
+
     def get_funding_info(self, key: str) -> FundingInfo:
         response = self._POST(f"auth/r/info/funding/{key}")
         
         return serializers.FundingInfo.parse(*([response[1]] + response[2]))
 
-    def submit_funding_close(self, id: int) -> Notification[Literal[None]]:
+    def transfer_between_wallets(self, from_wallet: str, to_wallet: str, currency: str, currency_to: str, amount: Union[Decimal, float, str]) -> Notification[Transfer]:
-        return serializers._Notification[Literal[None]](serializer=None).parse(
-            *self._POST("auth/w/funding/close", data={ "id": id })
-        )
-
-    def submit_funding_toggle_auto_renew(self, status: bool, currency: str, amount: Optional[str] = None, rate: Optional[int] = None, period: Optional[int] = None) -> Notification[FundingAutoRenew]:
-        return serializers._Notification[FundingAutoRenew](serializer=serializers.FundingAutoRenew).parse(*self._POST("auth/w/funding/auto", data={
-            "status": int(status),
-            "currency": currency, "amount": amount,
-            "rate": rate, "period": period
-        }))
-
-    def submit_funding_toggle_keep(self, type: Literal["credit", "loan"], ids: Optional[List[int]] = None, changes: Optional[Dict[int, bool]] = None) -> Notification[Literal[None]]:
-        return serializers._Notification[Literal[None]](serializer=None).parse(*self._POST("auth/w/funding/keep", data={
-            "type": type,
-            "id": ids,
-            "changes": changes
-        }))
-
-    def submit_wallet_transfer(self, from_wallet: str, to_wallet: str, currency: str, currency_to: str, amount: Union[Decimal, float, str]) -> Notification[Transfer]:
         data = {
             "from": from_wallet, "to": to_wallet,
             "currency": currency, "currency_to": currency_to,
@@ -234,13 +277,11 @@ class _RestAuthenticatedEndpoints(_Requests):
 
         return serializers._Notification[Transfer](serializer=serializers.Transfer).parse(*self._POST("auth/w/transfer", data=data))
 
-    def submit_wallet_withdraw(self, wallet: str, method: str, address: str, amount: Union[Decimal, float, str]) -> Notification[Withdrawal]:
+    def submit_wallet_withdrawal(self, wallet: str, method: str, address: str, amount: Union[Decimal, float, str]) -> Notification[Withdrawal]:
-        data = {
+        return serializers._Notification[Withdrawal](serializer=serializers.Withdrawal).parse(*self._POST("auth/w/withdraw", data={
             "wallet": wallet, "method": method,
             "address": address, "amount": amount,
-        }
+        }))
-
-        return serializers._Notification[Withdrawal](serializer=serializers.Withdrawal).parse(*self._POST("auth/w/withdraw", data=data))
 
     def get_deposit_address(self, wallet: str, method: str, renew: bool = False) -> Notification[DepositAddress]:
         data = {
@@ -251,7 +292,7 @@ class _RestAuthenticatedEndpoints(_Requests):
 
         return serializers._Notification[DepositAddress](serializer=serializers.DepositAddress).parse(*self._POST("auth/w/deposit/address", data=data))
 
-    def get_deposit_invoice(self, wallet: str, currency: str, amount: Union[Decimal, float, str]) -> Invoice:
+    def generate_deposit_invoice(self, wallet: str, currency: str, amount: Union[Decimal, float, str]) -> Invoice:
         data = {
             "wallet": wallet, "currency": currency,
             "amount": amount
@@ -269,43 +310,4 @@ class _RestAuthenticatedEndpoints(_Requests):
             "limit": limit
         }
 
-        return [ serializers.Movement.parse(*sub_data) for sub_data in self._POST(endpoint, data=data) ]
+        return [ serializers.Movement.parse(*sub_data) for sub_data in self._POST(endpoint, data=data) ]
-
-    def get_symbol_margin_info(self, symbol: str) -> SymbolMarginInfo:
-        response = self._POST(f"auth/r/info/margin/{symbol}")
-
-        return serializers.SymbolMarginInfo.parse(*([response[1]] + response[2]))
-    
-    def get_all_symbols_margin_info(self) -> List[SymbolMarginInfo]:
-        return [ serializers.SymbolMarginInfo.parse(*([sub_data[1]] + sub_data[2])) for sub_data in self._POST(f"auth/r/info/margin/sym_all") ]
-
-    def get_base_margin_info(self) -> BaseMarginInfo:
-        return serializers.BaseMarginInfo.parse(*(self._POST(f"auth/r/info/margin/base")[1]))
-
-    def claim_position(self, id: int, amount: Optional[Union[Decimal, float, str]] = None) -> Notification[Claim]:
-        return serializers._Notification[Claim](serializer=serializers.Claim).parse(*self._POST("auth/w/position/claim", data={ "id": id, "amount": amount }))
-
-    def get_increase_position_info(self, symbol: str, amount: Union[Decimal, float, str]) -> IncreaseInfo:
-        response = self._POST(f"auth/r/position/increase/info", data={ "symbol": symbol, "amount": amount })
-
-        return serializers.IncreaseInfo.parse(*(
-            response[0] + [response[1][0]] + response[1][1] + [response[1][2]] + response[4] + response[5]
-        ))
-
-    def increase_position(self, symbol: str, amount: Union[Decimal, float, str]) -> Notification[Increase]:
-        return serializers._Notification[Increase](serializer=serializers.Increase).parse(*self._POST("auth/w/position/increase", data={ "symbol": symbol, "amount": amount }))
-
-    def get_positions_history(self, start: Optional[str] = None, end: Optional[str] = None, limit: Optional[int] = None) -> List[PositionHistory]:
-        return [ serializers.PositionHistory.parse(*sub_data) for sub_data in self._POST("auth/r/positions/hist", data={ "start": start, "end": end, "limit": limit }) ]
-    
-    def get_positions_snapshot(self, start: Optional[str] = None, end: Optional[str] = None, limit: Optional[int] = None) -> List[PositionSnapshot]:
-        return [ serializers.PositionSnapshot.parse(*sub_data) for sub_data in self._POST("auth/r/positions/snap", data={ "start": start, "end": end, "limit": limit }) ]
-
-    def get_positions_audit(self, ids: Optional[List[int]] = None, start: Optional[str] = None, end: Optional[str] = None, limit: Optional[int] = None) -> List[PositionAudit]:
-        return [ serializers.PositionAudit.parse(*sub_data) for sub_data in self._POST("auth/r/positions/audit", data={ "ids": ids, "start": start, "end": end, "limit": limit }) ]
-
-    def set_derivative_position_collateral(self, symbol: str, collateral: Union[Decimal, float, str]) -> DerivativePositionCollateral:
-        return serializers.DerivativePositionCollateral.parse(*(self._POST("auth/w/deriv/collateral/set", data={ "symbol": symbol, "collateral": collateral })[0]))
-
-    def get_derivative_position_collateral_limits(self, symbol: str) -> DerivativePositionCollateralLimits:
-        return serializers.DerivativePositionCollateralLimits.parse(*self._POST("auth/calc/deriv/collateral/limits", data={ "symbol": symbol }))

bfxapi/rest/serializers.py

@@ -19,8 +19,8 @@ __serializers__ = [
     "FundingAutoRenew", "FundingInfo", "Wallet",
     "Transfer", "Withdrawal", "DepositAddress",
     "Invoice", "Movement", "SymbolMarginInfo",
-    "BaseMarginInfo", "Claim", "IncreaseInfo",
+    "BaseMarginInfo", "PositionClaim", "PositionIncreaseInfo",
-    "Increase", "PositionHistory", "PositionSnapshot",
+    "PositionIncrease", "PositionHistory", "PositionSnapshot",
     "PositionAudit", "DerivativePositionCollateral", "DerivativePositionCollateralLimits",
 ]
 
@@ -557,7 +557,7 @@ BaseMarginInfo = generate_labeler_serializer("BaseMarginInfo", klass=types.BaseM
     "margin_min"
 ])
 
-Claim = generate_labeler_serializer("Claim", klass=types.Claim, labels=[
+PositionClaim = generate_labeler_serializer("PositionClaim", klass=types.PositionClaim, labels=[
     "symbol",
     "position_status",
     "amount",
@@ -580,7 +580,7 @@ Claim = generate_labeler_serializer("Claim", klass=types.Claim, labels=[
     "meta"
 ])
 
-IncreaseInfo = generate_labeler_serializer("IncreaseInfo", klass=types.IncreaseInfo, labels=[
+PositionIncreaseInfo = generate_labeler_serializer("PositionIncreaseInfo", klass=types.PositionIncreaseInfo, labels=[
     "max_pos",
     "current_pos",
     "base_currency_balance",
@@ -599,7 +599,7 @@ IncreaseInfo = generate_labeler_serializer("IncreaseInfo", klass=types.IncreaseI
     "funding_required_currency"
 ])
 
-Increase = generate_labeler_serializer("Increase", klass=types.Increase, labels=[
+PositionIncrease = generate_labeler_serializer("PositionIncrease", klass=types.PositionIncrease, labels=[
     "symbol",
     "_PLACEHOLDER",
     "amount",

bfxapi/rest/types.py

@@ -21,8 +21,8 @@ __types__ = [
     "FundingAutoRenew", "FundingInfo", "Wallet",
     "Transfer", "Withdrawal", "DepositAddress",
     "Invoice", "Movement", "SymbolMarginInfo",
-    "BaseMarginInfo", "Claim", "IncreaseInfo",
+    "BaseMarginInfo", "PositionClaim", "PositionIncreaseInfo",
-    "Increase", "PositionHistory", "PositionSnapshot",
+    "PositionIncrease", "PositionHistory", "PositionSnapshot",
     "PositionAudit", "DerivativePositionCollateral", "DerivativePositionCollateralLimits",
 ]
 
@@ -454,7 +454,7 @@ class BaseMarginInfo(_Type):
     margin_min: float
 
 @dataclass
-class Claim(_Type):
+class PositionClaim(_Type):
     symbol: str
     position_status: str
     amount: float
@@ -470,7 +470,7 @@ class Claim(_Type):
     meta: JSON
 
 @dataclass
-class IncreaseInfo(_Type):
+class PositionIncreaseInfo(_Type):
     max_pos: int
     current_pos: float
     base_currency_balance: float
@@ -485,7 +485,7 @@ class IncreaseInfo(_Type):
     funding_required_currency: str
 
 @dataclass
-class Increase(_Type):
+class PositionIncrease(_Type):
     symbol: str
     amount: float
     base_price: float

examples/rest/claim_position.py

@@ -16,4 +16,4 @@ open_margin_positions = bfx.rest.auth.get_positions()
 for position in open_margin_positions:
     print(f"Position {position}")
     claim = bfx.rest.auth.claim_position(position.position_id, amount=0.000001)
-    print(f"Claim {claim.notify_info}")
+    print(f"PositionClaim {claim.notify_info}")

examples/rest/funding_auto_renew.py

@@ -10,7 +10,7 @@ bfx = Client(
     API_SECRET=os.getenv("BFX_API_SECRET")
 )
 
-notification = bfx.rest.auth.submit_funding_toggle_auto_renew(
+notification = bfx.rest.auth.toggle_auto_renew(
     status=True,
     currency="USD",
     amount="150",

examples/rest/keep_taken_funding.py

@@ -15,7 +15,7 @@ loans = bfx.rest.auth.get_funding_loans(symbol="fUSD")
 for loan in loans:
     print(f"Loan {loan}")
 
-    notification = bfx.rest.auth.submit_funding_toggle_keep(
+    notification = bfx.rest.auth.toggle_keep(
         funding_type="loan",
         ids=[loan.id],
         changes={

examples/rest/transfer_wallet.py

@@ -11,7 +11,7 @@ bfx = Client(
 )
 
 def transfer_wallet():
-    response = bfx.rest.auth.submit_wallet_transfer(from_wallet="exchange", to_wallet="funding", from_currency="ETH", to_currency="ETH", amount=0.001)
+    response = bfx.rest.auth.transfer_between_wallets(from_wallet="exchange", to_wallet="funding", from_currency="ETH", to_currency="ETH", amount=0.001)
     print("Transfer:", response.notify_info)
 
 def get_existing_deposit_address():
@@ -24,11 +24,11 @@ def create_new_deposit_address():
 
 def withdraw():
     # tetheruse = Tether (ERC20)
-    response = bfx.rest.auth.submit_wallet_withdraw(wallet="exchange", method="tetheruse", amount=1, address="0x742d35Cc6634C0532925a3b844Bc454e4438f44e")
+    response = bfx.rest.auth.submit_wallet_withdrawal(wallet="exchange", method="tetheruse", amount=1, address="0x742d35Cc6634C0532925a3b844Bc454e4438f44e")
     print("Address:", response.notify_info)
 
 def create_lighting_network_deposit_address():
-    invoice = bfx.rest.auth.get_deposit_invoice(wallet="funding", currency="LNX", amount=0.001)
+    invoice = bfx.rest.auth.generate_deposit_invoice(wallet="funding", currency="LNX", amount=0.001)
     print("Invoice:", invoice)
 
 def get_movements():