Skip to main content

Unofficial python3 FTX exchange API 1.2.0

Project description

# FTX Python client

A Unofficial Python3 library to interact with [FTX’s](https://ftx.com/) API. The library can be used to fetch market data, make trades, place orders or create third-party clients.

For more information, see [the FTX documentation.](https://docs.ftx.com/)

## Installation

$ pip install ftx

## Quickstart

This is an introduction on how to get started with FTX client. First, make sure the FTX library is installed.

The next thing you need to do is import the library and get an instance of the client:

import ftx client = ftx.FtxClient()

### Get ordedrbook

Get the orderbook levels of bid/ask:

>>> import ftx
>>> client = ftx.FtxClient()
>>> result = client.get_orderbook('BTC/USD', 1)
>>> result
{'asks': [[11861.0, 1.778]], 'bids': [[11860.5, 0.1]]}
>>> result['asks']
[[11861.0, 1.778]]
>>> result['bids']
[[11860.5, 0.1]]

### Market’s Instrument data

The API supports fetching full data for one or multiple markets.

>>> client.get_market('BTC/USD')
{'ask': 11849.0, 'baseCurrency': 'BTC', 'bid': 11848.5, 'change1h': 0.00025325004220834034, 'change24h': 0.008983693106825051, 'changeBod': 0.006925855109411514, 'enabled': True, 'last': 11849.0, 'minProvideSize': 0.0001, 'name': 'BTC/USD', 'postOnly': False, 'price': 11849.0, 'priceIncrement': 0.5, 'quoteCurrency': 'USD', 'quoteVolume24h': 9271567.5201, 'restricted': False, 'sizeIncrement': 0.0001, 'type': 'spot', 'underlying': None, 'volumeUsd24h': 9271567.5201}

### Date ranges

Any time-based parameters accept Python datetime objects. All timestamps returned from FTX are UTC.

>>> client = ftx.FtxClient()
>>> client.get_trades('BTC/USD', 1, datetime.datetime(2020,8,20).timestamp())
[{'id': 88953674, 'liquidation': False, 'price': 11861.0, 'side': 'sell', 'size': 0.0105, 'time': '2020-08-20T17:33:19.115690+00:00'}]

### Authenticated endpoints

Private endpoints require authentication. Clients authenticate with an API key. For more information, see:[API keys](https://help.ftx.com/hc/en-us/articles/360044411911-FTX-Features-Overview#h_6a76d63d-e6cd-45db-87ab-5778af4e3b07)

To get an authenticated client instance:

>>> client = ftx.FtxClient(api_key=<YOUR API KEY>, api_secret=<YOUR API SECRET>)

If you try to access a private endpoint with an unauthenticated client, an error is raised. Calls to private endpoints work the same as regular ones:

client.get_open_orders(‘BTC/USD’)

## Advanced usage

### Placing orders

An order can be placed through the place_order() function. See [the API Documentation](https://docs.ftx.com/#place-order) for required and optional parameters.

client.place_order(‘BTC/USD’, ‘sell’, 12345.0, 10)

### Modifying orders

Orders can be modified by providing the original order ID.

>>> client.place_order('BTC/USD', 'sell', 12345.0, 10)
{"createdAt": "2020-08-20T17:33:19.115690+00:00","filledSize": 0,"id": 9596912,"market": "BTC/USD"...
>>> client.modify_order(9596912, 12500.0, 15).result()

### Canceling orders

An order can be canceled given the order ID:

client.cancel_order(9596912).result()

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

ftx-1.2.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

ftx-1.2.0-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file ftx-1.2.0.tar.gz.

File metadata

  • Download URL: ftx-1.2.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.2

File hashes

Hashes for ftx-1.2.0.tar.gz
Algorithm Hash digest
SHA256 e5b7d9fb680e612ea7b9cedfd673ad295a39ccda80f4cd1b55d1464a0b169f8f
MD5 65f2e669df6c5e943423112ca1d869e4
BLAKE2b-256 94b7fb1b79cd1105eacdb93565594b746907a0a019416e68494b2466ee58d7e0

See more details on using hashes here.

File details

Details for the file ftx-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: ftx-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.2

File hashes

Hashes for ftx-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0728b950354219c469af7eb5fc2aab20a8eb78009685bb961f912ea81203c51c
MD5 bbc2fe58569d02ff77d53a66f007ddb5
BLAKE2b-256 326a1eedabb67f752e91d6cefcc9de5186fced42f65e7d0a7ed5072fca1c6adb

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