Skip to content

pmargin_README.md

Latest commit

 

History

History
325 lines (291 loc) · 33.7 KB

pmargin_README.md

File metadata and controls

325 lines (291 loc) · 33.7 KB

binance.pmargin

OpenAPI specification for Binance exchange - Pmargin API

The binance.pmargin package is automatically generated by the OpenAPI Generator project:

Please do not edit the generated code manually, but rather regenerate it from OpenXAPI.

  • API version: 0.3.0
  • Package version: 0.3.0

Requirements.

Python 3.8+

Installation & Usage

pip install openxapi-binance

Getting Started

In your own code, to use this library to connect and interact with binance.pmargin, you can run the following:

import binance.pmargin
from binance.pmargin.rest import ApiException
from binance.pmargin.auth import BinanceAuth
from pprint import pprint

# Defining the host is optional and defaults to https://papi.binance.com
# See configuration.py for a list of all supported configuration parameters.
configuration = binance.pmargin.Configuration(
    host = "https://papi.binance.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
configuration = binance.pmargin.Configuration(
    auth=binance.pmargin.BinanceAuth(
        api_key=os.getenv("BINANCE_API_KEY"),
        # secret_key=os.getenv("BINANCE_SECRET_KEY"), # if you want to use HMAC auth
        private_key_path="/path/to/private_key.pem", # Automatically detects RSA/Ed25519 private keys
    ),
)


# Enter a context with an instance of the API client
with binance.pmargin.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = binance.pmargin.PortfolioMarginApi(api_client)
    asset = '' # str |  (default to '')
    timestamp = 56 # int | 
    recv_window = 56 # int |  (optional)

    try:
        # Fund Collection by Asset(TRADE)
        api_response = api_instance.create_asset_collection_v1(asset, timestamp, recv_window=recv_window)
        print("The response of PortfolioMarginApi->create_asset_collection_v1:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PortfolioMarginApi->create_asset_collection_v1: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://papi.binance.com

Class Method HTTP request Description
PortfolioMarginApi create_asset_collection_v1 POST /papi/v1/asset-collection Fund Collection by Asset(TRADE)
PortfolioMarginApi create_auto_collection_v1 POST /papi/v1/auto-collection Fund Auto-collection(TRADE)
PortfolioMarginApi create_bnb_transfer_v1 POST /papi/v1/bnb-transfer BNB transfer (TRADE)
PortfolioMarginApi create_cm_conditional_order_v1 POST /papi/v1/cm/conditional/order New CM Conditional Order(TRADE)
PortfolioMarginApi create_cm_leverage_v1 POST /papi/v1/cm/leverage Change CM Initial Leverage (TRADE)
PortfolioMarginApi create_cm_order_v1 POST /papi/v1/cm/order New CM Order(TRADE)
PortfolioMarginApi create_cm_position_side_dual_v1 POST /papi/v1/cm/positionSide/dual Change CM Position Mode(TRADE)
PortfolioMarginApi create_listen_key_v1 POST /papi/v1/listenKey Start User Data Stream(USER_STREAM)
PortfolioMarginApi create_margin_loan_v1 POST /papi/v1/marginLoan Margin Account Borrow(MARGIN)
PortfolioMarginApi create_margin_order_oco_v1 POST /papi/v1/margin/order/oco Margin Account New OCO(TRADE)
PortfolioMarginApi create_margin_order_v1 POST /papi/v1/margin/order New Margin Order(TRADE)
PortfolioMarginApi create_margin_repay_debt_v1 POST /papi/v1/margin/repay-debt Margin Account Repay Debt(TRADE)
PortfolioMarginApi create_repay_futures_negative_balance_v1 POST /papi/v1/repay-futures-negative-balance Repay futures Negative Balance(USER_DATA)
PortfolioMarginApi create_repay_futures_switch_v1 POST /papi/v1/repay-futures-switch Change Auto-repay-futures Status(TRADE)
PortfolioMarginApi create_repay_loan_v1 POST /papi/v1/repayLoan Margin Account Repay(MARGIN)
PortfolioMarginApi create_um_conditional_order_v1 POST /papi/v1/um/conditional/order New UM Conditional Order (TRADE)
PortfolioMarginApi create_um_fee_burn_v1 POST /papi/v1/um/feeBurn Toggle BNB Burn On UM Futures Trade (TRADE)
PortfolioMarginApi create_um_leverage_v1 POST /papi/v1/um/leverage Change UM Initial Leverage(TRADE)
PortfolioMarginApi create_um_order_v1 POST /papi/v1/um/order New UM Order (TRADE)
PortfolioMarginApi create_um_position_side_dual_v1 POST /papi/v1/um/positionSide/dual Change UM Position Mode(TRADE)
PortfolioMarginApi delete_cm_all_open_orders_v1 DELETE /papi/v1/cm/allOpenOrders Cancel All CM Open Orders(TRADE)
PortfolioMarginApi delete_cm_conditional_all_open_orders_v1 DELETE /papi/v1/cm/conditional/allOpenOrders Cancel All CM Open Conditional Orders(TRADE)
PortfolioMarginApi delete_cm_conditional_order_v1 DELETE /papi/v1/cm/conditional/order Cancel CM Conditional Order(TRADE)
PortfolioMarginApi delete_cm_order_v1 DELETE /papi/v1/cm/order Cancel CM Order(TRADE)
PortfolioMarginApi delete_listen_key_v1 DELETE /papi/v1/listenKey Close User Data Stream(USER_STREAM)
PortfolioMarginApi delete_margin_all_open_orders_v1 DELETE /papi/v1/margin/allOpenOrders Cancel Margin Account All Open Orders on a Symbol(TRADE)
PortfolioMarginApi delete_margin_order_list_v1 DELETE /papi/v1/margin/orderList Cancel Margin Account OCO Orders(TRADE)
PortfolioMarginApi delete_margin_order_v1 DELETE /papi/v1/margin/order Cancel Margin Account Order(TRADE)
PortfolioMarginApi delete_um_all_open_orders_v1 DELETE /papi/v1/um/allOpenOrders Cancel All UM Open Orders(TRADE)
PortfolioMarginApi delete_um_conditional_all_open_orders_v1 DELETE /papi/v1/um/conditional/allOpenOrders Cancel All UM Open Conditional Orders (TRADE)
PortfolioMarginApi delete_um_conditional_order_v1 DELETE /papi/v1/um/conditional/order Cancel UM Conditional Order(TRADE)
PortfolioMarginApi delete_um_order_v1 DELETE /papi/v1/um/order Cancel UM Order(TRADE)
PortfolioMarginApi get_account_v1 GET /papi/v1/account Account Information(USER_DATA)
PortfolioMarginApi get_balance_v1 GET /papi/v1/balance Account Balance(USER_DATA)
PortfolioMarginApi get_cm_account_v1 GET /papi/v1/cm/account Get CM Account Detail(USER_DATA)
PortfolioMarginApi get_cm_adl_quantile_v1 GET /papi/v1/cm/adlQuantile CM Position ADL Quantile Estimation(USER_DATA)
PortfolioMarginApi get_cm_all_orders_v1 GET /papi/v1/cm/allOrders Query All CM Orders (USER_DATA)
PortfolioMarginApi get_cm_commission_rate_v1 GET /papi/v1/cm/commissionRate Get User Commission Rate for CM(USER_DATA)
PortfolioMarginApi get_cm_conditional_all_orders_v1 GET /papi/v1/cm/conditional/allOrders Query All CM Conditional Orders(USER_DATA)
PortfolioMarginApi get_cm_conditional_open_order_v1 GET /papi/v1/cm/conditional/openOrder Query Current CM Open Conditional Order(USER_DATA)
PortfolioMarginApi get_cm_conditional_open_orders_v1 GET /papi/v1/cm/conditional/openOrders Query All Current CM Open Conditional Orders (USER_DATA)
PortfolioMarginApi get_cm_conditional_order_history_v1 GET /papi/v1/cm/conditional/orderHistory Query CM Conditional Order History(USER_DATA)
PortfolioMarginApi get_cm_force_orders_v1 GET /papi/v1/cm/forceOrders Query User's CM Force Orders(USER_DATA)
PortfolioMarginApi get_cm_income_v1 GET /papi/v1/cm/income Get CM Income History(USER_DATA)
PortfolioMarginApi get_cm_leverage_bracket_v1 GET /papi/v1/cm/leverageBracket CM Notional and Leverage Brackets(USER_DATA)
PortfolioMarginApi get_cm_open_order_v1 GET /papi/v1/cm/openOrder Query Current CM Open Order (USER_DATA)
PortfolioMarginApi get_cm_open_orders_v1 GET /papi/v1/cm/openOrders Query All Current CM Open Orders(USER_DATA)
PortfolioMarginApi get_cm_order_amendment_v1 GET /papi/v1/cm/orderAmendment Query CM Modify Order History(TRADE)
PortfolioMarginApi get_cm_order_v1 GET /papi/v1/cm/order Query CM Order(USER_DATA)
PortfolioMarginApi get_cm_position_risk_v1 GET /papi/v1/cm/positionRisk Query CM Position Information(USER_DATA)
PortfolioMarginApi get_cm_position_side_dual_v1 GET /papi/v1/cm/positionSide/dual Get CM Current Position Mode(USER_DATA)
PortfolioMarginApi get_cm_user_trades_v1 GET /papi/v1/cm/userTrades CM Account Trade List(USER_DATA)
PortfolioMarginApi get_margin_all_order_list_v1 GET /papi/v1/margin/allOrderList Query Margin Account's all OCO (USER_DATA)
PortfolioMarginApi get_margin_all_orders_v1 GET /papi/v1/margin/allOrders Query All Margin Account Orders (USER_DATA)
PortfolioMarginApi get_margin_force_orders_v1 GET /papi/v1/margin/forceOrders Query User's Margin Force Orders(USER_DATA)
PortfolioMarginApi get_margin_margin_interest_history_v1 GET /papi/v1/margin/marginInterestHistory Get Margin Borrow/Loan Interest History(USER_DATA)
PortfolioMarginApi get_margin_margin_loan_v1 GET /papi/v1/margin/marginLoan Query Margin Loan Record(USER_DATA)
PortfolioMarginApi get_margin_max_borrowable_v1 GET /papi/v1/margin/maxBorrowable Margin Max Borrow(USER_DATA)
PortfolioMarginApi get_margin_max_withdraw_v1 GET /papi/v1/margin/maxWithdraw Query Margin Max Withdraw(USER_DATA)
PortfolioMarginApi get_margin_my_trades_v1 GET /papi/v1/margin/myTrades Margin Account Trade List (USER_DATA)
PortfolioMarginApi get_margin_open_order_list_v1 GET /papi/v1/margin/openOrderList Query Margin Account's Open OCO (USER_DATA)
PortfolioMarginApi get_margin_open_orders_v1 GET /papi/v1/margin/openOrders Query Current Margin Open Order (USER_DATA)
PortfolioMarginApi get_margin_order_list_v1 GET /papi/v1/margin/orderList Query Margin Account's OCO (USER_DATA)
PortfolioMarginApi get_margin_order_v1 GET /papi/v1/margin/order Query Margin Account Order (USER_DATA)
PortfolioMarginApi get_margin_repay_loan_v1 GET /papi/v1/margin/repayLoan Query Margin repay Record(USER_DATA)
PortfolioMarginApi get_ping_v1 GET /papi/v1/ping Test Connectivity
PortfolioMarginApi get_portfolio_interest_history_v1 GET /papi/v1/portfolio/interest-history Query Portfolio Margin Negative Balance Interest History(USER_DATA)
PortfolioMarginApi get_portfolio_negative_balance_exchange_record_v1 GET /papi/v1/portfolio/negative-balance-exchange-record Query User Negative Balance Auto Exchange Record (USER_DATA)
PortfolioMarginApi get_rate_limit_order_v1 GET /papi/v1/rateLimit/order Query User Rate Limit (USER_DATA)
PortfolioMarginApi get_repay_futures_switch_v1 GET /papi/v1/repay-futures-switch Get Auto-repay-futures Status(USER_DATA)
PortfolioMarginApi get_um_account_config_v1 GET /papi/v1/um/accountConfig UM Futures Account Configuration(USER_DATA)
PortfolioMarginApi get_um_account_v1 GET /papi/v1/um/account Get UM Account Detail(USER_DATA)
PortfolioMarginApi get_um_account_v2 GET /papi/v2/um/account Get UM Account Detail V2(USER_DATA)
PortfolioMarginApi get_um_adl_quantile_v1 GET /papi/v1/um/adlQuantile UM Position ADL Quantile Estimation(USER_DATA)
PortfolioMarginApi get_um_all_orders_v1 GET /papi/v1/um/allOrders Query All UM Orders(USER_DATA)
PortfolioMarginApi get_um_api_trading_status_v1 GET /papi/v1/um/apiTradingStatus Portfolio Margin UM Trading Quantitative Rules Indicators(USER_DATA)
PortfolioMarginApi get_um_commission_rate_v1 GET /papi/v1/um/commissionRate Get User Commission Rate for UM(USER_DATA)
PortfolioMarginApi get_um_conditional_all_orders_v1 GET /papi/v1/um/conditional/allOrders Query All UM Conditional Orders(USER_DATA)
PortfolioMarginApi get_um_conditional_open_order_v1 GET /papi/v1/um/conditional/openOrder Query Current UM Open Conditional Order(USER_DATA)
PortfolioMarginApi get_um_conditional_open_orders_v1 GET /papi/v1/um/conditional/openOrders Query All Current UM Open Conditional Orders(USER_DATA)
PortfolioMarginApi get_um_conditional_order_history_v1 GET /papi/v1/um/conditional/orderHistory Query UM Conditional Order History(USER_DATA)
PortfolioMarginApi get_um_fee_burn_v1 GET /papi/v1/um/feeBurn Get UM Futures BNB Burn Status (USER_DATA)
PortfolioMarginApi get_um_force_orders_v1 GET /papi/v1/um/forceOrders Query User's UM Force Orders (USER_DATA)
PortfolioMarginApi get_um_income_asyn_id_v1 GET /papi/v1/um/income/asyn/id Get UM Futures Transaction Download Link by Id(USER_DATA)
PortfolioMarginApi get_um_income_asyn_v1 GET /papi/v1/um/income/asyn Get Download Id For UM Futures Transaction History (USER_DATA)
PortfolioMarginApi get_um_income_v1 GET /papi/v1/um/income Get UM Income History(USER_DATA)
PortfolioMarginApi get_um_leverage_bracket_v1 GET /papi/v1/um/leverageBracket UM Notional and Leverage Brackets (USER_DATA)
PortfolioMarginApi get_um_open_order_v1 GET /papi/v1/um/openOrder Query Current UM Open Order(USER_DATA)
PortfolioMarginApi get_um_open_orders_v1 GET /papi/v1/um/openOrders Query All Current UM Open Orders(USER_DATA)
PortfolioMarginApi get_um_order_amendment_v1 GET /papi/v1/um/orderAmendment Query UM Modify Order History(TRADE)
PortfolioMarginApi get_um_order_asyn_id_v1 GET /papi/v1/um/order/asyn/id Get UM Futures Order Download Link by Id(USER_DATA)
PortfolioMarginApi get_um_order_asyn_v1 GET /papi/v1/um/order/asyn Get Download Id For UM Futures Order History (USER_DATA)
PortfolioMarginApi get_um_order_v1 GET /papi/v1/um/order Query UM Order (USER_DATA)
PortfolioMarginApi get_um_position_risk_v1 GET /papi/v1/um/positionRisk Query UM Position Information(USER_DATA)
PortfolioMarginApi get_um_position_side_dual_v1 GET /papi/v1/um/positionSide/dual Get UM Current Position Mode(USER_DATA)
PortfolioMarginApi get_um_symbol_config_v1 GET /papi/v1/um/symbolConfig UM Futures Symbol Configuration(USER_DATA)
PortfolioMarginApi get_um_trade_asyn_id_v1 GET /papi/v1/um/trade/asyn/id Get UM Futures Trade Download Link by Id(USER_DATA)
PortfolioMarginApi get_um_trade_asyn_v1 GET /papi/v1/um/trade/asyn Get Download Id For UM Futures Trade History (USER_DATA)
PortfolioMarginApi get_um_user_trades_v1 GET /papi/v1/um/userTrades UM Account Trade List(USER_DATA)
PortfolioMarginApi update_cm_order_v1 PUT /papi/v1/cm/order Modify CM Order(TRADE)
PortfolioMarginApi update_listen_key_v1 PUT /papi/v1/listenKey Keepalive User Data Stream (USER_STREAM)
PortfolioMarginApi update_um_order_v1 PUT /papi/v1/um/order Modify UM Order(TRADE)

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKey

  • Type: API key
  • API key parameter name: X-MBX-APIKEY
  • Location: HTTP header

Author