Search…
⌃K

Accounts

Overview

An Account is an arbitrary keypair capable of storing value on the underlying `Network`; also referred to as a signing identity.
Accounts are capable of storing cryptocurrencies and tokens native to a specific Network, as well as authorization credentials and cryptographic material on behalf of Provide users. An Account may be setup as custodial or non-custodial, and may be derived from a Wallet. If the Account is custodial then the platform will sign and broadcast transactions to the specified network on behalf of an authorized User or Application

List Accounts

get
https://nchain.provide.services
/api/v1/accounts
List Accounts
curl
Response JSON
curl -i \
-H 'content-type: application/json' \
-H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
https://nchain.provide.services/api/v1/accounts
HTTP/2 200
{
"id": "efef1044-4958-43bc-903b-28f2bb938037",
"created_at": "2018-10-03T20:48:03.24878Z",
"application_id": "e49302c5-e485-4e14-9b0f-db5643b6a15c",
"user_id": null,
"network_id": "024ff1ef-7369-4dee-969c-1918c6edb5d4",
"address": "0xAC805F1c2Bf9a19b448bc207075B992Be29bC91a",
"accessed_at": "2018-10-03T20:48:37.291739Z"
}
This endpoint enumerates accounts used for storing cryptocurrency or tokens on behalf of Provide users managing cryptographic material (i.e., for signing transactions).
Balances are not returned here for performance reasons; see GET /api/v1/accounts/:id to get balance details in the native currency for the network and GET /api/v1/accounts/:id/balances/:token_id to get balance details for a specific token, if supported by the account and network.

Create Account

post
https://nchain.provide.services
/api/v1/accounts
Create Account
curl
Response JSON
curl -i \
-H 'content-type: application/json' \
-H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
https://nchain.provide.services/api/v1/accounts --data-binary @- << EOF
{
"network_id":"024ff1ef-7369-4dee-969c-1918c6edb5d4"
}
EOF
{
"id": "4059f749-55ad-4c1c-975d-6c5040801079",
"created_at": "2018-10-12T21:47:13.698524641Z",
"application_id": "e49302c5-e485-4e14-9b0f-db5643b6a15c",
"user_id": null,
"network_id": "024ff1ef-7369-4dee-969c-1918c6edb5d4",
"address": "0xa4f8874C971EB257C0Fd8e33401b274e2a27133d"
}
Creates an Account (also referred to as a signing identity) capable of storing cryptocurrencies and tokens native to a specific Network. An Account may be setup as custodial or non-custodial, and may be derived from a HD (hierarchical deterministic) Wallet. If the Account is custodial then the platform will sign and broadcast transactions to the Network on behalf of an authorized User or Application.

Retrieve Account Details

get
https://nchain.provide.services
/api/v1/accounts/:id
Get Account Details
curl
Response JSON
curl -i \
-H 'content-type: application/json' \
-H 'authorization: bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7fSwiZXhwIjpudWxsLCJpYXQiOjE1NTk4Nzg1NzQsImp0aSI6IjYzYTJkY2QzLWI5OTgtNDZjNC1hNzFkLTQ5MjU4YTBhYmEyMyIsInN1YiI6ImFwcGxpY2F0aW9uOmNiMjAzN2Y3LTc5ZmMtNDBmNC05NzIwLWFkYTYzNmRhNDE4MyJ9.0LsVj7oTF0KjwbcUhg9a-fQRWB7cGzKJxLIANeX2cWE' \
https://nchain.provide.services/api/v1/accounts/efef1044-4958-43bc-903b-28f2bb938037
HTTP/2 200
{
"id": "efef1044-4958-43bc-903b-28f2bb938037",
"created_at": "2018-10-03T20:48:03.24878Z",
"application_id": "e49302c5-e485-4e14-9b0f-db5643b6a15c",
"user_id": null,
"network_id": "024ff1ef-7369-4dee-969c-1918c6edb5d4",
"address": "0xAC805F1c2Bf9a19b448bc207075B992Be29bC91a",
"balance": 0,
"accessed_at": "2018-10-03T20:48:37.291739Z"
}
Retrieve details for an Account.

URL Parameters

Parameter
Description
id
id of the Account

Account Token Balance

Retrieve the on-chain token balance details for a specific Account and Token contract, if supported by the Account and Network.
Documentation forthcoming.

URL Parameters

Parameter
Description
id
id of the Account
token
id of address of the Token contract for which to retrieve the balance
Last modified 10mo ago