fireblocks 14.0.0
Fireblocks API
License: MIT License
Requires Python: >=3.8
Keywords: Fireblocks, SDK, Fireblocks API

# Official Fireblocks Python SDK
[![PyPI version](https://badge.fury.io/py/fireblocks.svg)](https://badge.fury.io/py/fireblocks)

The Fireblocks SDK allows developers to seamlessly integrate with the Fireblocks platform and perform a variety of operations, including managing vault accounts and executing transactions securely.

For detailed API documentation please refer to the [Fireblocks API Reference](https://developers.fireblocks.com/reference/).

## Requirements.

Python 3.8+

## Installation

To use the Fireblocks SDK, follow these steps:

### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install fireblocks
```

Then import the package:
```python
import fireblocks
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import fireblocks
```

## Usage

Please follow the [installation procedure](#installation) first.

### Initializing the SDK
You can initialize the Fireblocks SDK in two ways, either by setting environment variables or providing the parameters directly:

<p><strong>Using Environment Variables</strong><br>
You can initialize the SDK using environment variables from your .env file or by setting them programmatically:</p>

use bash commands to set environment variables:
```bash
export FIREBLOCKS_BASE_PATH="https://sandbox-api.fireblocks.io/v1"
export FIREBLOCKS_API_KEY="my-api-key"
export FIREBLOCKS_SECRET_KEY="my-secret-key"
```

```python
from fireblocks.client import Fireblocks

# Enter a context with an instance of the API client
with Fireblocks() as fireblocks:
    pass
```

<p><strong>Providing Local Variables</strong><br>

```python
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.base_path import BasePath


# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)

# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    pass
```

### Basic Api Examples
<p><strong>Creating a Vault Account</strong><br>
    To create a new vault account, you can use the following function:</p>

```python
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.base_path import BasePath
from fireblocks.models.create_vault_account_request import CreateVaultAccountRequest
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)

# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    create_vault_account_request: CreateVaultAccountRequest = CreateVaultAccountRequest(
                                    name='My First Vault Account',
                                    hidden_on_ui=False,
                                    auto_fuel=False
                                    )
    try:
        # Create a new vault account
        future = fireblocks.vaults.create_vault_account(create_vault_account_request=create_vault_account_request)
        api_response = future.result()  # Wait for the response
        print("The response of VaultsApi->create_vault_account:\n")
        pprint(api_response)
        # to print just the data:                pprint(api_response.data)
        # to print just the data in json format: pprint(api_response.data.to_json())
    except Exception as e:
        print("Exception when calling VaultsApi->create_vault_account: %s\n" % e)

```


<p><strong>Retrieving Vault Accounts</strong><br>
    To get a list of vault accounts, you can use the following function:</p>

```python
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)

# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    try:
        # List vault accounts (Paginated)
        future = fireblocks.vaults.get_paged_vault_accounts()
        api_response = future.result()  # Wait for the response
        print("The response of VaultsApi->get_paged_vault_accounts:\n")
        pprint(api_response)
        # to print just the data:                pprint(api_response.data)
        # to print just the data in json format: pprint(api_response.data.to_json())
    except Exception as e:
        print("Exception when calling VaultsApi->get_paged_vault_accounts: %s\n" % e)
```

<p><strong>Creating a Transaction</strong><br>
    To make a transaction between vault accounts, you can use the following function:</p>

```python
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.base_path import BasePath
from fireblocks.models.transaction_request import TransactionRequest
from fireblocks.models.destination_transfer_peer_path import DestinationTransferPeerPath
from fireblocks.models.source_transfer_peer_path import SourceTransferPeerPath
from fireblocks.models.transfer_peer_path_type import TransferPeerPathType
from fireblocks.models.transaction_request_amount import TransactionRequestAmount
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)

# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    transaction_request: TransactionRequest = TransactionRequest(
        asset_id="ETH",
        amount=TransactionRequestAmount("0.1"),
        source=SourceTransferPeerPath(
            type=TransferPeerPathType.VAULT_ACCOUNT,
            id="0"
        ),
        destination=DestinationTransferPeerPath(
            type=TransferPeerPathType.VAULT_ACCOUNT,
            id="1"
        ),
        note="Your first transaction!"
    )
    # or you can use JSON approach:
    #
    # transaction_request: TransactionRequest = TransactionRequest.from_json(
    #     '{"note": "Your first transaction!", '
    #     '"assetId": "ETH", '
    #     '"source": {"type": "VAULT_ACCOUNT", "id": "0"}, '
    #     '"destination": {"type": "VAULT_ACCOUNT", "id": "1"}, '
    #     '"amount": "0.1"}'
    # )
    try:
        # Create a new transaction
        future = fireblocks.transactions.create_transaction(transaction_request=transaction_request)
        api_response = future.result()  # Wait for the response
        print("The response of TransactionsApi->create_transaction:\n")
        pprint(api_response)
        # to print just the data:                pprint(api_response.data)
        # to print just the data in json format: pprint(api_response.data.to_json())
    except Exception as e:
        print("Exception when calling TransactionsApi->create_transaction: %s\n" % e)
```

## Documentation for API Endpoints

All URIs are relative to https://developers.fireblocks.com/reference/

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ApiUserApi* | [**create_api_user**](https://github.com/fireblocks/py-sdk/tree/master/docs/ApiUserApi.md#create_api_user) | **POST** /management/api_users | Create API Key
*ApiUserApi* | [**get_api_users**](https://github.com/fireblocks/py-sdk/tree/master/docs/ApiUserApi.md#get_api_users) | **GET** /management/api_users | Get API Keys
*AuditLogsApi* | [**get_audit_logs**](https://github.com/fireblocks/py-sdk/tree/master/docs/AuditLogsApi.md#get_audit_logs) | **GET** /management/audit_logs | Get audit logs
*BlockchainsAssetsApi* | [**get_asset**](https://github.com/fireblocks/py-sdk/tree/master/docs/BlockchainsAssetsApi.md#get_asset) | **GET** /assets/{id} | Get an asset
*BlockchainsAssetsApi* | [**get_blockchain**](https://github.com/fireblocks/py-sdk/tree/master/docs/BlockchainsAssetsApi.md#get_blockchain) | **GET** /blockchains/{id} | Get a Blockchain by ID
*BlockchainsAssetsApi* | [**get_supported_assets**](https://github.com/fireblocks/py-sdk/tree/master/docs/BlockchainsAssetsApi.md#get_supported_assets) | **GET** /supported_assets | List assets (Legacy)
*BlockchainsAssetsApi* | [**list_assets**](https://github.com/fireblocks/py-sdk/tree/master/docs/BlockchainsAssetsApi.md#list_assets) | **GET** /assets | List assets
*BlockchainsAssetsApi* | [**list_blockchains**](https://github.com/fireblocks/py-sdk/tree/master/docs/BlockchainsAssetsApi.md#list_blockchains) | **GET** /blockchains | List blockchains
*BlockchainsAssetsApi* | [**register_new_asset**](https://github.com/fireblocks/py-sdk/tree/master/docs/BlockchainsAssetsApi.md#register_new_asset) | **POST** /assets | Register an asset
*BlockchainsAssetsApi* | [**set_asset_price**](https://github.com/fireblocks/py-sdk/tree/master/docs/BlockchainsAssetsApi.md#set_asset_price) | **POST** /assets/prices/{id} | Set asset price
*BlockchainsAssetsApi* | [**update_asset_user_metadata**](https://github.com/fireblocks/py-sdk/tree/master/docs/BlockchainsAssetsApi.md#update_asset_user_metadata) | **PATCH** /assets/{id} | Update the user’s metadata for an asset
*ComplianceApi* | [**get_aml_post_screening_policy**](https://github.com/fireblocks/py-sdk/tree/master/docs/ComplianceApi.md#get_aml_post_screening_policy) | **GET** /screening/aml/post_screening_policy | AML - View Post-Screening Policy
*ComplianceApi* | [**get_aml_screening_policy**](https://github.com/fireblocks/py-sdk/tree/master/docs/ComplianceApi.md#get_aml_screening_policy) | **GET** /screening/aml/screening_policy | AML - View Screening Policy
*ComplianceApi* | [**get_post_screening_policy**](https://github.com/fireblocks/py-sdk/tree/master/docs/ComplianceApi.md#get_post_screening_policy) | **GET** /screening/travel_rule/post_screening_policy | Travel Rule - View Post-Screening Policy
*ComplianceApi* | [**get_screening_full_details**](https://github.com/fireblocks/py-sdk/tree/master/docs/ComplianceApi.md#get_screening_full_details) | **GET** /screening/transaction/{txId} | Provides all the compliance details for the given screened transaction.
*ComplianceApi* | [**get_screening_policy**](https://github.com/fireblocks/py-sdk/tree/master/docs/ComplianceApi.md#get_screening_policy) | **GET** /screening/travel_rule/screening_policy | Travel Rule - View Screening Policy
*ComplianceApi* | [**retry_rejected_transaction_bypass_screening_checks**](https://github.com/fireblocks/py-sdk/tree/master/docs/ComplianceApi.md#retry_rejected_transaction_bypass_screening_checks) | **POST** /screening/transaction/{txId}/bypass_screening_policy | Calling the \&quot;Bypass Screening Policy\&quot; API endpoint triggers a new transaction, with the API user as the initiator, bypassing the screening policy check
*ComplianceApi* | [**set_aml_verdict**](https://github.com/fireblocks/py-sdk/tree/master/docs/ComplianceApi.md#set_aml_verdict) | **POST** /screening/aml/verdict/manual | Set AML Verdict for Manual Screening Verdict.
*ComplianceApi* | [**update_aml_screening_configuration**](https://github.com/fireblocks/py-sdk/tree/master/docs/ComplianceApi.md#update_aml_screening_configuration) | **PUT** /screening/aml/policy_configuration | Update AML Configuration
*ComplianceApi* | [**update_screening_configuration**](https://github.com/fireblocks/py-sdk/tree/master/docs/ComplianceApi.md#update_screening_configuration) | **PUT** /screening/configurations | Tenant - Screening Configuration
*ComplianceApi* | [**update_travel_rule_config**](https://github.com/fireblocks/py-sdk/tree/master/docs/ComplianceApi.md#update_travel_rule_config) | **PUT** /screening/travel_rule/policy_configuration | Update Travel Rule Configuration
*ComplianceScreeningConfigurationApi* | [**get_aml_screening_configuration**](https://github.com/fireblocks/py-sdk/tree/master/docs/ComplianceScreeningConfigurationApi.md#get_aml_screening_configuration) | **GET** /screening/aml/policy_configuration | Get AML Screening Policy Configuration
*ComplianceScreeningConfigurationApi* | [**get_screening_configuration**](https://github.com/fireblocks/py-sdk/tree/master/docs/ComplianceScreeningConfigurationApi.md#get_screening_configuration) | **GET** /screening/travel_rule/policy_configuration | Get Travel Rule Screening Policy Configuration
*ConnectedAccountsBetaApi* | [**disconnect_connected_account**](https://github.com/fireblocks/py-sdk/tree/master/docs/ConnectedAccountsBetaApi.md#disconnect_connected_account) | **DELETE** /connected_accounts/{accountId} | Disconnect connected account
*ConnectedAccountsBetaApi* | [**get_connected_account**](https://github.com/fireblocks/py-sdk/tree/master/docs/ConnectedAccountsBetaApi.md#get_connected_account) | **GET** /connected_accounts/{accountId} | Get connected account
*ConnectedAccountsBetaApi* | [**get_connected_account_balances**](https://github.com/fireblocks/py-sdk/tree/master/docs/ConnectedAccountsBetaApi.md#get_connected_account_balances) | **GET** /connected_accounts/{accountId}/balances | Get balances for an account
*ConnectedAccountsBetaApi* | [**get_connected_account_rates**](https://github.com/fireblocks/py-sdk/tree/master/docs/ConnectedAccountsBetaApi.md#get_connected_account_rates) | **GET** /connected_accounts/{accountId}/rates | Get exchange rates for an account
*ConnectedAccountsBetaApi* | [**get_connected_account_trading_pairs**](https://github.com/fireblocks/py-sdk/tree/master/docs/ConnectedAccountsBetaApi.md#get_connected_account_trading_pairs) | **GET** /connected_accounts/{accountId}/manifest/capabilities/trading/pairs | Get supported trading pairs for an account
*ConnectedAccountsBetaApi* | [**get_connected_accounts**](https://github.com/fireblocks/py-sdk/tree/master/docs/ConnectedAccountsBetaApi.md#get_connected_accounts) | **GET** /connected_accounts | Get connected accounts
*ConnectedAccountsBetaApi* | [**rename_connected_account**](https://github.com/fireblocks/py-sdk/tree/master/docs/ConnectedAccountsBetaApi.md#rename_connected_account) | **POST** /connected_accounts/{accountId}/rename | Rename Connected Account
*ConsoleUserApi* | [**create_console_user**](https://github.com/fireblocks/py-sdk/tree/master/docs/ConsoleUserApi.md#create_console_user) | **POST** /management/users | Create console user
*ConsoleUserApi* | [**get_console_users**](https://github.com/fireblocks/py-sdk/tree/master/docs/ConsoleUserApi.md#get_console_users) | **GET** /management/users | Get console users
*ContractInteractionsApi* | [**decode_contract_data**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractInteractionsApi.md#decode_contract_data) | **POST** /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/decode | Decode a function call data, error, or event log
*ContractInteractionsApi* | [**get_contract_address**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractInteractionsApi.md#get_contract_address) | **GET** /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash} | Get contract address by transaction hash
*ContractInteractionsApi* | [**get_deployed_contract_abi**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractInteractionsApi.md#get_deployed_contract_abi) | **GET** /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions | Return deployed contract&#39;s ABI
*ContractInteractionsApi* | [**get_transaction_receipt**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractInteractionsApi.md#get_transaction_receipt) | **GET** /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash}/receipt | Get transaction receipt
*ContractInteractionsApi* | [**read_call_function**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractInteractionsApi.md#read_call_function) | **POST** /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/read | Call a read function on a deployed contract
*ContractInteractionsApi* | [**write_call_function**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractInteractionsApi.md#write_call_function) | **POST** /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/write | Call a write function on a deployed contract
*ContractTemplatesApi* | [**delete_contract_template_by_id**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractTemplatesApi.md#delete_contract_template_by_id) | **DELETE** /tokenization/templates/{contractTemplateId} | Delete a contract template by id
*ContractTemplatesApi* | [**deploy_contract**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractTemplatesApi.md#deploy_contract) | **POST** /tokenization/templates/{contractTemplateId}/deploy | Deploy contract
*ContractTemplatesApi* | [**get_constructor_by_contract_template_id**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractTemplatesApi.md#get_constructor_by_contract_template_id) | **GET** /tokenization/templates/{contractTemplateId}/constructor | Return contract template&#39;s constructor
*ContractTemplatesApi* | [**get_contract_template_by_id**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractTemplatesApi.md#get_contract_template_by_id) | **GET** /tokenization/templates/{contractTemplateId} | Return contract template by id
*ContractTemplatesApi* | [**get_contract_templates**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractTemplatesApi.md#get_contract_templates) | **GET** /tokenization/templates | List all contract templates
*ContractTemplatesApi* | [**get_function_abi_by_contract_template_id**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractTemplatesApi.md#get_function_abi_by_contract_template_id) | **GET** /tokenization/templates/{contractTemplateId}/function | Return contract template&#39;s function
*ContractTemplatesApi* | [**get_supported_blockchains_by_template_id**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractTemplatesApi.md#get_supported_blockchains_by_template_id) | **GET** /tokenization/templates/{contractTemplateId}/supported_blockchains | Get supported blockchains for the template
*ContractTemplatesApi* | [**upload_contract_template**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractTemplatesApi.md#upload_contract_template) | **POST** /tokenization/templates | Upload contract template
*ContractsApi* | [**add_contract_asset**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractsApi.md#add_contract_asset) | **POST** /contracts/{contractId}/{assetId} | Add an asset to a whitelisted contract
*ContractsApi* | [**create_contract**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractsApi.md#create_contract) | **POST** /contracts | Add a contract
*ContractsApi* | [**delete_contract**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractsApi.md#delete_contract) | **DELETE** /contracts/{contractId} | Delete a contract
*ContractsApi* | [**delete_contract_asset**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractsApi.md#delete_contract_asset) | **DELETE** /contracts/{contractId}/{assetId} | Delete an asset from a whitelisted contract
*ContractsApi* | [**get_contract**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractsApi.md#get_contract) | **GET** /contracts/{contractId} | Find a Specific Whitelisted Contract
*ContractsApi* | [**get_contract_asset**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractsApi.md#get_contract_asset) | **GET** /contracts/{contractId}/{assetId} | Find a whitelisted contract&#39;s asset
*ContractsApi* | [**get_contracts**](https://github.com/fireblocks/py-sdk/tree/master/docs/ContractsApi.md#get_contracts) | **GET** /contracts | List Whitelisted Contracts
*CosignersBetaApi* | [**add_cosigner**](https://github.com/fireblocks/py-sdk/tree/master/docs/CosignersBetaApi.md#add_cosigner) | **POST** /cosigners | Add cosigner
*CosignersBetaApi* | [**get_api_key**](https://github.com/fireblocks/py-sdk/tree/master/docs/CosignersBetaApi.md#get_api_key) | **GET** /cosigners/{cosignerId}/api_keys/{apiKeyId} | Get API key
*CosignersBetaApi* | [**get_api_keys**](https://github.com/fireblocks/py-sdk/tree/master/docs/CosignersBetaApi.md#get_api_keys) | **GET** /cosigners/{cosignerId}/api_keys | Get all API keys
*CosignersBetaApi* | [**get_cosigner**](https://github.com/fireblocks/py-sdk/tree/master/docs/CosignersBetaApi.md#get_cosigner) | **GET** /cosigners/{cosignerId} | Get cosigner
*CosignersBetaApi* | [**get_cosigners**](https://github.com/fireblocks/py-sdk/tree/master/docs/CosignersBetaApi.md#get_cosigners) | **GET** /cosigners | Get all cosigners
*CosignersBetaApi* | [**get_request_status**](https://github.com/fireblocks/py-sdk/tree/master/docs/CosignersBetaApi.md#get_request_status) | **GET** /cosigners/{cosignerId}/api_keys/{apiKeyId}/{requestId} | Get request status
*CosignersBetaApi* | [**pair_api_key**](https://github.com/fireblocks/py-sdk/tree/master/docs/CosignersBetaApi.md#pair_api_key) | **PUT** /cosigners/{cosignerId}/api_keys/{apiKeyId} | Pair API key
*CosignersBetaApi* | [**rename_cosigner**](https://github.com/fireblocks/py-sdk/tree/master/docs/CosignersBetaApi.md#rename_cosigner) | **PATCH** /cosigners/{cosignerId} | Rename cosigner
*CosignersBetaApi* | [**unpair_api_key**](https://github.com/fireblocks/py-sdk/tree/master/docs/CosignersBetaApi.md#unpair_api_key) | **DELETE** /cosigners/{cosignerId}/api_keys/{apiKeyId} | Unpair API key
*CosignersBetaApi* | [**update_callback_handler**](https://github.com/fireblocks/py-sdk/tree/master/docs/CosignersBetaApi.md#update_callback_handler) | **PATCH** /cosigners/{cosignerId}/api_keys/{apiKeyId} | Update API key callback handler
*DeployedContractsApi* | [**add_contract_abi**](https://github.com/fireblocks/py-sdk/tree/master/docs/DeployedContractsApi.md#add_contract_abi) | **POST** /tokenization/contracts/abi | Save contract ABI
*DeployedContractsApi* | [**fetch_contract_abi**](https://github.com/fireblocks/py-sdk/tree/master/docs/DeployedContractsApi.md#fetch_contract_abi) | **POST** /tokenization/contracts/fetch_abi | Fetch the contract ABI
*DeployedContractsApi* | [**get_deployed_contract_by_address**](https://github.com/fireblocks/py-sdk/tree/master/docs/DeployedContractsApi.md#get_deployed_contract_by_address) | **GET** /tokenization/contracts/{assetId}/{contractAddress} | Return deployed contract data
*DeployedContractsApi* | [**get_deployed_contract_by_id**](https://github.com/fireblocks/py-sdk/tree/master/docs/DeployedContractsApi.md#get_deployed_contract_by_id) | **GET** /tokenization/contracts/{id} | Return deployed contract data by id
*DeployedContractsApi* | [**get_deployed_contracts**](https://github.com/fireblocks/py-sdk/tree/master/docs/DeployedContractsApi.md#get_deployed_contracts) | **GET** /tokenization/contracts | List deployed contracts data
*EmbeddedWalletsApi* | [**add_embedded_wallet_asset**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#add_embedded_wallet_asset) | **POST** /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId} | Add asset to account
*EmbeddedWalletsApi* | [**assign_embedded_wallet**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#assign_embedded_wallet) | **POST** /ncw/wallets/{walletId}/assign | Assign a wallet
*EmbeddedWalletsApi* | [**create_embedded_wallet**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#create_embedded_wallet) | **POST** /ncw/wallets | Create a new wallet
*EmbeddedWalletsApi* | [**create_embedded_wallet_account**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#create_embedded_wallet_account) | **POST** /ncw/wallets/{walletId}/accounts | Create a new account
*EmbeddedWalletsApi* | [**get_embedded_wallet**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallet) | **GET** /ncw/wallets/{walletId} | Get a wallet
*EmbeddedWalletsApi* | [**get_embedded_wallet_account**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallet_account) | **GET** /ncw/wallets/{walletId}/accounts/{accountId} | Get a account
*EmbeddedWalletsApi* | [**get_embedded_wallet_addresses**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallet_addresses) | **GET** /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/addresses | Retrieve asset addresses
*EmbeddedWalletsApi* | [**get_embedded_wallet_asset**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallet_asset) | **GET** /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId} | Retrieve asset
*EmbeddedWalletsApi* | [**get_embedded_wallet_asset_balance**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallet_asset_balance) | **GET** /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance | Retrieve asset balance
*EmbeddedWalletsApi* | [**get_embedded_wallet_assets**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallet_assets) | **GET** /ncw/wallets/{walletId}/accounts/{accountId}/assets | Retrieve assets
*EmbeddedWalletsApi* | [**get_embedded_wallet_device**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallet_device) | **GET** /ncw/wallets/{walletId}/devices/{deviceId} | Get Embedded Wallet Device
*EmbeddedWalletsApi* | [**get_embedded_wallet_device_setup_state**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallet_device_setup_state) | **GET** /ncw/wallets/{walletId}/devices/{deviceId}/setup_status | Get device key setup state
*EmbeddedWalletsApi* | [**get_embedded_wallet_devices_paginated**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallet_devices_paginated) | **GET** /ncw/wallets/{walletId}/devices_paginated | Get registered devices - paginated
*EmbeddedWalletsApi* | [**get_embedded_wallet_latest_backup**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallet_latest_backup) | **GET** /ncw/wallets/{walletId}/backup/latest | Get wallet Latest Backup details
*EmbeddedWalletsApi* | [**get_embedded_wallet_public_key_info_for_address**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallet_public_key_info_for_address) | **GET** /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/{change}/{addressIndex}/public_key_info | Get the public key of an asset
*EmbeddedWalletsApi* | [**get_embedded_wallet_setup_status**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallet_setup_status) | **GET** /ncw/wallets/{walletId}/setup_status | Get wallet key setup state
*EmbeddedWalletsApi* | [**get_embedded_wallet_supported_assets**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallet_supported_assets) | **GET** /ncw/wallets/supported_assets | Retrieve supported assets
*EmbeddedWalletsApi* | [**get_embedded_wallets**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_embedded_wallets) | **GET** /ncw/wallets | List wallets
*EmbeddedWalletsApi* | [**get_public_key_info_ncw**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#get_public_key_info_ncw) | **GET** /ncw/wallets/{walletId}/public_key_info | Get the public key for a derivation path
*EmbeddedWalletsApi* | [**refresh_embedded_wallet_asset_balance**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#refresh_embedded_wallet_asset_balance) | **PUT** /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance | Refresh asset balance
*EmbeddedWalletsApi* | [**update_embedded_wallet_device_status**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#update_embedded_wallet_device_status) | **PATCH** /ncw/wallets/{walletId}/devices/{deviceId}/status | Update device status
*EmbeddedWalletsApi* | [**update_embedded_wallet_status**](https://github.com/fireblocks/py-sdk/tree/master/docs/EmbeddedWalletsApi.md#update_embedded_wallet_status) | **PATCH** /ncw/wallets/{walletId}/status | Update wallet status
*ExchangeAccountsApi* | [**add_exchange_account**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExchangeAccountsApi.md#add_exchange_account) | **POST** /exchange_accounts | Add an exchange account
*ExchangeAccountsApi* | [**convert_assets**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExchangeAccountsApi.md#convert_assets) | **POST** /exchange_accounts/{exchangeAccountId}/convert | Convert exchange account funds
*ExchangeAccountsApi* | [**get_exchange_account**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExchangeAccountsApi.md#get_exchange_account) | **GET** /exchange_accounts/{exchangeAccountId} | Get a specific exchange account
*ExchangeAccountsApi* | [**get_exchange_account_asset**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExchangeAccountsApi.md#get_exchange_account_asset) | **GET** /exchange_accounts/{exchangeAccountId}/{assetId} | Get an asset for an exchange account
*ExchangeAccountsApi* | [**get_exchange_accounts_credentials_public_key**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExchangeAccountsApi.md#get_exchange_accounts_credentials_public_key) | **GET** /exchange_accounts/credentials_public_key | Get public key to encrypt exchange credentials
*ExchangeAccountsApi* | [**get_paged_exchange_accounts**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExchangeAccountsApi.md#get_paged_exchange_accounts) | **GET** /exchange_accounts/paged | List connected exchange accounts
*ExchangeAccountsApi* | [**internal_transfer**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExchangeAccountsApi.md#internal_transfer) | **POST** /exchange_accounts/{exchangeAccountId}/internal_transfer | Internal transfer for exchange accounts
*ExternalWalletsApi* | [**add_asset_to_external_wallet**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExternalWalletsApi.md#add_asset_to_external_wallet) | **POST** /external_wallets/{walletId}/{assetId} | Add an asset to an external wallet.
*ExternalWalletsApi* | [**create_external_wallet**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExternalWalletsApi.md#create_external_wallet) | **POST** /external_wallets | Create an external wallet
*ExternalWalletsApi* | [**delete_external_wallet**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExternalWalletsApi.md#delete_external_wallet) | **DELETE** /external_wallets/{walletId} | Delete an external wallet
*ExternalWalletsApi* | [**get_external_wallet**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExternalWalletsApi.md#get_external_wallet) | **GET** /external_wallets/{walletId} | Find an external wallet
*ExternalWalletsApi* | [**get_external_wallet_asset**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExternalWalletsApi.md#get_external_wallet_asset) | **GET** /external_wallets/{walletId}/{assetId} | Get an asset from an external wallet
*ExternalWalletsApi* | [**get_external_wallets**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExternalWalletsApi.md#get_external_wallets) | **GET** /external_wallets | List external wallets
*ExternalWalletsApi* | [**remove_asset_from_external_wallet**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExternalWalletsApi.md#remove_asset_from_external_wallet) | **DELETE** /external_wallets/{walletId}/{assetId} | Delete an asset from an external wallet
*ExternalWalletsApi* | [**set_external_wallet_customer_ref_id**](https://github.com/fireblocks/py-sdk/tree/master/docs/ExternalWalletsApi.md#set_external_wallet_customer_ref_id) | **POST** /external_wallets/{walletId}/set_customer_ref_id | Set an AML customer reference ID for an external wallet
*FiatAccountsApi* | [**deposit_funds_from_linked_dda**](https://github.com/fireblocks/py-sdk/tree/master/docs/FiatAccountsApi.md#deposit_funds_from_linked_dda) | **POST** /fiat_accounts/{accountId}/deposit_from_linked_dda | Deposit funds from DDA
*FiatAccountsApi* | [**get_fiat_account**](https://github.com/fireblocks/py-sdk/tree/master/docs/FiatAccountsApi.md#get_fiat_account) | **GET** /fiat_accounts/{accountId} | Find a specific fiat account
*FiatAccountsApi* | [**get_fiat_accounts**](https://github.com/fireblocks/py-sdk/tree/master/docs/FiatAccountsApi.md#get_fiat_accounts) | **GET** /fiat_accounts | List fiat accounts
*FiatAccountsApi* | [**redeem_funds_to_linked_dda**](https://github.com/fireblocks/py-sdk/tree/master/docs/FiatAccountsApi.md#redeem_funds_to_linked_dda) | **POST** /fiat_accounts/{accountId}/redeem_to_linked_dda | Redeem funds to DDA
*GasStationsApi* | [**get_gas_station_by_asset_id**](https://github.com/fireblocks/py-sdk/tree/master/docs/GasStationsApi.md#get_gas_station_by_asset_id) | **GET** /gas_station/{assetId} | Get gas station settings by asset
*GasStationsApi* | [**get_gas_station_info**](https://github.com/fireblocks/py-sdk/tree/master/docs/GasStationsApi.md#get_gas_station_info) | **GET** /gas_station | Get gas station settings
*GasStationsApi* | [**update_gas_station_configuration**](https://github.com/fireblocks/py-sdk/tree/master/docs/GasStationsApi.md#update_gas_station_configuration) | **PUT** /gas_station/configuration | Edit gas station settings
*GasStationsApi* | [**update_gas_station_configuration_by_asset_id**](https://github.com/fireblocks/py-sdk/tree/master/docs/GasStationsApi.md#update_gas_station_configuration_by_asset_id) | **PUT** /gas_station/configuration/{assetId} | Edit gas station settings for an asset
*InternalWalletsApi* | [**create_internal_wallet**](https://github.com/fireblocks/py-sdk/tree/master/docs/InternalWalletsApi.md#create_internal_wallet) | **POST** /internal_wallets | Create an internal wallet
*InternalWalletsApi* | [**create_internal_wallet_asset**](https://github.com/fireblocks/py-sdk/tree/master/docs/InternalWalletsApi.md#create_internal_wallet_asset) | **POST** /internal_wallets/{walletId}/{assetId} | Add an asset to an internal wallet
*InternalWalletsApi* | [**delete_internal_wallet**](https://github.com/fireblocks/py-sdk/tree/master/docs/InternalWalletsApi.md#delete_internal_wallet) | **DELETE** /internal_wallets/{walletId} | Delete an internal wallet
*InternalWalletsApi* | [**delete_internal_wallet_asset**](https://github.com/fireblocks/py-sdk/tree/master/docs/InternalWalletsApi.md#delete_internal_wallet_asset) | **DELETE** /internal_wallets/{walletId}/{assetId} | Delete a whitelisted address
*InternalWalletsApi* | [**get_internal_wallet**](https://github.com/fireblocks/py-sdk/tree/master/docs/InternalWalletsApi.md#get_internal_wallet) | **GET** /internal_wallets/{walletId} | Get assets for internal wallet
*InternalWalletsApi* | [**get_internal_wallet_asset**](https://github.com/fireblocks/py-sdk/tree/master/docs/InternalWalletsApi.md#get_internal_wallet_asset) | **GET** /internal_wallets/{walletId}/{assetId} | Get an asset from an internal wallet
*InternalWalletsApi* | [**get_internal_wallet_assets_paginated**](https://github.com/fireblocks/py-sdk/tree/master/docs/InternalWalletsApi.md#get_internal_wallet_assets_paginated) | **GET** /internal_wallets/{walletId}/assets | List assets in an internal wallet (Paginated)
*InternalWalletsApi* | [**get_internal_wallets**](https://github.com/fireblocks/py-sdk/tree/master/docs/InternalWalletsApi.md#get_internal_wallets) | **GET** /internal_wallets | List internal wallets
*InternalWalletsApi* | [**set_customer_ref_id_for_internal_wallet**](https://github.com/fireblocks/py-sdk/tree/master/docs/InternalWalletsApi.md#set_customer_ref_id_for_internal_wallet) | **POST** /internal_wallets/{walletId}/set_customer_ref_id | Set an AML/KYT customer reference ID for internal wallet
*KeyLinkBetaApi* | [**create_signing_key**](https://github.com/fireblocks/py-sdk/tree/master/docs/KeyLinkBetaApi.md#create_signing_key) | **POST** /key_link/signing_keys | Add a new signing key
*KeyLinkBetaApi* | [**create_validation_key**](https://github.com/fireblocks/py-sdk/tree/master/docs/KeyLinkBetaApi.md#create_validation_key) | **POST** /key_link/validation_keys | Add a new validation key
*KeyLinkBetaApi* | [**disable_validation_key**](https://github.com/fireblocks/py-sdk/tree/master/docs/KeyLinkBetaApi.md#disable_validation_key) | **PATCH** /key_link/validation_keys/{keyId} | Disables a validation key
*KeyLinkBetaApi* | [**get_signing_key**](https://github.com/fireblocks/py-sdk/tree/master/docs/KeyLinkBetaApi.md#get_signing_key) | **GET** /key_link/signing_keys/{keyId} | Get a signing key by &#x60;keyId&#x60;
*KeyLinkBetaApi* | [**get_signing_keys_list**](https://github.com/fireblocks/py-sdk/tree/master/docs/KeyLinkBetaApi.md#get_signing_keys_list) | **GET** /key_link/signing_keys | Get list of signing keys
*KeyLinkBetaApi* | [**get_validation_key**](https://github.com/fireblocks/py-sdk/tree/master/docs/KeyLinkBetaApi.md#get_validation_key) | **GET** /key_link/validation_keys/{keyId} | Get a validation key by &#x60;keyId&#x60;
*KeyLinkBetaApi* | [**get_validation_keys_list**](https://github.com/fireblocks/py-sdk/tree/master/docs/KeyLinkBetaApi.md#get_validation_keys_list) | **GET** /key_link/validation_keys | Get list of registered validation keys
*KeyLinkBetaApi* | [**set_agent_id**](https://github.com/fireblocks/py-sdk/tree/master/docs/KeyLinkBetaApi.md#set_agent_id) | **PATCH** /key_link/signing_keys/{keyId}/agent_user_id | Set agent user id
*KeyLinkBetaApi* | [**update_signing_key**](https://github.com/fireblocks/py-sdk/tree/master/docs/KeyLinkBetaApi.md#update_signing_key) | **PATCH** /key_link/signing_keys/{keyId} | Modify the signing keyId
*KeysBetaApi* | [**get_mpc_keys_list**](https://github.com/fireblocks/py-sdk/tree/master/docs/KeysBetaApi.md#get_mpc_keys_list) | **GET** /keys/mpc/list | Get list of mpc keys
*KeysBetaApi* | [**get_mpc_keys_list_by_user**](https://github.com/fireblocks/py-sdk/tree/master/docs/KeysBetaApi.md#get_mpc_keys_list_by_user) | **GET** /keys/mpc/list/{userId} | Get list of mpc keys by &#x60;userId&#x60;
*NFTsApi* | [**get_nft**](https://github.com/fireblocks/py-sdk/tree/master/docs/NFTsApi.md#get_nft) | **GET** /nfts/tokens/{id} | List token data by ID
*NFTsApi* | [**get_nfts**](https://github.com/fireblocks/py-sdk/tree/master/docs/NFTsApi.md#get_nfts) | **GET** /nfts/tokens | List tokens by IDs
*NFTsApi* | [**get_ownership_tokens**](https://github.com/fireblocks/py-sdk/tree/master/docs/NFTsApi.md#get_ownership_tokens) | **GET** /nfts/ownership/tokens | List all owned tokens (paginated)
*NFTsApi* | [**list_owned_collections**](https://github.com/fireblocks/py-sd