Skip to content

feat: add borrow repay endpoints #1499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carlosmiei merged 3 commits into from
Dec 5, 2024
Merged

feat: add borrow repay endpoints #1499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9ba4e58
feat: add borrow repay endpoints
pcriadoperez Dec 5, 2024
b7b8eeb
add tests
pcriadoperez Dec 5, 2024
d1ce45f
skip-tests
carlosmiei Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions binance/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3840,3 +3840,49 @@ async def options_account_get_block_trades(self, **params):
options_account_get_block_trades.__doc__ = (
Client.options_account_get_block_trades.__doc__
)

async def margin_next_hourly_interest_rate(self, **params):
return await self._request_margin_api(
"get", "margin/next-hourly-interest-rate", signed=True, data=params
)

margin_next_hourly_interest_rate.__doc__ = (
Client.margin_next_hourly_interest_rate.__doc__
)

async def margin_interest_history(self, **params):
return await self._request_margin_api(
"get", "margin/interestHistory", signed=True, data=params
)

margin_interest_history.__doc__ = Client.margin_interest_history.__doc__

async def margin_borrow_repay(self, **params):
return await self._request_margin_api(
"post", "margin/borrow-repay", signed=True, data=params
)

margin_borrow_repay.__doc__ = Client.margin_borrow_repay.__doc__

async def margin_get_borrow_repay_records(self, **params):
return await self._request_margin_api(
"get", "margin/borrow-repay", signed=True, data=params
)

margin_get_borrow_repay_records.__doc__ = (
Client.margin_get_borrow_repay_records.__doc__
)

async def margin_interest_rate_history(self, **params):
return await self._request_margin_api(
"get", "margin/interestRateHistory", signed=True, data=params
)

margin_interest_rate_history.__doc__ = Client.margin_interest_rate_history.__doc__

async def margin_max_borrowable(self, **params):
return await self._request_margin_api(
"get", "margin/maxBorrowable", signed=True, data=params
)

margin_max_borrowable.__doc__ = Client.margin_max_borrowable.__doc__
209 changes: 209 additions & 0 deletions binance/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11246,3 +11246,212 @@ def gift_card_create_dual_token(self, **params):
return self._request_margin_api(
"post", "giftcard/buyCode", signed=True, data=params
)

####################################################
# Borrow and repay Endpoints
####################################################

def margin_next_hourly_interest_rate(self, **params):
"""Get future hourly interest rate (USER_DATA)

https://developers.binance.com/docs/margin_trading/borrow-and-repay

:param assets: required - List of assets, separated by commas, up to 20
:type assets: str
:param isIsolated: required - for isolated margin or not, "TRUE", "FALSE"
:type isIsolated: bool

:returns: API response

.. code-block:: python
[
{
"asset": "BTC",
"nextHourlyInterestRate": "0.00000571"
},
{
"asset": "ETH",
"nextHourlyInterestRate": "0.00000578"
}
]
"""
return self._request_margin_api(
"get", "margin/next-hourly-interest-rate", signed=True, data=params
)

def margin_interest_history(self, **params):
"""Get Interest History (USER_DATA)

https://developers.binance.com/docs/margin_trading/borrow-and-repay/Get-Interest-History

:param asset: optional
:type asset: str
:param isolatedSymbol: optional - isolated symbol
:type isolatedSymbol: str
:param startTime: optional
:type startTime: int
:param endTime: optional
:type endTime: int
:param current: optional - Currently querying page. Start from 1. Default:1
:type current: int
:param size: optional - Default:10 Max:100
:type size: int

:returns: API response

.. code-block:: python
{
"rows": [
{
"txId": 1352286576452864727,
"interestAccuredTime": 1672160400000,
"asset": "USDT",
"rawAsset": “USDT”, // will not be returned for isolated margin
"principal": "45.3313",
"interest": "0.00024995",
"interestRate": "0.00013233",
"type": "ON_BORROW",
"isolatedSymbol": "BNBUSDT" // isolated symbol, will not be returned for crossed margin
}
],
"total": 1
}

"""
return self._request_margin_api(
"get", "margin/interestHistory", signed=True, data=params
)

def margin_borrow_repay(self, **params):
"""Margin Account Borrow/Repay (MARGIN)

https://developers.binance.com/docs/margin_trading/borrow-and-repay/Margin-Account-Borrow-Repay

:param asset: required
:type asset: str
:param amount: required
:type amount: float
:param isIsolated: optional - for isolated margin or not, "TRUE", "FALSE", default "FALSE"
:type isIsolated: str
:param symbol: optional - isolated symbol
:type symbol: str
:param type: str
:type type: str - BORROW or REPAY

:returns: API response
.. code-block:: python
{
//transaction id
"tranId": 100000001
}

"""
return self._request_margin_api(
"post", "margin/borrow-repay", signed=True, data=params
)

def margin_get_borrow_repay_records(self, **params):
"""Query Query borrow/repay records in Margin account (USER_DATA)

https://developers.binance.com/docs/margin_trading/borrow-and-repay/Query-Borrow-Repay

:param asset: required
:type asset: str
:param isolatedSymbol: optional - isolated symbol
:type isolatedSymbol: str
:param txId: optional - the tranId in POST /sapi/v1/margin/loan
:type txId: int
:param startTime: optional
:type startTime: int
:param endTime: optional
:type endTime: int
:param current: optional - Currently querying page. Start from 1. Default:1
:type current: int
:param size: optional - Default:10 Max:100
:type size: int

:returns: API response

.. code-block:: python
{
"rows": [
{
"type": "AUTO", // AUTO,MANUAL for Cross Margin Borrow; MANUAL，AUTO，BNB_AUTO_REPAY，POINT_AUTO_REPAY for Cross Margin Repay; AUTO，MANUAL for Isolated Margin Borrow/Repay;
"isolatedSymbol": "BNBUSDT", // isolated symbol, will not be returned for crossed margin
"amount": "14.00000000", // Total amount borrowed/repaid
"asset": "BNB",
"interest": "0.01866667", // Interest repaid
"principal": "13.98133333", // Principal repaid
"status": "CONFIRMED", //one of PENDING (pending execution), CONFIRMED (successfully execution), FAILED (execution failed, nothing happened to your account);
"timestamp": 1563438204000,
"txId": 2970933056
}
],
"total": 1
}

"""
return self._request_margin_api(
"get", "margin/borrow-repay", signed=True, data=params
)

def margin_interest_rate_history(self, **params):
"""Query Margin Interest Rate History (USER_DATA)

https://developers.binance.com/docs/margin_trading/borrow-and-repay/Query-Margin-Interest-Rate-History

:param asset: required
:type asset: str
:param vipLevel: optional
:type vipLevel: int
:param startTime: optional
:type startTime: int
:param endTime: optional
:type endTime: int

:returns: API response

.. code-block:: python
[
{
"asset": "BTC",
"dailyInterestRate": "0.00025000",
"timestamp": 1611544731000,
"vipLevel": 1
},
{
"asset": "BTC",
"dailyInterestRate": "0.00035000",
"timestamp": 1610248118000,
"vipLevel": 1
}
]

"""
return self._request_margin_api(
"get", "margin/interestRateHistory", signed=True, data=params
)

def margin_max_borrowable(self, **params):
"""Query Max Borrow (USER_DATA)

https://developers.binance.com/docs/margin_trading/borrow-and-repay/Query-Max-Borrow

:param asset: required
:type asset: str
:param isolatedSymbol: optional - isolated symbol
:type isolatedSymbol: str

:returns: API response

.. code-block:: python

{
"amount": "1.69248805", // account's currently max borrowable amount with sufficient system availability
"borrowLimit": "60" // max borrowable amount limited by the account level
}

"""
return self._request_margin_api(
"get", "margin/maxBorrowable", signed=True, data=params
)
42 changes: 42 additions & 0 deletions tests/test_async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,3 +184,45 @@ async def test_ws_get_time(clientAsync):

async def test_ws_get_exchange_info(clientAsync):
await clientAsync.ws_get_exchange_info(symbol="BTCUSDT")

@pytest.mark.skip(reason="can't test margin endpoints")
async def test_margin_next_hourly_interest_rate(clientAsync):
Copy link
Collaborator

@carlosmiei carlosmiei Dec 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we can test these methods live

await clientAsync.margin_next_hourly_interest_rate(
assets="BTC",
isIsolated="FALSE"
)

@pytest.mark.skip(reason="can't test margin endpoints")
async def test_margin_interest_history(clientAsync):
await clientAsync.margin_interest_history(
asset="BTC",
)

@pytest.mark.skip(reason="can't test margin endpoints")
async def test_margin_borrow_repay(clientAsync):
await clientAsync.margin_borrow_repay(
asset="BTC",
amount=0.1,
isIsolated="FALSE",
symbol="BTCUSDT",
type="BORROW"
)

@pytest.mark.skip(reason="can't test margin endpoints")
async def test_margin_get_borrow_repay_records(clientAsync):
await clientAsync.margin_get_borrow_repay_records(
asset="BTC",
isolatedSymbol="BTCUSDT",
)

@pytest.mark.skip(reason="can't test margin endpoints")
async def test_margin_interest_rate_history(clientAsync):
await clientAsync.margin_interest_rate_history(
asset="BTC",
)

@pytest.mark.skip(reason="can't test margin endpoints")
async def test_margin_max_borrowable(clientAsync):
await clientAsync.margin_max_borrowable(
asset="BTC",
)
51 changes: 51 additions & 0 deletions tests/test_client_margin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -592,3 +592,54 @@ def test_margin_disable_fast_withdraw_switch(client):

def test_margin_enable_fast_withdraw_switch(client):
client.enable_fast_withdraw_switch()


@pytest.mark.skip(reason="can't test margin endpoints")
def test_margin_next_hourly_interest_rate(client):
client.margin_next_hourly_interest_rate(
assets="BTC",
isIsolated="FALSE"
)


@pytest.mark.skip(reason="can't test margin endpoints")
def test_margin_interest_history(client):
client.margin_interest_history(
asset="BTC",
)


@pytest.mark.skip(reason="can't test margin endpoints")
def test_margin_borrow_repay(client):
client.margin_borrow_repay(
asset="BTC",
amount=0.1,
isIsolated="FALSE",
symbol="BTCUSDT",
type="BORROW"
)


@pytest.mark.skip(reason="can't test margin endpoints")
def test_margin_get_borrow_repay_records(client):
client.margin_get_borrow_repay_records(
asset="BTC",
isolatedSymbol="BTCUSDT",
txId=2970933056,
startTime=1563438204000,
endTime=1563438204000,
current=1,
size=10
)

@pytest.mark.skip(reason="can't test margin endpoints")
def test_margin_interest_rate_history(client):
client.margin_interest_rate_history(
asset="BTC",
)

@pytest.mark.skip(reason="can't test margin endpoints")
def test_margin_max_borrowable(client):
client.margin_max_borrowable(
asset="BTC",
)
Loading