The ducoapi from alicia426

ducoapi's Introduction

Official DUCO module for Python 3

To build your own Duino-Coin apps we've created Duino-Coin API for Python 3.

Created by Connorhess, maintained by Alicia426

Getting Started

from ducoapi import api_actions

Initialize the connection to the server

api_connection = api_actions() #creates the api connection instance

The next step is to Login/Register Note: login and register do not require you to init but they close the connection after use

Login

api_connection.login(username="username", password="password")

Register

api_connection.register(username="username", password="password", email="[email protected]")

Functions

These functions require user being loged-in.

Balance

Gets the current balance of the logged-in user

api_connection.balance() # takes no args

Transfer

Transfers Duco from logged-in user to the specified username

api_connection.transfer(recipient_username='test_user1', amount=1)

reset password

Resets the password of the logged-in user

api_connection.reset_pass(old_password='123', new_password='abc')

Get Latests Transactions

Get the latests transactions

api_connection.getTransactions(7) # 7 is the number of transactions to get
# returns JSON

Other Functions

Use of this functions does not require being loged-in.

Get Duco Price

returns the current Duco price as a float

>>> ducoapi.get_duco_price()
0.01249

Duco price update timer

starts a timer that updates the price at a specified interval in seconds (default is 15)

>>> ducoapi.start_duco_price_timer(interval = 5) # start the timer that updates the price every 5 seconds
>>> ducoapi.duco_price # you can get the updated price from a global variable <duco_price>
0.01249

Example API script

import ducoapi

api_connection = api_actions()

api_connection.login(username='YourUsername', password='YourPassword')

current_balance = api_connection.balance()
print(current_balance)

api_connection.close()

ducoapi's People