Practical overview
When it fits
Use it when a Python program needs to make Poloniex API calls or subscribe to its WebSocket feed.
Who it is for
- Python developers connecting scripts or exchange tools to Poloniex.
- Developers collecting ticker, chart, trade-history or streaming market data.
- Developers making private API queries with Poloniex-issued credentials.
Documented uses
- Call API commands through a Python client or command-specific helper methods.
- Retrieve example data such as ticker values and chart data.
- Subscribe to WebSocket channels and process updates with callbacks.
- Query private account information such as balances using an API key and secret.
Requirements & limits
The repository describes Python 2.7 and Python 3+ support and gives a pip installation command for the poloniexapi package. Private API commands require a Poloniex API key and secret; the README's public ticker example does not pass credentials.
- The README provides both a general command-call interface and helper methods that sanitize command arguments.
- It describes command-name checks, a rate limiter and retries for failed calls during connection issues.
- WebSocket subscriptions use a separate PoloniexSocketed class and callbacks.
- The documented examples do not define a complete trading workflow or enumerate every supported API operation.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Install the Poloniex Python wrapper and request ticker data
Install the library and make a public ticker API call from Python.
Before you start
- Python 2.7 or Python 3+
- The
pipinstaller
Steps
Install the package with the command below.
pip install --upgrade poloniexapiIn a Python program, import
Poloniexwithfrom poloniex import Poloniex.Create a client with
polo = Poloniex()and request ticker data withprint(polo('returnTicker')).
Expected outcome
The program prints the response to the `returnTicker` API call.
Guide limitations
- The guide covers a public ticker request; private API commands require a Poloniex API key and secret.
- The README directs users to the project wiki or
help(poloniex)for additional usage details.
Subscribe to Poloniex websocket volume and ticker channels
Start a websocket client, receive callbacks for volume and ticker updates, then unsubscribe and stop it.
Before you start
- Python 2.7 or Python 3+
- The
poloniexapipackage installed - A Python environment that can connect to the Poloniex websocket API
Steps
Import
poloniex,logging, andsleepfromtime; enable logging withlogging.basicConfig()and setpoloniex.loggertologging.DEBUG.Define a callback such as
on_volume(data): print(data), createsock = poloniex.PoloniexSocketed(), and start the websocket withsock.startws(subscribe={'24hvolume': on_volume}).After allowing time for initialization, subscribe to the ticker with
sock.subscribe(chan='ticker', callback=print).Unsubscribe with
sock.unsubscribe(1002)and stop the websocket withsock.stopws(), allowing time between operations as shown in the project example.
Expected outcome
The example receives websocket callbacks for the subscribed channels, unsubscribes from ticker, and stops the websocket thread.
Guide limitations
- The example uses sleeps to allow initialization and subscription activity; it does not specify a general timing guarantee.
- Channel names or integer IDs can be used for subscribe and unsubscribe operations; the example uses the ticker ID
1002when unsubscribing.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 16 October 2026
- Original website title
- s4w3d0ff/python-poloniex · Official homepage title · retained in its source language

