pyxt

Name	pyxt JSON
Version	0.6.24 JSON
	download
home_page	https://github.com/kelvinxue/pyxt
Summary	Python3 XT.COM HTTP API Connector
upload_time	2024-11-20 07:54:01
maintainer	None
docs_url	None
author	xt
requires_python	>=3.9
license	MIT License
keywords	xt api connector
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI
coveralls test coverage	No coveralls.

            # pyxt
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

Official Python3 API connector for XT.COM's HTTP APIs.

## Table of Contents

- [About](#about)
- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [Contact](#contact)

## About
Put simply, `pyxt` (Python + XT.COM) is the official lightweight one-stop-shop module for the XT.COM HTTP APIs. 

## Installation
`pyxt` requires Python 3.9.1 or higher. The module can be installed manually or via [PyPI](https://pypi.org/project/pyxt/) with `pip`:
```
pip install pyxt
```

## Usage
You can retrieve a specific spot market like so:
```python
from pyxt.spot import Spot
```

Create an HTTP session and connect via WebSocket for Inverse on mainnet:
```python
xt = Spot(host="https://sapi.xt.com", access_key='', secret_key='')
```

Information can be sent to, or retrieved from, the XT.COM APIs:
```python
print(xt.balance("usdt"))
```

You can retrieve a specific future market like so:
```python
from pyxt.perp import Perp
```

Create an HTTP session and connect via WebSocket for Inverse on mainnet:
```python
xt = Perp(host="https://fapi.xt.com", access_key='', secret_key='')
```

Information can be sent to, or retrieved from, the XT.COM APIs:
```python
print(xt.get_account_capital())
```

## Examples
You can find more examples in the project folder /examples/

## Contact
You can reach out for support on the [XTAPI Telegram](https://t.me/XT_api) group chat.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/kelvinxue/pyxt",
    "name": "pyxt",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "xt api connector",
    "author": "xt",
    "author_email": "xt@xt.com",
    "download_url": "https://files.pythonhosted.org/packages/b3/e8/96a6cd182bbb4b0ba467f436e3c5dae8fd5371df91f17f3d0a5c69041bd4/pyxt-0.6.24.tar.gz",
    "platform": null,
    "description": "# pyxt\n<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->\n[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)\n<!-- ALL-CONTRIBUTORS-BADGE:END -->\n\nOfficial Python3 API connector for XT.COM's HTTP APIs.\n\n## Table of Contents\n\n- [About](#about)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Examples](#examples)\n- [Contact](#contact)\n\n## About\nPut simply, `pyxt` (Python + XT.COM) is the official lightweight one-stop-shop module for the XT.COM HTTP APIs. \n\n## Installation\n`pyxt` requires Python 3.9.1 or higher. The module can be installed manually or via [PyPI](https://pypi.org/project/pyxt/) with `pip`:\n```\npip install pyxt\n```\n\n## Usage\nYou can retrieve a specific spot market like so:\n```python\nfrom pyxt.spot import Spot\n```\n\nCreate an HTTP session and connect via WebSocket for Inverse on mainnet:\n```python\nxt = Spot(host=\"https://sapi.xt.com\", access_key='', secret_key='')\n```\n\nInformation can be sent to, or retrieved from, the XT.COM APIs:\n```python\nprint(xt.balance(\"usdt\"))\n```\n\nYou can retrieve a specific future market like so:\n```python\nfrom pyxt.perp import Perp\n```\n\nCreate an HTTP session and connect via WebSocket for Inverse on mainnet:\n```python\nxt = Perp(host=\"https://fapi.xt.com\", access_key='', secret_key='')\n```\n\nInformation can be sent to, or retrieved from, the XT.COM APIs:\n```python\nprint(xt.get_account_capital())\n```\n\n## Examples\nYou can find more examples in the project folder /examples/\n\n## Contact\nYou can reach out for support on the [XTAPI Telegram](https://t.me/XT_api) group chat.\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Python3 XT.COM HTTP API Connector",
    "version": "0.6.24",
    "project_urls": {
        "Download": "https://github.com/kelvinxue/pyxt/archive/refs/tags/v0.6.24.tar.gz",
        "Homepage": "https://github.com/kelvinxue/pyxt"
    },
    "split_keywords": [
        "xt",
        "api",
        "connector"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b3e896a6cd182bbb4b0ba467f436e3c5dae8fd5371df91f17f3d0a5c69041bd4",
                "md5": "e368a72f0d33886ec381166bed1e0a3c",
                "sha256": "942149c9d07fbceeb738c2f4a89e9959a0fa2f32236f1717467ab6e3a3bd55a7"
            },
            "downloads": -1,
            "filename": "pyxt-0.6.24.tar.gz",
            "has_sig": false,
            "md5_digest": "e368a72f0d33886ec381166bed1e0a3c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 17816,
            "upload_time": "2024-11-20T07:54:01",
            "upload_time_iso_8601": "2024-11-20T07:54:01.480578Z",
            "url": "https://files.pythonhosted.org/packages/b3/e8/96a6cd182bbb4b0ba467f436e3c5dae8fd5371df91f17f3d0a5c69041bd4/pyxt-0.6.24.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-20 07:54:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kelvinxue",
    "github_project": "pyxt",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "pyxt"
}