Merge pull request #47 from semsorock/master

Add new API endpoints for Blockfrost API v0.1.86

Author: slowbackspace

.github/workflows/package-test.yml

@@ -11,12 +11,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.10", "3.12", "3.13"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

.github/workflows/publish-to-test-pypi.yml

@@ -16,11 +16,11 @@ jobs:
     name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v1
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: "3.12"
       - name: Install pypa/build
         run: >
           python -m

README.md

@@ -175,7 +175,7 @@ Install dependencies
 
 ```
 pip install -r requirements.txt
-pip install -r rest-requirements.txt
+pip install -r test-requirements.txt
 ```
 
 Install package

blockfrost/api/__init__.py

@@ -23,7 +23,7 @@ def root(self, **kwargs):
         """
         Root endpoint has no other function than to point end users to documentation.
 
-        https://docs.blockfrost.io/#tag/Health/paths/~1/get
+        https://docs.blockfrost.io/#tag/health/GET/
         :param return_type: Optional. "object", "json" or "pandas". Default: "object".
         :type return_type: str
         :returns RootResponse object.
@@ -57,7 +57,9 @@ def root(self, **kwargs):
         account_mirs, \
         account_addresses, \
         account_addresses_assets, \
-        account_addresses_total
+        account_addresses_total, \
+        account_utxos, \
+        account_transactions
     from .cardano.addresses import \
         address, \
         address_extended, \
@@ -75,12 +77,14 @@ def root(self, **kwargs):
     from .cardano.blocks import \
         block_latest, \
         block_latest_transactions, \
+        block_latest_transactions_cbor, \
         block, \
         block_slot, \
         block_epoch_slot, \
         blocks_next, \
         blocks_previous, \
         block_transactions, \
+        block_transactions_cbor, \
         blocks_addresses
     from .cardano.epochs import \
         epoch_latest, \
@@ -104,7 +108,8 @@ def root(self, **kwargs):
         metadata_label_json, \
         metadata_label_cbor
     from .cardano.network import \
-        network
+        network, \
+        network_eras
     from .cardano.pools import \
         pools, \
         pools_extended, \
@@ -116,7 +121,8 @@ def root(self, **kwargs):
         pool_relays, \
         pool_delegators, \
         pool_blocks, \
-        pool_updates
+        pool_updates, \
+        pool_votes
     from .cardano.transactions import \
         transaction, \
         transaction_utxos, \
@@ -131,6 +137,8 @@ def root(self, **kwargs):
         transaction_submit, \
         transaction_submit_cbor, \
         transaction_redeemers, \
+        transaction_required_signers, \
+        transaction_cbor, \
         transaction_evaluate, \
         transaction_evaluate_cbor, \
         transaction_evaluate_utxos
@@ -142,5 +150,23 @@ def root(self, **kwargs):
         script_redeemers, \
         script_datum, \
         script_datum_cbor
+    from .cardano.governance import \
+        governance_dreps, \
+        governance_drep, \
+        governance_drep_delegators, \
+        governance_drep_metadata, \
+        governance_drep_updates, \
+        governance_drep_votes, \
+        governance_proposals, \
+        governance_proposal, \
+        governance_proposal_parameters, \
+        governance_proposal_withdrawals, \
+        governance_proposal_votes, \
+        governance_proposal_metadata, \
+        governance_proposal_by_gov_action_id, \
+        governance_proposal_parameters_by_gov_action_id, \
+        governance_proposal_withdrawals_by_gov_action_id, \
+        governance_proposal_votes_by_gov_action_id, \
+        governance_proposal_metadata_by_gov_action_id
     from .cardano.utils import \
         utils_addresses_xpub

blockfrost/api/cardano/accounts.py

@@ -7,7 +7,7 @@ def accounts(self, stake_address: str, **kwargs):
     """
     Obtain information about a specific networkStake account.
 
-    https://docs.blockfrost.io/#tag/Cardano-Accounts/paths/~1accounts~1{stake_address}/get
+    https://docs.blockfrost.io/#tag/cardano--accounts/GET/accounts/{stake_address}
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
@@ -29,7 +29,7 @@ def account_rewards(self, stake_address: str, **kwargs):
     """
     Obtain information about the history of a specific account.
 
-    https://docs.blockfrost.io/#tag/Cardano-Accounts/paths/~1accounts~1{stake_address}~1rewards/get
+    https://docs.blockfrost.io/#tag/cardano--accounts/GET/accounts/{stake_address}/rewards
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
@@ -60,7 +60,7 @@ def account_history(self, stake_address: str, **kwargs):
     """
     Obtain information about the history of a specific account.
 
-    https://docs.blockfrost.io/#tag/Cardano-Accounts/paths/~1accounts~1{stake_address}~1history/get
+    https://docs.blockfrost.io/#tag/cardano--accounts/GET/accounts/{stake_address}/history
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
@@ -91,7 +91,7 @@ def account_delegations(self, stake_address: str, **kwargs):
     """
     Obtain information about the delegation of a specific account.
 
-    https://docs.blockfrost.io/#tag/Cardano-Accounts/paths/~1accounts~1{stake_address}~1delegations/get
+    https://docs.blockfrost.io/#tag/cardano--accounts/GET/accounts/{stake_address}/delegations
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
@@ -122,7 +122,7 @@ def account_registrations(self, stake_address: str, **kwargs):
     """
     Obtain information about the registrations and deregistrations of a specific account.
 
-    https://docs.blockfrost.io/#tag/Cardano-Accounts/paths/~1accounts~1{stake_address}~1registrations/get
+    https://docs.blockfrost.io/#tag/cardano--accounts/GET/accounts/{stake_address}/registrations
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
@@ -153,7 +153,7 @@ def account_withdrawals(self, stake_address: str, **kwargs):
     """
     Obtain information about the withdrawals of a specific account.
 
-    https://docs.blockfrost.io/#tag/Cardano-Accounts/paths/~1accounts~1{stake_address}~1withdrawals/get
+    https://docs.blockfrost.io/#tag/cardano--accounts/GET/accounts/{stake_address}/withdrawals
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
@@ -184,7 +184,7 @@ def account_mirs(self, stake_address: str, **kwargs):
     """
     Obtain information about the MIRs of a specific account.
 
-    https://docs.blockfrost.io/#tag/Cardano-Accounts/paths/~1accounts~1{stake_address}~1mirs/get
+    https://docs.blockfrost.io/#tag/cardano--accounts/GET/accounts/{stake_address}/mirs
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
@@ -215,7 +215,7 @@ def account_addresses(self, stake_address: str, **kwargs):
     """
     Obtain information about the addresses of a specific account.
 
-    https://docs.blockfrost.io/#tag/Cardano-Accounts/paths/~1accounts~1{stake_address}~1addresses/get
+    https://docs.blockfrost.io/#tag/cardano--accounts/GET/accounts/{stake_address}/addresses
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
@@ -248,7 +248,7 @@ def account_addresses_assets(self, stake_address: str, **kwargs):
 
     Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.
 
-    https://docs.blockfrost.io/#tag/Cardano-Accounts/paths/~1accounts~1{stake_address}~1addresses~1assets/get
+    https://docs.blockfrost.io/#tag/cardano--accounts/GET/accounts/{stake_address}/addresses/assets
 
     :param stake_address: Bech32 stake address.
     :type stake_address: str
@@ -274,14 +274,76 @@ def account_addresses_assets(self, stake_address: str, **kwargs):
     )
 
 
+@list_request_wrapper
+def account_utxos(self, stake_address: str, **kwargs):
+    """
+    Obtain information about UTXOs of a specific account.
+
+    https://docs.blockfrost.io/#tag/cardano--accounts/GET/accounts/{stake_address}/utxos
+
+    :param stake_address: Bech32 stake address.
+    :type stake_address: str
+    :param return_type: Optional. "object", "json" or "pandas". Default: "object".
+    :type return_type: str
+    :param gather_pages: Optional. Default: false. Will collect all pages into one return
+    :type gather_pages: bool
+    :param count: Optional. Default: 100. The number of results displayed on one page.
+    :type count: int
+    :param page: Optional. The page number for listing the results.
+    :type page: int
+    :param order: Optional. "asc" or "desc". Default: "asc".
+    :type order: str
+    :returns A list of objects.
+    :rtype [Namespace]
+    :raises ApiError: If API fails
+    :raises Exception: If the API response is somehow malformed.
+    """
+    return requests.get(
+        url=f"{self.url}/accounts/{stake_address}/utxos",
+        params=self.query_parameters(kwargs),
+        headers=self.default_headers
+    )
+
+
+@list_request_wrapper
+def account_transactions(self, stake_address: str, **kwargs):
+    """
+    Obtain information about transactions associated with a specific account.
+
+    https://docs.blockfrost.io/#tag/cardano--accounts/GET/accounts/{stake_address}/transactions
+
+    :param stake_address: Bech32 stake address.
+    :type stake_address: str
+    :param return_type: Optional. "object", "json" or "pandas". Default: "object".
+    :type return_type: str
+    :param gather_pages: Optional. Default: false. Will collect all pages into one return
+    :type gather_pages: bool
+    :param count: Optional. Default: 100. The number of results displayed on one page.
+    :type count: int
+    :param page: Optional. The page number for listing the results.
+    :type page: int
+    :param order: Optional. "asc" or "desc". Default: "asc".
+    :type order: str
+    :returns A list of objects.
+    :rtype [Namespace]
+    :raises ApiError: If API fails
+    :raises Exception: If the API response is somehow malformed.
+    """
+    return requests.get(
+        url=f"{self.url}/accounts/{stake_address}/transactions",
+        params=self.query_parameters(kwargs),
+        headers=self.default_headers
+    )
+
+
 @request_wrapper
 def account_addresses_total(self, stake_address: str, **kwargs):
     """
     Obtain summed details about all addresses associated with a given account.
 
     Be careful, as an account could be part of a mangled address and does not necessarily mean the addresses are owned by user as the account.
 
-    https://docs.blockfrost.io/#tag/Cardano-Addresses/paths/~1accounts~1{stake_address}~1addresses~1total/get
+    https://docs.blockfrost.io/#tag/cardano--addresses/GET/accounts/{stake_address}/addresses/total
 
     :param stake_address: Bech32 address.
     :type stake_address: str

blockfrost/api/cardano/addresses.py

@@ -7,7 +7,7 @@ def address(self, address: str, **kwargs):
     """
     Obtain information about a specific address.
 
-    https://docs.blockfrost.io/#tag/Cardano-Addresses/paths/~1addresses~1{address}/get
+    https://docs.blockfrost.io/#tag/cardano--addresses/GET/addresses/{address}
 
     :param address: Bech32 address.
     :type address: str
@@ -29,7 +29,7 @@ def address_extended(self, address: str, **kwargs):
     """
     Obtain information about a specific address.
 
-    https://docs.blockfrost.io/#tag/Cardano-Addresses/paths/~1addresses~1{address}~1extended/get
+    https://docs.blockfrost.io/#tag/cardano--addresses/GET/addresses/{address}/extended
 
     :param address: Bech32 address.
     :type address: str
@@ -51,7 +51,7 @@ def address_total(self, address: str, **kwargs):
     """
     Obtain details about an address.
 
-    https://docs.blockfrost.io/#tag/Cardano-Addresses/paths/~1addresses~1{address}~1total/get
+    https://docs.blockfrost.io/#tag/cardano--addresses/GET/addresses/{address}/total
 
     :param address: Bech32 address.
     :type address: str
@@ -73,7 +73,7 @@ def address_utxos(self, address: str, **kwargs):
     """
     UTXOs of the address.
 
-    https://docs.blockfrost.io/#tag/Cardano-Addresses/paths/~1addresses~1{address}~1utxos/get
+    https://docs.blockfrost.io/#tag/cardano--addresses/GET/addresses/{address}/utxos
 
     :param address: Bech32 address.
     :type address: str
@@ -104,7 +104,7 @@ def address_utxos_asset(self, address: str, asset: str, **kwargs):
     """
     UTXOs of the address.
 
-    https://docs.blockfrost.io/#tag/Cardano-Addresses/paths/~1addresses~1{address}~1utxos~1{asset}/get
+    https://docs.blockfrost.io/#tag/cardano--addresses/GET/addresses/{address}/utxos/{asset}
 
     :param address: Bech32 address.
     :type address: str
@@ -138,7 +138,7 @@ def address_transactions(self, address: str, from_block: str = None, to_block: s
     """
     Transactions on the address.
 
-    https://docs.blockfrost.io/#tag/Cardano-Addresses/paths/~1addresses~1{address}~1transactions/get
+    https://docs.blockfrost.io/#tag/cardano--addresses/GET/addresses/{address}/transactions
 
     :param address: Bech32 address.
     :type address: str

blockfrost/api/cardano/assets.py

@@ -7,7 +7,7 @@ def assets(self, **kwargs):
     """
     List of assets.
 
-    https://docs.blockfrost.io/#tag/Cardano-Assets/paths/~1assets/get
+    https://docs.blockfrost.io/#tag/cardano--assets/GET/assets
 
     :param return_type: Optional. "object", "json" or "pandas". Default: "object".
     :type return_type: str
@@ -36,7 +36,7 @@ def asset(self, asset: str, **kwargs):
     """
     Information about a specific asset
 
-    https://docs.blockfrost.io/#tag/Cardano-Assets/paths/~1assets~1{asset}/get
+    https://docs.blockfrost.io/#tag/cardano--assets/GET/assets/{asset}
 
     :param asset: Concatenation of the policy_id and hex-encoded asset_name.
     :type asset: str
@@ -58,7 +58,7 @@ def asset_history(self, asset: str, **kwargs):
     """
     History of a specific asset
 
-    https://docs.blockfrost.io/#tag/Cardano-Assets/paths/~1assets~1{asset}~1history/get
+    https://docs.blockfrost.io/#tag/cardano--assets/GET/assets/{asset}/history
 
     :param asset: Concatenation of the policy_id and hex-encoded asset_name.
     :type asset: str
@@ -89,7 +89,7 @@ def asset_transactions(self, asset: str, **kwargs):
     """
     List of a specific asset transactions
 
-    https://docs.blockfrost.io/#tag/Cardano-Assets/paths/~1assets~1{asset}~1transactions/get
+    https://docs.blockfrost.io/#tag/cardano--assets/GET/assets/{asset}/transactions
 
     :param asset: Concatenation of the policy_id and hex-encoded asset_name.
     :type asset: str
@@ -120,7 +120,7 @@ def asset_addresses(self, asset: str, **kwargs):
     """
     List of a addresses containing a specific asset
 
-    https://docs.blockfrost.io/#tag/Cardano-Assets/paths/~1assets~1{asset}~1addresses/get
+    https://docs.blockfrost.io/#tag/cardano--assets/GET/assets/{asset}/addresses
 
     :param asset: Concatenation of the policy_id and hex-encoded asset_name.
     :type asset: str
@@ -151,7 +151,7 @@ def assets_policy(self, policy_id: str, **kwargs):
     """
     List of asset minted under a specific policy
 
-    https://docs.blockfrost.io/#tag/Cardano-Assets/paths/~1assets~1policy~1{policy_id}/get
+    https://docs.blockfrost.io/#tag/cardano--assets/GET/assets/policy/{policy_id}
 
     :param policy_id: Specific policy_id.
     :type policy_id: str