Skip to content

Latest commit

 

History

History
142 lines (103 loc) · 4.39 KB

README.md

File metadata and controls

142 lines (103 loc) · 4.39 KB
Raw

BingX API Connector Python

PYPI version Python version License: GPLv3

📌 About The Project

This is a Python package for bingX API, aims to provide a simple and easy-to-use interface for developers to access bingX API.

📌 Installation

pip install bingX-connector     # install from pypi
pip install -U bingX-connector  # upgrade the package to the latest version

Please always upgrade to the latest version to ensure the latest features and bug fixes

📌 Features

  • Standard Contract
  • Standard Contract Web Socket
  • Spot
  • Spot Web Socket
  • Perpetual v1
  • Perpetual v1 Web Socket
  • Perpetual v2
  • Perpetual v2 Web Socket

📌 Usage

Standard Contract

from bingX.standard import Standard

client = Standard(api_key, api_secret)

Spot

from bingX.spot import Spot

client = Spot(api_key, api_secret)

Perpetual v1

from bingX.perpetual.v1 import Perpetual

client = Perpetual(api_key, api_secret)

Perpetual v2

from bingX.perpetual.v2 import Perpetual

client = Perpetual(api_key, api_secret)

Note that you can not import Perpetual v1 and Perpetual v2 at the same time

For More Information, please look at the bingX API document

📌 Report a bug

  • Please follow the below guidelines if you would like to report a bug:

    1. Use the GitHub issue search — check if the issue has already been reported.

    2. Check if the issue has been fixed — try to reproduce it using the latest main or development branch in the repository.

    3. Isolate the problem — create a reduced test case and a live example.

    Example:

    Short and descriptive example bug report title

    A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

    1. This is the first step
    2. This is the second step
    3. Further steps, etc.

    <url> - a link to the reduced test case

    Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

📌 Contribute

  • Follow this process if you'd like your work considered for inclusion in the project

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/<username>/bingX-connector-python.git
# Navigate to the newly cloned directory
cd bingX-connector-python
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/Ming119/bingX-connector-python

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout <dev-branch>
git pull upstream <dev-branch>

  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream <dev-branch>

  5. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  6. Open a Pull Request with a clear title and description.

IMPORTANT: By submitting a patch, you agree to allow us to license your work under the same license as that used by bingX-connector-python