Skip to main content
GET
/
wallets
/
mpc
/
vaults
/
{vault_id}
/
key_share_holder_groups
import cobo_waas2
from cobo_waas2.models.key_share_holder_group_type import KeyShareHolderGroupType
from cobo_waas2.models.list_key_share_holder_groups200_response import (
    ListKeyShareHolderGroups200Response,
)
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.WalletsMPCWalletsApi(api_client)
    vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    key_share_holder_group_type = cobo_waas2.KeyShareHolderGroupType()
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"

    try:
        # List all key share holder groups
        api_response = api_instance.list_key_share_holder_groups(
            vault_id,
            key_share_holder_group_type=key_share_holder_group_type,
            limit=limit,
            before=before,
            after=after,
        )
        print("The response of WalletsMPCWalletsApi->list_key_share_holder_groups:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling WalletsMPCWalletsApi->list_key_share_holder_groups: %s\n"
            % e
        )


{
  "data": [
    {
      "key_share_holder_group_id": "b33130a9-6e18-44a9-9e48-8b3b41921f0e",
      "type": "MainGroup",
      "tss_key_share_groups": [
        {
          "tss_key_share_group_id": "mMedDioOKhTlhGyQRzMv",
          "curve": "SECP256K1",
          "root_pubkey": "xpub661MyMwAqRbcG4vPNi58VQJrXW8D9VzmauuRq2rTY3oUVnKGuLTxQxvvoEXgLvZ7N9GQXQkWVgKn1rzEUUEm4NdvrBKUqjpNJEnn2UL4rYq"
        }
      ],
      "key_share_holders": [
        {
          "name": "Key share holder name",
          "type": "API",
          "tss_node_id": "coboAbCdEfGhIjKlMnOpQrStUvWxYz1234567890abcdefghi",
          "online": true,
          "signer": true,
          "status": "Valid",
          "account_id": "auth0|cobo|839305394802991371"
        }
      ],
      "participants": 3,
      "threshold": 2,
      "status": "Valid",
      "created_timestamp": 1718619403933
    }
  ],
  "pagination": {
    "before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
    "after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
    "total_count": 10000
  }
}
import cobo_waas2
from cobo_waas2.models.key_share_holder_group_type import KeyShareHolderGroupType
from cobo_waas2.models.list_key_share_holder_groups200_response import (
    ListKeyShareHolderGroups200Response,
)
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.WalletsMPCWalletsApi(api_client)
    vault_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    key_share_holder_group_type = cobo_waas2.KeyShareHolderGroupType()
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"

    try:
        # List all key share holder groups
        api_response = api_instance.list_key_share_holder_groups(
            vault_id,
            key_share_holder_group_type=key_share_holder_group_type,
            limit=limit,
            before=before,
            after=after,
        )
        print("The response of WalletsMPCWalletsApi->list_key_share_holder_groups:\n")
        pprint(api_response)
    except Exception as e:
        print(
            "Exception when calling WalletsMPCWalletsApi->list_key_share_holder_groups: %s\n"
            % e
        )

Authorizations

​
BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Path Parameters

​
vault_id
string<uuid>
required

The vault ID, which you can retrieve by calling List all vaults.

Query Parameters

​
key_share_holder_group_type
enum<string>

The key share holder group type. Possible values include:

Note: If this parameter is left empty, all key share holder group types will be retrieved.

The type of key share holder group. Possible values include:

Note: For MainGroup and SigningGroup, a Cobo key share holder will be added automatically.

Available options:
MainGroup,
SigningGroup,
RecoveryGroup
Example:

"MainGroup"

​
limit
integer<int32>
default:10

The maximum number of objects to return. For most operations, the value range is [1, 50].

​
before
string

A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.

​
after
string

A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.

Response

Successfully listed key share holder groups.

​
data
object[]
​
pagination
object

The pagination information of the returned data.