mijin-openapi-client

OpenAPI Specification of catapult-rest

The mijin_openapi_client package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.4
  • Package version: 1.0.0
  • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

  • urllib3 >= 1.25.3, < 3.0.0
  • python-dateutil >= 2.8.2
  • pydantic >= 2
  • typing-extensions >= 4.7.1

Getting Started

In your own code, to use this library to connect and interact with mijin-openapi-client, you can run the following:

import mijin_openapi_client
from mijin_openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:3000
# See configuration.py for a list of all supported configuration parameters.
configuration = mijin_openapi_client.Configuration(
    host = "http://localhost:3000"
)



# Enter a context with an instance of the API client
with mijin_openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mijin_openapi_client.AccountRoutesApi(api_client)
    account_id = 'account_id_example' # str | Account public key or address encoded using a 32-character set.

    try:
        # Get account information
        api_response = api_instance.get_account_info(account_id)
        print("The response of AccountRoutesApi->get_account_info:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountRoutesApi->get_account_info: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:3000

Class Method HTTP request Description
AccountRoutesApi get_account_info GET /accounts/{accountId} Get account information
AccountRoutesApi get_account_info_merkle GET /accounts/{accountId}/merkle Get account merkle information
AccountRoutesApi get_accounts_info POST /accounts Get accounts information
AccountRoutesApi search_accounts GET /accounts Search accounts
BlockRoutesApi get_block_by_height GET /blocks/{height} Get block information
BlockRoutesApi get_merkle_receipts GET /blocks/{height}/statements/{hash}/merkle Get the merkle path for a given a receipt statement hash and block
BlockRoutesApi get_merkle_transaction GET /blocks/{height}/transactions/{hash}/merkle Get the merkle path for a given a transaction and block
BlockRoutesApi search_blocks GET /blocks Search blocks
ChainRoutesApi get_chain_info GET /chain/info Get the current information of the chain
FinalizationRoutesApi get_finalization_proof_at_epoch GET /finalization/proof/epoch/{epoch} Get finalization proof
FinalizationRoutesApi get_finalization_proof_at_height GET /finalization/proof/height/{height} Get finalization proof
HashLockRoutesApi get_hash_lock GET /lock/hash/{hash} Get hash lock information
HashLockRoutesApi get_hash_lock_merkle GET /lock/hash/{hash}/merkle Get hash lock merkle information
HashLockRoutesApi search_hash_lock GET /lock/hash Search hash lock entries
MetadataRoutesApi get_metadata GET /metadata/{compositeHash} Get metadata information
MetadataRoutesApi get_metadata_merkle GET /metadata/{compositeHash}/merkle Get metadata merkle information
MetadataRoutesApi search_metadata_entries GET /metadata Search metadata entries
MosaicRoutesApi get_mosaic GET /mosaics/{mosaicId} Get mosaic information
MosaicRoutesApi get_mosaic_merkle GET /mosaics/{mosaicId}/merkle Get mosaic merkle information
MosaicRoutesApi get_mosaics POST /mosaics Get mosaics information for an array of mosaics
MosaicRoutesApi search_mosaics GET /mosaics Search mosaics
MultisigRoutesApi get_account_multisig GET /account/{address}/multisig Get multisig account information
MultisigRoutesApi get_account_multisig_graph GET /account/{address}/multisig/graph Get multisig account graph information
MultisigRoutesApi get_account_multisig_merkle GET /account/{address}/multisig/merkle Get multisig account merkle information
NamespaceRoutesApi get_accounts_names POST /namespaces/account/names Get readable names for a set of accountIds
NamespaceRoutesApi get_mosaics_names POST /namespaces/mosaic/names Get readable names for a set of mosaics
NamespaceRoutesApi get_namespace GET /namespaces/{namespaceId} Get namespace information
NamespaceRoutesApi get_namespace_merkle GET /namespaces/{namespaceId}/merkle Get namespace merkle information
NamespaceRoutesApi get_namespaces_names POST /namespaces/names Get readable names for a set of namespaces
NamespaceRoutesApi search_namespaces GET /namespaces Search namespaces
NetworkRoutesApi get_network_properties GET /network/properties Get the network properties
NetworkRoutesApi get_network_type GET /network Get the current network type of the chain
NetworkRoutesApi get_rental_fees GET /network/fees/rental Get rental fees information
NetworkRoutesApi get_transaction_fees GET /network/fees/transaction Get transaction fees information
NodeRoutesApi get_node_health GET /node/health Get the node health information
NodeRoutesApi get_node_info GET /node/info Get the node information
NodeRoutesApi get_node_peers GET /node/peers Get peers information
NodeRoutesApi get_node_storage GET /node/storage Get the storage information of the node
NodeRoutesApi get_node_time GET /node/time Get the node time
NodeRoutesApi get_server_info GET /node/server Get the version of the running REST component
NodeRoutesApi get_unlocked_account GET /node/unlockedaccount Get the unlocked harvesting account public keys.
ReceiptRoutesApi search_address_resolution_statements GET /statements/resolutions/address Get receipts address resolution statements
ReceiptRoutesApi search_mosaic_resolution_statements GET /statements/resolutions/mosaic Get receipts mosaic resolution statements
ReceiptRoutesApi search_receipts GET /statements/transaction Search transaction statements
RestrictionAccountRoutesApi get_account_restrictions GET /restrictions/account/{address} Get the account restrictions
RestrictionAccountRoutesApi get_account_restrictions_merkle GET /restrictions/account/{address}/merkle Get the account restrictions merkle
RestrictionAccountRoutesApi search_account_restrictions GET /restrictions/account Search account restrictions
RestrictionMosaicRoutesApi get_mosaic_restrictions GET /restrictions/mosaic/{compositeHash} Get the mosaic restrictions
RestrictionMosaicRoutesApi get_mosaic_restrictions_merkle GET /restrictions/mosaic/{compositeHash}/merkle Get the mosaic restrictions merkle
RestrictionMosaicRoutesApi search_mosaic_restrictions GET /restrictions/mosaic Search mosaic restrictions
SecretLockRoutesApi get_secret_lock GET /lock/secret/{compositeHash} Get secret lock information
SecretLockRoutesApi get_secret_lock_merkle GET /lock/secret/{compositeHash}/merkle Get secret lock merkle information
SecretLockRoutesApi search_secret_lock GET /lock/secret Search secret lock entries
TransactionRoutesApi announce_cosignature_transaction PUT /transactions/cosignature Announce a cosignature transaction
TransactionRoutesApi announce_partial_transaction PUT /transactions/partial Announce an aggregate bonded transaction
TransactionRoutesApi announce_transaction PUT /transactions Announce a new transaction
TransactionRoutesApi get_confirmed_transaction GET /transactions/confirmed/{transactionId} Get confirmed transaction information
TransactionRoutesApi get_confirmed_transactions POST /transactions/confirmed Get confirmed trasactions information
TransactionRoutesApi get_partial_transaction GET /transactions/partial/{transactionId} Get partial transaction information
TransactionRoutesApi get_partial_transactions POST /transactions/partial Get partial trasactions information
TransactionRoutesApi get_unconfirmed_transaction GET /transactions/unconfirmed/{transactionId} Get unconfirmed transaction information
TransactionRoutesApi get_unconfirmed_transactions POST /transactions/unconfirmed Get unconfirmed trasactions information
TransactionRoutesApi search_confirmed_transactions GET /transactions/confirmed Search confirmed transactions
TransactionRoutesApi search_partial_transactions GET /transactions/partial Search partial transactions
TransactionRoutesApi search_unconfirmed_transactions GET /transactions/unconfirmed Search unconfirmed transactions
TransactionStatusRoutesApi get_transaction_status GET /transactionStatus/{hash} Get transaction status
TransactionStatusRoutesApi get_transaction_statuses POST /transactionStatus Get transaction statuses

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for tech-bureau from gravatar.com tech-bureau

Credits

Author: Techbureau Contributors

Requires

Python >=3.9

Report project as malware

Metadata

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for tech-bureau from gravatar.com tech-bureau

Credits

Author: Techbureau Contributors

Requires

Python >=3.9

Report project as malware

Release files for mijin-openapi-client 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mijin-openapi-client 1.0.2
File Size Uploaded
mijin_openapi_client-1.0.2.tar.gz 149.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mijin-openapi-client 1.0.2
File Interpreter ABI Platform
mijin_openapi_client-1.0.2-py3-none-any.whl 450.7 kB Python 3 none any Details

Total release size: 599.7 kB

Release files / mijin_openapi_client-1.0.2.tar.gz

Download URL mijin_openapi_client-1.0.2.tar.gz
Size 149.0 kB
Tags Source
SHA-256 checksum
How to use checksums 		1ef2ce9425d501f76b358ce15a5c86219027a13e3361a75adc34cfcad075a269
BLAKE2b-256 checksum
How to use checksums 		bcc0bb6f77beb0fc4b6399b9351b859e406c0e28b19ba88c952e2b3bc6e63287
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/6.1.0 CPython/3.12.10

Release files / mijin_openapi_client-1.0.2-py3-none-any.whl

Download URL mijin_openapi_client-1.0.2-py3-none-any.whl
Size 450.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums 		0d08e7bf4b7c6f889fc29f1343d85436405734d624ee7b5dfcdbd265e33fd5a2
BLAKE2b-256 checksum
How to use checksums 		e1fc546d3d9ba8ec55500ddd529036bfc5f161ff383f0a1f549b7991fb6b85dd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via twine/6.1.0 CPython/3.12.10

Release history Release notifications | RSS feed

This release

1.0.2 This release

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page