skyapi 0.26.0

Skycoin REST API.

skyapi

Skycoin is a next-generation cryptocurrency.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.26.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://skycoin.net

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import skyapi 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import skyapi

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import skyapi
from skyapi.rest import ApiException
from pprint import pprint


# create an instance of the API class
api_instance = skyapi.DefaultApi(skyapi.ApiClient(configuration))

try:
    # Returns the total number of unique address that have coins.
    api_response = api_instance.address_count()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->address_count: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:6420

Class	Method	HTTP request	Description
DefaultApi	address_count	GET /api/v1/addresscount	Returns the total number of unique address that have coins.
DefaultApi	address_uxouts	GET /api/v1/address_uxouts
DefaultApi	api_v1_rawtx_get	GET /api/v1/rawtx
DefaultApi	api_v2_metrics_get	GET /api/v2/metrics
DefaultApi	balance_get	GET /api/v1/balance	Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
DefaultApi	balance_post	POST /api/v1/balance	Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
DefaultApi	block	GET /api/v1/block	Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
DefaultApi	blockchain_metadata	GET /api/v1/blockchain/metadata	Returns the blockchain metadata.
DefaultApi	blockchain_progress	GET /api/v1/blockchain/progress	Returns the blockchain sync progress.
DefaultApi	blocks	GET /api/v1/blocks	Returns the balance of one or more addresses, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
DefaultApi	coin_supply	GET /api/v1/coinSupply
DefaultApi	csrf	GET /api/v1/csrf	Creates a new CSRF token. Previous CSRF tokens are invalidated by this call.
DefaultApi	data_delete	DELETE /api/v2/data
DefaultApi	data_get	GET /api/v2/data
DefaultApi	data_post	POST /api/v2/data
DefaultApi	default_connections	GET /api/v1/network/defaultConnections	defaultConnectionsHandler returns the list of default hardcoded bootstrap addresses.\n They are not necessarily connected to.
DefaultApi	health	GET /api/v1/health	Returns node health data.
DefaultApi	last_blocks	GET /api/v1/last_blocks
DefaultApi	network_connection	GET /api/v1/network/connection	This endpoint returns a specific connection.
DefaultApi	network_connections	GET /api/v1/network/connections	This endpoint returns all outgoings connections.
DefaultApi	network_connections_disconnect	POST /api/v1/network/connection/disconnect
DefaultApi	network_connections_exchange	GET /api/v1/network/connections/exchange
DefaultApi	network_connections_trust	GET /api/v1/network/connections/trust	trustConnectionsHandler returns all trusted connections.\n They are not necessarily connected to. In the default configuration, these will be a subset of the default hardcoded bootstrap addresses.
DefaultApi	outputs_get	GET /api/v1/outputs	If neither addrs nor hashes are specificed, return all unspent outputs. If only one filter is specified, then return outputs match the filter. Both filters cannot be specified.
DefaultApi	outputs_post	POST /api/v1/outputs	If neither addrs nor hashes are specificed, return all unspent outputs. If only one filter is specified, then return outputs match the filter. Both filters cannot be specified.
DefaultApi	pending_txs	GET /api/v1/pendingTxs
DefaultApi	resend_unconfirmed_txns	POST /api/v1/resendUnconfirmedTxns
DefaultApi	richlist	GET /api/v1/richlist	Returns the top skycoin holders.
DefaultApi	transaction	GET /api/v1/transaction
DefaultApi	transaction_inject	POST /api/v1/injectTransaction	Broadcast a hex-encoded, serialized transaction to the network.
DefaultApi	transaction_post	POST /api/v2/transaction
DefaultApi	transaction_post_unspent	POST /api/v2/transaction/unspent
DefaultApi	transaction_raw	GET /api/v2/transaction/raw	Returns the hex-encoded byte serialization of a transaction. The transaction may be confirmed or unconfirmed.
DefaultApi	transaction_verify	POST /api/v2/transaction/verify
DefaultApi	transactions_get	GET /api/v1/transactions	Returns transactions that match the filters.
DefaultApi	transactions_post	POST /api/v1/transactions	Returns transactions that match the filters.
DefaultApi	uxout	GET /api/v1/uxout	Returns an unspent output by ID.
DefaultApi	verify_address	POST /api/v2/address/verify	Verifies a Skycoin address.
DefaultApi	version	GET /api/v1/version
DefaultApi	wallet	GET /api/v1/wallet	Returns a wallet by id.
DefaultApi	wallet_balance	GET /api/v1/wallet/balance	Returns the wallet's balance, both confirmed and predicted. The predicted balance is the confirmed balance minus the pending spends.
DefaultApi	wallet_create	POST /api/v1/wallet/create
DefaultApi	wallet_decrypt	POST /api/v1/wallet/decrypt	Decrypts wallet.
DefaultApi	wallet_encrypt	POST /api/v1/wallet/encrypt	Encrypt wallet.
DefaultApi	wallet_folder	GET /api/v1/wallets/folderName
DefaultApi	wallet_new_address	POST /api/v1/wallet/newAddress
DefaultApi	wallet_new_seed	GET /api/v1/wallet/newSeed
DefaultApi	wallet_recover	POST /api/v2/wallet/recover	Recovers an encrypted wallet by providing the seed. The first address will be generated from seed and compared to the first address of the specified wallet. If they match, the wallet will be regenerated with an optional password. If the wallet is not encrypted, an error is returned.
DefaultApi	wallet_seed	POST /api/v1/wallet/seed	This endpoint only works for encrypted wallets. If the wallet is unencrypted, The seed will be not returned.
DefaultApi	wallet_seed_verify	POST /api/v2/wallet/seed/verify	Verifies a wallet seed.
DefaultApi	wallet_transaction	POST /api/v1/wallet/transaction	Creates a signed transaction
DefaultApi	wallet_transaction_sign	POST /api/v2/wallet/transaction/sign	Creates a signed transaction
DefaultApi	wallet_transactions	GET /api/v1/wallet/transactions
DefaultApi	wallet_unload	POST /api/v1/wallet/unload	Unloads wallet from the wallet service.
DefaultApi	wallet_update	POST /api/v1/wallet/update	Update the wallet.
DefaultApi	wallets	GET /api/v1/wallets

Documentation For Models

• Address
• ApiV1PendingTxsTransaction
• ApiV1PendingTxsTransactionOutputs
• BlockSchema
• BlockSchemaBody
• BlockVerboseSchema
• BlockVerboseSchemaBody
• BlockVerboseSchemaHeader
• InlineResponse200
• InlineResponse2001
• InlineResponse20010
• InlineResponse2002
• InlineResponse2003
• InlineResponse2004
• InlineResponse2005
• InlineResponse2006
• InlineResponse2007
• InlineResponse2008
• InlineResponse2008Data
• InlineResponse2009
• InlineResponseDefault
• NetworkConnectionSchema
• NetworkConnectionSchemaUnconfirmedVerifyTransaction
• Transaction
• TransactionEncoded
• TransactionEncodedS
• TransactionStatus
• TransactionTxn
• TransactionV2ParamsAddress
• TransactionV2ParamsAddressHoursSelection
• TransactionV2ParamsUnspent
• TransactionV2ParamsUnspentHoursSelection
• TransactionV2ParamsUnspentTo
• TransactionVerbose
• TransactionVerboseTxn
• TransactionVerboseTxnInputs
• TransactionVerifyRequest
• WalletTransactionRequest
• WalletTransactionRequestHoursSelection
• WalletTransactionRequestWallet
• WalletTransactionSignRequest

Documentation For Authorization

csrfAuth

• Type: API key
• API key parameter name: X-CSRF-TOKEN
• Location: HTTP header

Author

[e-mail]