Skip to main content

Python bindings for deriv.com websocket API

Project description

python-deriv-api

A python implementation of deriv api library.

PyPI Python 3.9.6 Test status

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.

Requirement

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 https://github.com/aaugustin/websockets/issues/1051. Please exclude python 3.9.7.

Installation

python3 -m pip install python_deriv_api

Usage

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) 

Creating a websockets connection and API instantiation

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)

Documentation

API reference

The complete API reference is hosted here

Examples here

Development

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

Run test

python setup.py pytest

or

pytest

or

make test

Generate documentations

Generate html version of the docs and publish it to gh-pages

make gh-pages

Build the package

make build

Run examples

set token and run example

export DERIV_TOKEN=xxxTokenxxx
PYTHONPATH=. python3 examples/simple_bot1.py

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

python_deriv_api-0.1.6.tar.gz (46.1 kB view details)

Uploaded Source

Built Distribution

python_deriv_api-0.1.6-py3-none-any.whl (40.8 kB view details)

Uploaded Python 3

File details

Details for the file python_deriv_api-0.1.6.tar.gz.

File metadata

  • Download URL: python_deriv_api-0.1.6.tar.gz
  • Upload date:
  • Size: 46.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.6

File hashes

Hashes for python_deriv_api-0.1.6.tar.gz
Algorithm Hash digest
SHA256 f267dcdf062ecff408c5af2dfd5de27f6040b694db1261c182ff37a96107aad7
MD5 6212c7d75264f81daf7caf4bab673c57
BLAKE2b-256 30925e87ca080ae5cbdca1d4c626da20b8c51db12d5ef1699d58835001e9eaa1

See more details on using hashes here.

File details

Details for the file python_deriv_api-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for python_deriv_api-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a07c8872487e19137fd602771ad310d3d924d67d4da906e8b0fd9437b824fce2
MD5 abcc79c40d291b6d8743e50575eb0c9f
BLAKE2b-256 59b1949fa2aff2000ca48d29e6aab8c8ea12c4b5591a7887ef5b9fd27a87bcd4

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