fireblocks.EmbeddedWalletsApi

All URIs are relative to https://api.fireblocks.io/v1

Method	HTTP request	Description
add_embedded_wallet_asset	POST /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}	Add asset to account
assign_embedded_wallet	POST /ncw/wallets/{walletId}/assign	Assign a wallet
create_embedded_wallet	POST /ncw/wallets	Create a new wallet
create_embedded_wallet_account	POST /ncw/wallets/{walletId}/accounts	Create a new account
get_embedded_wallet	GET /ncw/wallets/{walletId}	Get a wallet
get_embedded_wallet_account	GET /ncw/wallets/{walletId}/accounts/{accountId}	Get a account
get_embedded_wallet_addresses	GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/addresses	Retrieve asset addresses
get_embedded_wallet_asset	GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}	Retrieve asset
get_embedded_wallet_asset_balance	GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance	Retrieve asset balance
get_embedded_wallet_assets	GET /ncw/wallets/{walletId}/accounts/{accountId}/assets	Retrieve assets
get_embedded_wallet_device	GET /ncw/wallets/{walletId}/devices/{deviceId}	Get Embedded Wallet Device
get_embedded_wallet_device_setup_state	GET /ncw/wallets/{walletId}/devices/{deviceId}/setup_status	Get device key setup state
get_embedded_wallet_devices_paginated	GET /ncw/wallets/{walletId}/devices_paginated	Get registered devices - paginated
get_embedded_wallet_latest_backup	GET /ncw/wallets/{walletId}/backup/latest	Get wallet Latest Backup details
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
get_embedded_wallet_setup_status	GET /ncw/wallets/{walletId}/setup_status	Get wallet key setup state
get_embedded_wallet_supported_assets	GET /ncw/wallets/supported_assets	Retrieve supported assets
get_embedded_wallets	GET /ncw/wallets	List wallets
get_public_key_info_ncw	GET /ncw/wallets/{walletId}/public_key_info	Get the public key for a derivation path
refresh_embedded_wallet_asset_balance	PUT /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance	Refresh asset balance
update_embedded_wallet_device_status	PATCH /ncw/wallets/{walletId}/devices/{deviceId}/status	Update device status
update_embedded_wallet_status	PATCH /ncw/wallets/{walletId}/status	Update wallet status

add_embedded_wallet_asset

EmbeddedWalletAddressDetails add_embedded_wallet_asset(wallet_id, account_id, asset_id, idempotency_key=idempotency_key)

Add asset to account

Get the addresses of a specific asset, under a specific account, under a specific Non Custodial Wallet

Example

from fireblocks.models.embedded_wallet_address_details import EmbeddedWalletAddressDetails
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id
    account_id = '0' # str | The ID of the account
    asset_id = 'BTC' # str | The ID of the asset
    idempotency_key = 'idempotency_key_example' # str | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)

    try:
        # Add asset to account
        api_response = fireblocks.embedded_wallets.add_embedded_wallet_asset(wallet_id, account_id, asset_id, idempotency_key=idempotency_key).result()
        print("The response of EmbeddedWalletsApi->add_embedded_wallet_asset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->add_embedded_wallet_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id
account_id	str	The ID of the account
asset_id	str	The ID of the asset
idempotency_key	str	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	[optional]

Return type

EmbeddedWalletAddressDetails

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

assign_embedded_wallet

EmbeddedWallet assign_embedded_wallet(wallet_id, idempotency_key=idempotency_key)

Assign a wallet

Assign a specific Non Custodial Wallet to a user

Example

from fireblocks.models.embedded_wallet import EmbeddedWallet
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id
    idempotency_key = 'idempotency_key_example' # str | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)

    try:
        # Assign a wallet
        api_response = fireblocks.embedded_wallets.assign_embedded_wallet(wallet_id, idempotency_key=idempotency_key).result()
        print("The response of EmbeddedWalletsApi->assign_embedded_wallet:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->assign_embedded_wallet: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id
idempotency_key	str	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	[optional]

Return type

EmbeddedWallet

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Wallet Assigned	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_embedded_wallet

EmbeddedWallet create_embedded_wallet(idempotency_key=idempotency_key)

Create a new wallet

Create new Non Custodial Wallet

Example

from fireblocks.models.embedded_wallet import EmbeddedWallet
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    idempotency_key = 'idempotency_key_example' # str | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)

    try:
        # Create a new wallet
        api_response = fireblocks.embedded_wallets.create_embedded_wallet(idempotency_key=idempotency_key).result()
        print("The response of EmbeddedWalletsApi->create_embedded_wallet:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->create_embedded_wallet: %s\n" % e)

Parameters

Name	Type	Description	Notes
idempotency_key	str	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	[optional]

Return type

EmbeddedWallet

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Wallet created successfully	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_embedded_wallet_account

EmbeddedWalletAccount create_embedded_wallet_account(wallet_id, idempotency_key=idempotency_key)

Create a new account

Create a new account under a specific Non Custodial Wallet

Example

from fireblocks.models.embedded_wallet_account import EmbeddedWalletAccount
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id
    idempotency_key = 'idempotency_key_example' # str | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)

    try:
        # Create a new account
        api_response = fireblocks.embedded_wallets.create_embedded_wallet_account(wallet_id, idempotency_key=idempotency_key).result()
        print("The response of EmbeddedWalletsApi->create_embedded_wallet_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->create_embedded_wallet_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id
idempotency_key	str	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	[optional]

Return type

EmbeddedWalletAccount

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Account Created	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallet

EmbeddedWallet get_embedded_wallet(wallet_id)

Get a wallet

Example

from fireblocks.models.embedded_wallet import EmbeddedWallet
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id

    try:
        # Get a wallet
        api_response = fireblocks.embedded_wallets.get_embedded_wallet(wallet_id).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallet:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallet: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id

Return type

EmbeddedWallet

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallet_account

EmbeddedWalletAccount get_embedded_wallet_account(wallet_id, account_id)

Get a account

Get a specific account under a specific Non Custodial Wallet

Example

from fireblocks.models.embedded_wallet_account import EmbeddedWalletAccount
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | WalletId
    account_id = '0' # str | The ID of the account

    try:
        # Get a account
        api_response = fireblocks.embedded_wallets.get_embedded_wallet_account(wallet_id, account_id).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallet_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallet_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	WalletId
account_id	str	The ID of the account

Return type

EmbeddedWalletAccount

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallet_addresses

EmbeddedWalletPaginatedAddressesResponse get_embedded_wallet_addresses(wallet_id, account_id, asset_id, page_cursor=page_cursor, page_size=page_size, sort=sort, order=order, enabled=enabled)

Retrieve asset addresses

Get the addresses of a specific asset, under a specific account, under a specific Non Custodial Wallet

Example

from fireblocks.models.embedded_wallet_paginated_addresses_response import EmbeddedWalletPaginatedAddressesResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id
    account_id = '0' # str | The ID of the account
    asset_id = 'BTC' # str | The ID of the asset
    page_cursor = 'MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==' # str | Cursor to the next page (optional)
    page_size = 10 # float | Items per page (optional)
    sort = createdAt # str | Sort by address (optional) (default to createdAt)
    order = ASC # str | Is the order ascending or descending (optional) (default to ASC)
    enabled = true # bool | Enabled (optional)

    try:
        # Retrieve asset addresses
        api_response = fireblocks.embedded_wallets.get_embedded_wallet_addresses(wallet_id, account_id, asset_id, page_cursor=page_cursor, page_size=page_size, sort=sort, order=order, enabled=enabled).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallet_addresses:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallet_addresses: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id
account_id	str	The ID of the account
asset_id	str	The ID of the asset
page_cursor	str	Cursor to the next page	[optional]
page_size	float	Items per page	[optional]
sort	str	Sort by address	[optional] [default to createdAt]
order	str	Is the order ascending or descending	[optional] [default to ASC]
enabled	bool	Enabled	[optional]

Return type

EmbeddedWalletPaginatedAddressesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallet_asset

EmbeddedWalletAssetResponse get_embedded_wallet_asset(wallet_id, account_id, asset_id)

Retrieve asset

Get asset under a specific account, under a specific Non Custodial Wallet

Example

from fireblocks.models.embedded_wallet_asset_response import EmbeddedWalletAssetResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id
    account_id = '0' # str | The ID of the account
    asset_id = 'BTC' # str | The ID of the asset

    try:
        # Retrieve asset
        api_response = fireblocks.embedded_wallets.get_embedded_wallet_asset(wallet_id, account_id, asset_id).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallet_asset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallet_asset: %s\n" % e)

Parameters

Name	Type	Description
wallet_id	str	Wallet Id
account_id	str	The ID of the account
asset_id	str	The ID of the asset

Return type

EmbeddedWalletAssetResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallet_asset_balance

EmbeddedWalletAssetBalance get_embedded_wallet_asset_balance(wallet_id, account_id, asset_id)

Retrieve asset balance

Get balance for specific asset, under a specific account

Example

from fireblocks.models.embedded_wallet_asset_balance import EmbeddedWalletAssetBalance
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id
    account_id = '0' # str | The ID of the account
    asset_id = 'BTC' # str | The ID of the asset

    try:
        # Retrieve asset balance
        api_response = fireblocks.embedded_wallets.get_embedded_wallet_asset_balance(wallet_id, account_id, asset_id).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallet_asset_balance:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallet_asset_balance: %s\n" % e)

Parameters

Name	Type	Description
wallet_id	str	Wallet Id
account_id	str	The ID of the account
asset_id	str	The ID of the asset

Return type

EmbeddedWalletAssetBalance

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallet_assets

EmbeddedWalletPaginatedAssetsResponse get_embedded_wallet_assets(wallet_id, account_id, sort=sort, page_cursor=page_cursor, page_size=page_size, order=order)

Retrieve assets

Retrieve assets for a specific account under a specific Non Custodial Wallet

Example

from fireblocks.models.embedded_wallet_paginated_assets_response import EmbeddedWalletPaginatedAssetsResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id
    account_id = '0' # str | The ID of the account
    sort = ["assetId"] # List[str] | Sort by fields (optional) (default to ["assetId"])
    page_cursor = 'page_cursor_example' # str | Cursor to the next page (optional)
    page_size = 200 # float | Amount of results to return in the next page (optional) (default to 200)
    order = ASC # str | Is the order ascending or descending (optional) (default to ASC)

    try:
        # Retrieve assets
        api_response = fireblocks.embedded_wallets.get_embedded_wallet_assets(wallet_id, account_id, sort=sort, page_cursor=page_cursor, page_size=page_size, order=order).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallet_assets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallet_assets: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id
account_id	str	The ID of the account
sort	List[str]	Sort by fields	[optional] [default to ["assetId"]]
page_cursor	str	Cursor to the next page	[optional]
page_size	float	Amount of results to return in the next page	[optional] [default to 200]
order	str	Is the order ascending or descending	[optional] [default to ASC]

Return type

EmbeddedWalletPaginatedAssetsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallet_device

EmbeddedWalletDevice get_embedded_wallet_device(wallet_id, device_id)

Get Embedded Wallet Device

Get specific device for a specific s Wallet

Example

from fireblocks.models.embedded_wallet_device import EmbeddedWalletDevice
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id
    device_id = '9ee1bff0-6dba-4f0c-9b75-03fe90e66fa3' # str | Device Id

    try:
        # Get Embedded Wallet Device
        api_response = fireblocks.embedded_wallets.get_embedded_wallet_device(wallet_id, device_id).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallet_device:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallet_device: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id
device_id	str	Device Id

Return type

EmbeddedWalletDevice

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallet_device_setup_state

EmbeddedWalletDeviceKeySetupResponse get_embedded_wallet_device_setup_state(wallet_id, device_id)

Get device key setup state

Get the state of the specific device setup key under a specific Non Custodial Wallet

Example

from fireblocks.models.embedded_wallet_device_key_setup_response import EmbeddedWalletDeviceKeySetupResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id
    device_id = '9ee1bff0-6dba-4f0c-9b75-03fe90e66fa3' # str | Device Id

    try:
        # Get device key setup state
        api_response = fireblocks.embedded_wallets.get_embedded_wallet_device_setup_state(wallet_id, device_id).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallet_device_setup_state:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallet_device_setup_state: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id
device_id	str	Device Id

Return type

EmbeddedWalletDeviceKeySetupResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallet_devices_paginated

EmbeddedWalletPaginatedDevicesResponse get_embedded_wallet_devices_paginated(wallet_id, sort=sort, page_cursor=page_cursor, page_size=page_size, order=order)

Get registered devices - paginated

Get a paginated list of registered devices for a specific Non Custodial Wallet

Example

from fireblocks.models.embedded_wallet_paginated_devices_response import EmbeddedWalletPaginatedDevicesResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id
    sort = ["createdAt"] # List[str] | Sort by fields (optional) (default to ["createdAt"])
    page_cursor = 'page_cursor_example' # str | Cursor to the next page (optional)
    page_size = 200 # float | Amount of results to return in the next page (optional) (default to 200)
    order = ASC # str | Is the order ascending or descending (optional) (default to ASC)

    try:
        # Get registered devices - paginated
        api_response = fireblocks.embedded_wallets.get_embedded_wallet_devices_paginated(wallet_id, sort=sort, page_cursor=page_cursor, page_size=page_size, order=order).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallet_devices_paginated:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallet_devices_paginated: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id
sort	List[str]	Sort by fields	[optional] [default to ["createdAt"]]
page_cursor	str	Cursor to the next page	[optional]
page_size	float	Amount of results to return in the next page	[optional] [default to 200]
order	str	Is the order ascending or descending	[optional] [default to ASC]

Return type

EmbeddedWalletPaginatedDevicesResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* X-Request-ID -
400	Query parameters were invalid	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallet_latest_backup

EmbeddedWalletLatestBackupResponse get_embedded_wallet_latest_backup(wallet_id)

Get wallet Latest Backup details

Get wallet Latest Backup details, including the deviceId, and backup time

Example

from fireblocks.models.embedded_wallet_latest_backup_response import EmbeddedWalletLatestBackupResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id

    try:
        # Get wallet Latest Backup details
        api_response = fireblocks.embedded_wallets.get_embedded_wallet_latest_backup(wallet_id).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallet_latest_backup:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallet_latest_backup: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id

Return type

EmbeddedWalletLatestBackupResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallet_public_key_info_for_address

PublicKeyInformation get_embedded_wallet_public_key_info_for_address(x_end_user_wallet_id, wallet_id, account_id, asset_id, change, address_index, compressed=compressed)

Get the public key of an asset

Gets the public key of an asset associated with a specific account within a Non-Custodial Wallet

Example

from fireblocks.models.public_key_information import PublicKeyInformation
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    x_end_user_wallet_id = 'x_end_user_wallet_id_example' # str | Unique ID of the End-User wallet to the API request. Required for end-user wallet operations.
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | The ID of the Non-Custodial wallet
    account_id = '0' # str | The ID of the account
    asset_id = 'BTC' # str | The ID of the asset
    change = 0 # float | BIP44 derivation path - change value
    address_index = 0 # float | BIP44 derivation path - index value
    compressed = true # bool | Compressed/Uncompressed public key format (optional)

    try:
        # Get the public key of an asset
        api_response = fireblocks.embedded_wallets.get_embedded_wallet_public_key_info_for_address(x_end_user_wallet_id, wallet_id, account_id, asset_id, change, address_index, compressed=compressed).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallet_public_key_info_for_address:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallet_public_key_info_for_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_end_user_wallet_id	str	Unique ID of the End-User wallet to the API request. Required for end-user wallet operations.
wallet_id	str	The ID of the Non-Custodial wallet
account_id	str	The ID of the account
asset_id	str	The ID of the asset
change	float	BIP44 derivation path - change value
address_index	float	BIP44 derivation path - index value
compressed	bool	Compressed/Uncompressed public key format	[optional]

Return type

PublicKeyInformation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Public Key Information	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallet_setup_status

EmbeddedWalletSetupStatusResponse get_embedded_wallet_setup_status(wallet_id)

Get wallet key setup state

Get the key setup state for a specific Non Custodial Wallet, including required algorithms and device setup status

Example

from fireblocks.models.embedded_wallet_setup_status_response import EmbeddedWalletSetupStatusResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id

    try:
        # Get wallet key setup state
        api_response = fireblocks.embedded_wallets.get_embedded_wallet_setup_status(wallet_id).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallet_setup_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallet_setup_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id

Return type

EmbeddedWalletSetupStatusResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallet_supported_assets

EmbeddedWalletPaginatedAssetsResponse get_embedded_wallet_supported_assets(page_cursor=page_cursor, page_size=page_size, only_base_assets=only_base_assets)

Retrieve supported assets

Get all the available supported assets for the Non-Custodial Wallet

Example

from fireblocks.models.embedded_wallet_paginated_assets_response import EmbeddedWalletPaginatedAssetsResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    page_cursor = 'MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==' # str | Next page cursor to fetch (optional)
    page_size = 200 # float | Items per page (optional) (default to 200)
    only_base_assets = true # bool | Only base assets (optional)

    try:
        # Retrieve supported assets
        api_response = fireblocks.embedded_wallets.get_embedded_wallet_supported_assets(page_cursor=page_cursor, page_size=page_size, only_base_assets=only_base_assets).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallet_supported_assets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallet_supported_assets: %s\n" % e)

Parameters

Name	Type	Description	Notes
page_cursor	str	Next page cursor to fetch	[optional]
page_size	float	Items per page	[optional] [default to 200]
only_base_assets	bool	Only base assets	[optional]

Return type

EmbeddedWalletPaginatedAssetsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_embedded_wallets

EmbeddedWalletPaginatedWalletsResponse get_embedded_wallets(page_cursor=page_cursor, page_size=page_size, sort=sort, order=order, enabled=enabled)

List wallets

Get all Non Custodial Wallets

Example

from fireblocks.models.embedded_wallet_paginated_wallets_response import EmbeddedWalletPaginatedWalletsResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    page_cursor = 'MjAyMy0xMi0xMyAyMDozNjowOC4zMDI=:MTEwMA==' # str | Next page cursor to fetch (optional)
    page_size = 200 # float | Items per page (optional) (default to 200)
    sort = createdAt # str | Field(s) to use for sorting (optional) (default to createdAt)
    order = ASC # str | Is the order ascending or descending (optional) (default to ASC)
    enabled = true # bool | Enabled Wallets (optional)

    try:
        # List wallets
        api_response = fireblocks.embedded_wallets.get_embedded_wallets(page_cursor=page_cursor, page_size=page_size, sort=sort, order=order, enabled=enabled).result()
        print("The response of EmbeddedWalletsApi->get_embedded_wallets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_embedded_wallets: %s\n" % e)

Parameters

Name	Type	Description	Notes
page_cursor	str	Next page cursor to fetch	[optional]
page_size	float	Items per page	[optional] [default to 200]
sort	str	Field(s) to use for sorting	[optional] [default to createdAt]
order	str	Is the order ascending or descending	[optional] [default to ASC]
enabled	bool	Enabled Wallets	[optional]

Return type

EmbeddedWalletPaginatedWalletsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_public_key_info_ncw

PublicKeyInformation get_public_key_info_ncw(x_end_user_wallet_id, wallet_id, derivation_path, algorithm, compressed=compressed)

Get the public key for a derivation path

Gets the public key information based on derivation path and signing algorithm within a Non-Custodial Wallet

Example

from fireblocks.models.public_key_information import PublicKeyInformation
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    x_end_user_wallet_id = 'x_end_user_wallet_id_example' # str | Unique ID of the End-User wallet to the API request. Required for end-user wallet operations.
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | The ID of the Non-Custodial wallet
    derivation_path = '[44,0,0,0,0]' # str | An array of integers (passed as JSON stringified array) representing the full BIP44 derivation path of the requested public key.  The first element must always be 44. 
    algorithm = 'MPC_EDDSA_ED25519' # str | Elliptic Curve
    compressed = true # bool | Compressed/Uncompressed public key format (optional)

    try:
        # Get the public key for a derivation path
        api_response = fireblocks.embedded_wallets.get_public_key_info_ncw(x_end_user_wallet_id, wallet_id, derivation_path, algorithm, compressed=compressed).result()
        print("The response of EmbeddedWalletsApi->get_public_key_info_ncw:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->get_public_key_info_ncw: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_end_user_wallet_id	str	Unique ID of the End-User wallet to the API request. Required for end-user wallet operations.
wallet_id	str	The ID of the Non-Custodial wallet
derivation_path	str	An array of integers (passed as JSON stringified array) representing the full BIP44 derivation path of the requested public key. The first element must always be 44.
algorithm	str	Elliptic Curve
compressed	bool	Compressed/Uncompressed public key format	[optional]

Return type

PublicKeyInformation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Public key information	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

refresh_embedded_wallet_asset_balance

EmbeddedWalletAssetBalance refresh_embedded_wallet_asset_balance(wallet_id, account_id, asset_id, idempotency_key=idempotency_key)

Refresh asset balance

Refresh the balance of an asset in a specific account

Example

from fireblocks.models.embedded_wallet_asset_balance import EmbeddedWalletAssetBalance
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id
    account_id = '0' # str | The ID of the account
    asset_id = 'BTC' # str | The ID of the asset
    idempotency_key = 'idempotency_key_example' # str | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)

    try:
        # Refresh asset balance
        api_response = fireblocks.embedded_wallets.refresh_embedded_wallet_asset_balance(wallet_id, account_id, asset_id, idempotency_key=idempotency_key).result()
        print("The response of EmbeddedWalletsApi->refresh_embedded_wallet_asset_balance:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->refresh_embedded_wallet_asset_balance: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id
account_id	str	The ID of the account
asset_id	str	The ID of the asset
idempotency_key	str	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	[optional]

Return type

EmbeddedWalletAssetBalance

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_embedded_wallet_device_status

update_embedded_wallet_device_status(wallet_id, device_id, enable_device, idempotency_key=idempotency_key)

Update device status

Update the enabled/disabled status of a specific device for a Non Custodial Wallet

Example

from fireblocks.models.enable_device import EnableDevice
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id
    device_id = '9ee1bff0-6dba-4f0c-9b75-03fe90e66fa3' # str | Device Id
    enable_device = fireblocks.EnableDevice() # EnableDevice | 
    idempotency_key = 'idempotency_key_example' # str | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)

    try:
        # Update device status
        fireblocks.embedded_wallets.update_embedded_wallet_device_status(wallet_id, device_id, enable_device, idempotency_key=idempotency_key).result()
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->update_embedded_wallet_device_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id
device_id	str	Device Id
enable_device	EnableDevice
idempotency_key	str	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content - Device status updated successfully	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_embedded_wallet_status

update_embedded_wallet_status(wallet_id, enable_wallet, idempotency_key=idempotency_key)

Update wallet status

Update the enabled/disabled status of a specific Non Custodial Wallet

Example

from fireblocks.models.enable_wallet import EnableWallet
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
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:
    wallet_id = '550e8400-e29b-41d4-a716-446655440000' # str | Wallet Id
    enable_wallet = fireblocks.EnableWallet() # EnableWallet | 
    idempotency_key = 'idempotency_key_example' # str | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)

    try:
        # Update wallet status
        fireblocks.embedded_wallets.update_embedded_wallet_status(wallet_id, enable_wallet, idempotency_key=idempotency_key).result()
    except Exception as e:
        print("Exception when calling EmbeddedWalletsApi->update_embedded_wallet_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
wallet_id	str	Wallet Id
enable_wallet	EnableWallet
idempotency_key	str	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content - Wallet status updated successfully	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

EmbeddedWalletsApi.md

Latest commit

History

EmbeddedWalletsApi.md

File metadata and controls

fireblocks.EmbeddedWalletsApi

add_embedded_wallet_asset

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

assign_embedded_wallet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_embedded_wallet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_embedded_wallet_account

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_embedded_wallet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_embedded_wallet_account

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_embedded_wallet_addresses

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_embedded_wallet_asset

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_embedded_wallet_asset_balance

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_embedded_wallet_assets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_embedded_wallet_device

Example

Parameters