Binance Portfolio Margin Program API Interface
2022-04-18 06:15
The Binance Portfolio Margin Program is available via Binance Futures API connectivity suite, and open to qualifying users with Binance Futures API trading enabled. The existing trading API endpoints on Spot Margin, USDⓈ-M Futures and Coin-M Futures remain available under the Binance Portfolio Margin Program and are consistent with regular account trading practices.
Binance Portfolio Margin Program API Details
In addition to Binance standard API endpoints, a dedicated additional endpoint is added under the Binance Portfolio Margin Program, providing uniMMR and Portfolio Margin Account status:
Please note that the requests below will return the corresponding outputs:
Field | Description |
uniMMR | Unified Margin Maintenance margin ratio |
accountEquity | Unified margin account equity, in USD |
accountMaintMargin | Unified Margin Maintenance Margin, the required margin for open position and loan, in USD |
accountStatus | Unified Margin Account current status: "NORMAL", "MARGIN_CALL", "SUPPLY_MARGIN", "REDUCE_ONLY", "ACTIVE_LIQUIDATION", "FORCE_LIQUIDATION", "BANKRUPTED" |
API Parameters:
NAME | TYPE | MANDATORY |
recvWindow | LONG | NO |
timestamp | LONG | YES |
API Responses:
Response Type | Response Content |
Normal Response | { "uniMMR": "1.87987800", "accountEquity": "122607.35137903", "accountMaintMargin": "23.72469206", "accountStatus": "NORMAL" } |
When account is not enable with Portfolio Margin Program | { "code": -9000, "msg": "USER_IS_NOT_UNIACCOUNT" } |
New Additional Portfolio Margin Program API Exceptions:
Client Status | Response Content |
If clients transfer assets from margin to futures | /sapi/v1/asset/transfer: UNI_ACCOUNT_CANT_TRANSFER_FUTURE |
If margin assets failed to retrieve in time | /sapi/v1/margin/maxTransferable: NET_ASSET_MUST_LTE_RATIO |
If margin assets are not updated by system in time | /sapi/v1/margin/maxBorrowable: NET_ASSET_MUST_LTE_RATIO |