HD Wallets

List HD Wallets

curl

curl -i \
     -H 'content-type: application/json' \
     -H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
     https://nchain.provide.services/api/v1/wallets
HTTP/2 200

Response JSON

[
    {
        "id": "2a53547f-2e8f-4cd9-9864-e055768b779e",
        "created_at": "2019-12-02T05:31:08.455649-05:00",
        "application_id": "dc4152f7-456f-41ed-96b4-e52b8faa05fd",
        "purpose": 44,
        "mnemonic": "aware display shoulder circle nature glass marble hobby embody truly universe verify",
        "public_key": "xpub661MyMwAqRbcGdH28ehGpkWuGjHp4UYZZoG65FWFkzz1cqUdrn1oXR8kKWm92ESeWBATrw5tDSC7NbUUiaLsucUmBjyxgHJ9bqcNMhEiCYr",
        "private_key": "xprv9s21ZrQH143K49CZ2dAGTcaAihTKf1piCaLVGs6eCfT2k39VKEhYycpGUDAMKWHdZ9eZq6ph4G8Hsaf2haMtqEskk5Xs6DdQpgavNLRJFVK"
    },
    {
        "id": "965b33bd-1c02-4f2c-84b3-249d554d1756",
        "created_at": "2019-12-02T05:28:34.066167-05:00",
        "application_id": "dc4152f7-456f-41ed-96b4-e52b8faa05fd",
        "purpose": 44,
        "mnemonic": "swift exact taste divorce kitchen input avoid copy jump guitar puppy bargain",
        "public_key": "xpub661MyMwAqRbcGU19jJHtbw54SqjjWAGqFWeGbZwrMbwhvJc7VdNcYQ5BUaiAH4v9x8uhjWdxh7BXofnVsjiqoBwHoxGTZh3pqw2QmjzrCVS",
        "private_key": "xprv9s21ZrQH143K3yvgdGktEo8KtouF6hYytHifoBYEoGQj3WGxx64MzbkhdHKW1H3gHTPMCPAeExasU5wf6bcudoHaC5ZqS95gy1CmU9n8UFf"
    },
    {
        "id": "045ed108-188d-41cb-b218-967c2df6ec2a",
        "created_at": "2019-12-02T04:57:40.354586-05:00",
        "application_id": "dc4152f7-456f-41ed-96b4-e52b8faa05fd",
        "purpose": 44,
        "mnemonic": "same hire quit ivory yard bronze village cheap scheme laundry effort noodle",
        "public_key": "xpub661MyMwAqRbcGnt6jisuKqpRNtQ4LyhefCwCcLzmiPQqwYaUKntdPwmA7HG3NHfGM3oTJDUZZdsDvoWwnuJ1fWBgR6RHTmpDFsH1bfspe7F",
        "private_key": "xprv9s21ZrQH143K4JoddhLtxhsgprZZwWyoHz1boxbAA3ss4kFKnFaNr9SgFzziAC2vKDLMRMa2CCiZAqDq4GpWcgNX3BeSULP4mSjYDztVKoQ"
    },
    {
        "id": "7baf5ec7-0c10-40bc-80ca-93af0abc4beb",
        "created_at": "2019-12-02T04:38:48.625052-05:00",
        "application_id": "dc4152f7-456f-41ed-96b4-e52b8faa05fd",
        "purpose": 44,
        "mnemonic": "bird present pattern brave powder banana street fancy become gloom strong illegal",
        "public_key": "xpub661MyMwAqRbcF9SjWTQp7cG7rvtr15G8EEJanFhTm2fQjoPijpSWk9uNaWcrXvUfHhgdSq9F7cbH66EdhoMVgAE639rxWN36ZxMEeAZaKu6",
        "private_key": "xprv9s21ZrQH143K2fNGQRsokUKPJu4MbcYGs1NyysHrCh8Rs14aCH8GCMatjDKEHXzUkGB194ob5bC7R7ZzNQWd7pyso5EcvKP6oDcMG1MZude"
    },
    {
        "id": "88081786-f3d7-4907-b1af-b7f23de3a471",
        "created_at": "2019-12-02T04:24:14.846977-05:00",
        "application_id": "dc4152f7-456f-41ed-96b4-e52b8faa05fd",
        "purpose": 44,
        "mnemonic": "turn indicate cricket color agent dove garlic setup pizza slam bottom bracket",
        "public_key": "xpub661MyMwAqRbcG7pghb1JGXXjQ9fhM3BzsPZLuWhuzjn129cKR37pZBUvaNYA7a1YJ5zTsiALJVqA5mn8K6Xt8k6KyQWfSuhEH81T23EMjZx",
        "private_key": "xprv9s21ZrQH143K3dkDbZUHuPazr7qCwaU9WAdk78JJSQF29MHAsVoa1PASj6vXiVYb3QyE3eoc4oDmjAJoGG3cdGYwscCWUpRwmzxwiu6vc1D"
    }
]

This endpoint enumerates HD (hierarchical deterministic) wallets used for deriving addresses in accordance with BIP32.

Create HD Wallet

curl

curl -i \
     -H 'content-type: application/json' \
     -H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
     https://nchain.provide.services/api/v1/wallets \
     -d '{"purpose": 44}'
HTTP/2 201

Response JSON

{
    "id": "2a53547f-2e8f-4cd9-9864-e055768b779e",
    "created_at": "2019-12-02T05:31:08.455649-05:00",
    "application_id": "dc4152f7-456f-41ed-96b4-e52b8faa05fd",
    "path": "m/44'",
    "purpose": 44,
    "mnemonic": "aware display shoulder circle nature glass marble hobby embody truly universe verify",
    "public_key": "xpub661MyMwAqRbcGdH28ehGpkWuGjHp4UYZZoG65FWFkzz1cqUdrn1oXR8kKWm92ESeWBATrw5tDSC7NbUUiaLsucUmBjyxgHJ9bqcNMhEiCYr",
    "private_key": "xprv9s21ZrQH143K49CZ2dAGTcaAihTKf1piCaLVGs6eCfT2k39VKEhYycpGUDAMKWHdZ9eZq6ph4G8Hsaf2haMtqEskk5Xs6DdQpgavNLRJFVK"
}

Creates an HD (hierarchical deterministic) Wallet in accordance with BIP32. A Wallet may be setup as custodial or non-custodial. If the Wallet is custodial then the platform will derive addresses and securely persist an Account for each of those derived addresses.

Request Parameters

Parameter	Description
purpose	specification to be used by the HD node subtree; set to 44 for 44' (i.e., 0x8000002C following the BIP43 recommendation)

List Derived HD Wallet Addresses

curl

curl -i \
     -H 'content-type: application/json' \
     -H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
     https://nchain.provide.services/api/v1/wallets/88081786-f3d7-4907-b1af-b7f23de3a471/accounts?page=1
HTTP/2 200

Response JSON

[
    {
        "address": "0xE6A91a61Ddb666010f9B1698A52f8d2E9D7f26B2",
        "hd_derivation_path": "m/44'/60'/0'/0/0"
    }
]

This endpoint returns a paginated list of the derived addresses for a specific derivation path for a specific HD (hierarchical deterministic) wallet.

The HD derivation path for each derived address is returned. The returned addresses are not currently being "pinned" (or otherwise persisted) by the API; as such, an ephemeral representation of the Account, complete with its derived key material, is returned by the API.

URL Parameters

Parameter	Description
id	id of the HD Wallet

Query Parameters

Parameter	Description
coin_type	the coin type, per BIP44
index	the index of the account or identity, per BIP44
chain_path	a constant representing the internal or external chain path, per BIP44; public derivation is used at this level

In addition to the above parameters, page and rpp pagination query parameters are supported.