API Documentation¶
client.api.blocks.Blocks¶
all()¶
def all(self, page=None, limit=100, **kwargs)
List All Blocks.
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| int | page | No | Pagination |
| int | limit | No | Result limits |
| any | **kwargs | No | Query parameters |
Return value¶
<class 'dict'>
get()¶
def get(self, block_id)
Retrieve a Block
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| int | block_id | Yes | Block ID |
Return value¶
<class 'dict'>
transactions()¶
def transactions(self, block_id, page=None, limit=100)
List All Transactions of a Block
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| str | block_id | Yes | Block ID |
| int | page | No | Pagination |
| int | limit | No | Query parameters |
Return value¶
<class 'dict'>
search()¶
def search(self, criteria, page=None, limit=100)
Search All Blocks
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| dict | criteria | Yes | Search parameters |
| int | page | No | Pagination |
| int | limit | No | Result limit |
Return value¶
<class 'dict'>
client.api.delegates.Delegates¶
all()¶
def all(self, page=None, limit=100, **kwargs)
List All Delegates
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| int | page | No | Pagination |
| int | limit | No | Result limits |
| any | **kwargs | No | Query parameters |
Return value¶
<class 'dict'>
get()¶
def get(self, delegate_id)
Retrieve a Delegate
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| int | delegate_id | Yes | Delegate identifier |
Return value¶
<class 'dict'>
search()¶
def search(self, username, page=None, limit=100)
Search Delegates
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| str | username | Yes | Delegate username |
| int | page | No | Pagination |
| int | limit | No | Result limits |
Return value¶
<class 'dict'>
blocks()¶
def blocks(self, delegate_id, page=None, limit=100)
List All Blocks of a Delegate
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| str | delegate_id | Yes | Delegate identifier |
| int | page | No | Pagination |
| int | limit | No | Result limits |
Return value¶
<class 'dict'>
voters()¶
def voters(self, delegate_id, page=None, limit=100, **kwargs)
List All Voters of a Delegate
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| str | delegate_id | Yes | Delegate identifier |
| int | page | No | Pagination |
| int | limit | No | Result limits |
| any | **kwargs | No | Query parameters |
Return value¶
<class 'dict'>
client.api.node.Node¶
configuration()¶
def configuration(self)
Retrieve the Configuration
Return value¶
<class 'dict'>
status()¶
def status(self)
Retrieve the Status
Return value¶
<class 'dict'>
syncing()¶
def syncing(self)
Retrieve the Syncing Status
Return value¶
<class 'dict'>
fees()¶
def fees(self, days=None)
Retrieve the Fees
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| int | days | No | ... |
Return value¶
<class 'dict'>
client.api.peers.Peers¶
all()¶
def all(self, os=None, status=None, port=None, version=None, order_by=None, page=None, limit=100)
List All Peers
Parameters¶
| Type | Name | Required | Description s |
|---|---|---|---|
| str | os | No | Operating System |
| str | status | No | Peer status |
| int | port | No | Peer port |
| str | version | No | Peer version |
| str | order_by | No | Order by |
| int | page | No | Pagination |
| int | limit | No | Result limit |
Return value¶
<class 'dict'>
get()¶
def get(self, ip)
Retrieve a Peer
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| str | ip | Yes | IP address |
Return value¶
<class 'dict'>
client.api.transactions.Transactions¶
create()¶
def create(self, transactions)
Create a Transaction
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| list | transactions | Yes | Transaction to broadcast |
Return value¶
<class 'dict'>
get()¶
def get(self, transaction_id)
Retrieve a Transaction
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| str | transaction_id | Yes | Transaction ID |
Return value¶
<class 'dict'>
all()¶
def all(self, page=None, limit=100, **kwargs)
List All Transactions
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| int | page | No | Pagination |
| int | limit | No | Result limit |
| any | **kwargs | No | Query parameters |
Return value¶
<class 'dict'>
all_unconfirmed()¶
def all_unconfirmed(self, limit=100, offset=None, **kwargs)
List All Unconfirmed Transactions
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| int | limit | No | Result limit |
| int | offset | No | Offset |
| any | **kwargs | No | Query parameters |
Return value¶
<class 'dict'>
get_unconfirmed()¶
def get_unconfirmed(self, transaction_id)
Get Unconfirmed Transaction
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| str | transaction_id | Yes | Transaction ID |
Return value¶
<class 'dict'>
search()¶
def search(self, criteria, page=None, limit=100)
Search Transactions
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| dict | criteria | Yes | Search parameters |
| int | page | No | Pagination |
| int | limit | No | Result limit |
Return value¶
<class 'dict'>
types()¶
def types(self)
List Transaction Types
Return value¶
<class 'dict'>
fees()¶
def fees(self)
List Transaction Fees (Non-Dynamic)
Return value¶
<class 'dict'>
client.api.votes.Votes¶
all()¶
def all(self, page=None, limit=100)
List All Votes
Parameters¶
| Type | Name | Required | Description s |
|---|---|---|---|
| int | page | No | Pagination |
| int | limit | No | Result limit |
Return value¶
<class 'dict'>
get()¶
def get(self, vote_id)
Retrieve a Vote
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| str | vote_id | Yes | Vote IDs |
Return value¶
<class 'dict'>
client.api.wallets.Wallets¶
all()¶
def all(self, page=None, limit=100)
Retrieve All Wallets
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| int | page | No | Pagination |
| int | limit | No | Result limit |
Return value¶
<class 'dict'>
get()¶
def get(self, wallet_id)
Retrieve a Wallet
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| str | wallet_id | Yes | Wallet identifier |
Return value¶
<class 'dict'>
transactions()¶
def transactions(self, wallet_id ,page=None, limit=100, **kwargs)
List All Transactions of a Wallet
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| str | wallet_id | Yes | Wallet identifier |
| int | page | No | Pagination |
| int | limit | No | Result limit |
| any | **kwargs | No | Query parameters |
Return value¶
<class 'dict'>
transactions_received()¶
def transactions_received(self, wallet_id, page=None, limit=100)
List All Received Transactions of a Wallet
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| str | wallet_id | Yes | Wallet identifier |
| int | page | No | Pagination |
| int | limit | No | Result limit |
Return value¶
<class 'dict'>
transactions_sent()¶
def transactions_sent(self, wallet_id, page=None, limit=100)
List All Sent Transactions of a Wallet
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| str | wallet_id | Yes | Wallet identifier |
| int | page | No | Pagination |
| int | limit | No | Result limit |
Return value¶
<class 'dict'>
votes()¶
def votes(self, wallet_id,page=None, limit=100)
List All Votes of a Wallet
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| str | wallet_id | Yes | Wallet identifier |
| int | page | No | Pagination |
| int | limit | No | Result limit |
Return value¶
<class 'dict'>
top()¶
def top(self, page=None, limit=100)
List All Top Wallets
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| int | page | No | Pagination |
| int | limit | No | Result limit |
Return value¶
<class 'dict'>
search()¶
def search(self, criteria, page=None, limit=100)
Search All Wallets
Parameters¶
| Type | Name | Required | Description |
|---|---|---|---|
| dict | criteria | Yes | Search parameters |
| int | page | No | Pagination |
| int | limit | No | Result limit |
Return value¶
<class 'dict'>