Skip to main content

A simple connector to BingX Public API

Project description

BingX API Connector Python2

PYPI version Python version License: GPLv3

📌 Please note:

This package is a minor update to bingX-connector. I have opened a pull request as Ming119 instructed in their repoistory. After opening the pull request and mailing them directly and asking them to merge, I got no answer. Therefore, I am publishing this new update with the similar name. This package may be deprecated after they merge.

Keep in mind that for Perpetual v1, no changes were made, so you cannot work demo with that.

Link to My Pull Request Link to Git Repository Link to my GitHub

The rest of README.md file provided by Ming119:

📌 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 (Demo)
  • Standard Contract (Real)
  • Standard Contract Web Socket
  • Spot (Demo)
  • Spot (Real)
  • Spot Web Socket
  • Perpetual v1
  • Perpetual v1 Web Socket
  • Perpetual v2 (Demo)
  • Perpetual v2 (Real)
  • Perpetual v2 Web Socket

📌 Usage

Standard Contract

from bingX.standard import Standard
# by defaul, you're using demo
client = Standard(api_key, api_secret)
# or
client = Standard(api_key, api_secret, mode='demo')

Spot

from bingX.spot import Spot
# by defaul, you're using demo
client = Spot(api_key, api_secret)
# or
client = Spot(api_key, api_secret, mode='demo')
# use mode='real' to interact with your real account

Perpetual v1

from bingX.perpetual.v1 import Perpetual
client = Perpetual(api_key, api_secret)

Perpetual v2

from bingX.perpetual.v2 import Perpetual

# by defaul, you're using demo
client = Perpetual(api_key, api_secret)
#or
client = Perpetual(api_key, api_secret, mode='demo')
# use mode='real' to interact with your real account

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bingx_connector2-0.0.8.tar.gz (26.5 kB view details)

Uploaded Source

Built Distribution

bingX_connector2-0.0.8-py3-none-any.whl (32.6 kB view details)

Uploaded Python 3

File details

Details for the file bingx_connector2-0.0.8.tar.gz.

File metadata

  • Download URL: bingx_connector2-0.0.8.tar.gz
  • Upload date:
  • Size: 26.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for bingx_connector2-0.0.8.tar.gz
Algorithm Hash digest
SHA256 994b4f141cc087ca7836dae1ed56ecb07378abd6a8e74be7ae095eda5aa9e239
MD5 323b11132af30b3e7b244e15947e4c01
BLAKE2b-256 79901eb8b6d5237c5c6136fa2acf321addc49de11bd5830fc2a7f1f60093b1dd

See more details on using hashes here.

File details

Details for the file bingX_connector2-0.0.8-py3-none-any.whl.

File metadata

File hashes

Hashes for bingX_connector2-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 096650c682d9658837937d3e1ac40c307797a88b131c3f4dc1283f956c001590
MD5 2717df08d45caec256be78753f8c5ea3
BLAKE2b-256 f2576f6771bb575f8b760e8ecc35633f306bec0bb1c5d15742e1c8cc086a3a9a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page