A python implementation of deriv api library.
Go through api.deriv.com to know simple easy steps on how to register and get access. Use this all-in-one python library to set up and make your app running or you can extend it.
Python (3.9.6 or higher is recommended) and pip3
Note: There is bug in 'websockets' package with python 3.9.7, hope that will be fixed in 3.9.8 as mentioned in python-websockets/websockets#1051. Please exclude python 3.9.7.
python3 -m pip install python_deriv_api
This is basic deriv-api python library which helps to make websockets connection and deal the API calls (including subscription).
Import the module
from deriv_api import DerivAPI
Access
api = DerivAPI(endpoint='ws://...', app_id=1234);
response = await api.ping({'ping': 1})
print(response)
You can either create an instance of websockets and pass it as connection or pass the endpoint and app_id to the constructor to create the connection for you.
If you pass the connection it's up to you to reconnect in case the connection drops (cause API doesn't know how to create the same connection).
- Pass the arguments needed to create a connection:
api = DerivAPI(endpoint='ws://...', app_id=1234);
- create and use a previously opened connection:
connection = await websockets.connect('ws://...')
api = DerivAPI(connection=connection)
The complete API reference is hosted here
Examples here
git clone https://github.com/binary-com/python-deriv-api
cd python-deriv-api
Setup environment
make setup
Setup environment and run test
make all
python setup.py pytest
or
pytest
or
make test
Generate html version of the docs and publish it to gh-pages
make gh-pages
make build
set token and run example
export DERIV_TOKEN=xxxTokenxxx
PYTHONPATH=. python3 examples/simple_bot1.py