Skip to content

Latest commit

 

History

History
197 lines (127 loc) · 3.54 KB

stakes_http_client.md

File metadata and controls

197 lines (127 loc) · 3.54 KB

swingby

This module contains various clients for interacting with the Swingby network

StakesHttpClient

StakesHttpClient(
    self,
    url,
    sendGetRequestFunc=<function default_send_get at 0x7f8f881f8cb0>,
    sendPostRequestFunc=<function default_send_post at 0x7f8f88206170>,
    *args,
    **kwargs)

NodeHttpClient includes functions for interacting with the Swingby network. For use simply initiate an instance of the NodeHttpClient With a url pointing to either your node or a Swingby hosted node. Example:

node = StakesHttpClient("https://staking-api.swingby.network")

get_leaderboard

StakesHttpClient.get_leaderboard(memo=None, page=1, page_size=25)

Get the staking leaderboards

Attributes

@param string memo - Weekly memo (none provided = current_memo) @param integer page - Page number @param integer page_size - Number of items per page

Returns

@return dict leaderboard @return array leaderboard.items @return integer leaderboard.itemCount @return integer leaderboard.total @return float leaderboard.totalStaked

get_floats

StakesHttpClient.get_floats()

Get network floats

Returns

@return object balances @return object balances.BTC @return object balances.BNB

get_platform_status

StakesHttpClient.get_platform_status()

Gets the status of the platform (0 = offline, 1 = online, 3 = maintenance)

Returns

@return integer status

get_rewards_leaderboard

StakesHttpClient.get_rewards_leaderboard(memo=None,
                                         page=1,
                                         page_size=25)

Gets the staking rewards leaderboard

Attributes

@param string memo - Weekly memo (none provided = current_memo) @param integer page - Page number @param integer page_size - Number of items per page

Returns

@return dict leaderboard @return array leaderboard.items @return integer leaderboard.itemCount @return integer leaderboard.total

get_holders

StakesHttpClient.get_holders(memo=None)

Gets the holders on the network - All addresses that own Swingby tokens

Attributes

@param string memo - Weekly memo (none provided = current_memo)

Returns

@return object holders @return float holders[address].quantity @return float holders[address].percentage

get_payout

StakesHttpClient.get_payout(memo=None)

Generate the staking rewards payout transaction (un-signed)

Attributes

@param string memo - Weekly memo (none provided = current_memo)

Returns

@return object payout @return integer payout.totalTransactions @return string payout.estimatedPayout @return array payout.holders

get_rewards_history

StakesHttpClient.get_rewards_history(address)

Get all rewards for the given address

Returns

@return object payout @return integer payout.totalTransactions @return string payout.estimatedPayout @return array payout.holders

get_weekly_memo

StakesHttpClient.get_weekly_memo()

Get the weekly memo

Returns

@return string memo

get_stakes

StakesHttpClient.get_stakes(address=None, memo=None)

Get the network stakes

Returns

@return array stakes @return string stakes[n].address @return string stakes[n].staked_amount @return string stakes[n].reward_amount @return string stakes[n].weekly_memo

get_token_info

StakesHttpClient.get_token_info()

Get token info

Returns

@return object info

get_token_balance

StakesHttpClient.get_token_balance(address)

Get token balance

Returns

@return object info