Account

List accounts

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · min: 1 · max: 9007199254740991Optional

Which page to fetch

Default: 1

pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30

statusstring · enumOptional

Account status

Possible values:

namestringOptional

Search by matching name

governanceTypestring · enumOptional

Account governance type

Possible values:

allowedActionstring · enumOptional

Filter accounts by allowed action for current user

Possible values:

sortBystring · enumOptional

Sort by attribute

Default: createdAtPossible values:

sortOrderstring · enumOptional

Sort order

Default: ascPossible values:

currencystringOptional

Filter accounts by currency

indexnumberOptional

Filter accounts by account index

contractAddressany ofOptional

stringOptional

or

nullOptional

supportstring · enumOptional

Filter accounts by support

Possible values:

typestring · enumOptional

Filter accounts by type

Possible values:

Responses

200

Successful response

application/json

pagenumberRequired

Current page

nextany ofRequired

Next page or null if there is none

numberOptional

or

nullOptional

prevany ofRequired

Previous page or null if there is none

numberOptional

or

nullOptional

pageSizenumberRequired

Max count of items per page

totalnumberRequired

Total count of items

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts

HTTPcURLJavaScriptPython

GET /v1/rest/accounts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "id": "text",
      "legacyId": 1,
      "name": "text",
      "currency": "text",
      "network": "text",
      "contractAddress": "text",
      "tokenIdentifier": "text",
      "index": 1,
      "derivationPath": "text",
      "status": "ACTIVE",
      "createdAt": "text",
      "updatedAt": "text",
      "asset": {
        "type": "text"
      },
      "governance": {
        "type": "text",
        "policyId": "text"
      }
    }
  ]
}

Get a single account

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target account

Responses

200

Successful response

application/json

idstringRequired

Internal unique identifier

legacyIdnumberRequired

Legacy internal unique identifier (for retro-compatibility)

namestringRequired

Name

currencystring · min: 1 · max: 40Required

Will be deprecated soon, use network instead. Currency

Pattern: ^\w+$

networkstring · min: 1 · max: 40Required

Network (Same as currency for now)

Pattern: ^\w+$

contractAddressany ofRequired

Token contract address for Token account

stringOptional

or

nullOptional

tokenIdentifierany ofRequired

Token identifier for Token account

stringOptional

or

nullOptional

indexnumberRequired

BIP44 account index

derivationPathstringRequired

Derivation path

statusstring · enumRequired

Status

Possible values:

createdAtstringRequired

Creation timestamp

updatedAtstringRequired

Last modification timestamp

assetone ofRequired

Account asset fields

or

or

or

or

or

or

or

or

or

or

or

or

or

governanceone ofRequired

Governance fields

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts/{id}

HTTPcURLJavaScriptPython

GET /v1/rest/accounts/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "legacyId": 1,
  "name": "text",
  "currency": "text",
  "network": "text",
  "contractAddress": "text",
  "tokenIdentifier": "text",
  "index": 1,
  "derivationPath": "text",
  "status": "ACTIVE",
  "createdAt": "text",
  "updatedAt": "text",
  "asset": {
    "type": "text"
  },
  "governance": {
    "type": "text",
    "policyId": "text"
  }
}

List account Tradelink pledges

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target account

Query parameters

pageinteger · min: 1 · max: 9007199254740991Optional

Which page to fetch

Default: 1

pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30

Responses

200

Successful response

application/json

pagenumberRequired

Current page

nextany ofRequired

Next page or null if there is none

numberOptional

or

nullOptional

prevany ofRequired

Previous page or null if there is none

numberOptional

or

nullOptional

pageSizenumberRequired

Max count of items per page

totalnumberRequired

Total count of items

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts/{id}/pledges

HTTPcURLJavaScriptPython

GET /v1/rest/accounts/{id}/pledges HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "tradelinkId": "text",
      "asset": {
        "name": "text",
        "magnitude": 1
      },
      "state": "PLEDGE_READY",
      "isLocked": true,
      "amount": "text",
      "pending": "text",
      "repledge": "text",
      "exchangeTradelinkId": "text",
      "accountId": "text"
    }
  ]
}

List account transactions

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target account

Query parameters

cursorstringOptional

Optional cursor to get next pages (based on the next key on query response)

Responses

200

Successful response

application/json

nextany ofRequired

Next page cursor

stringOptional

or

nullOptional

resultsone of[]Required

Array of results

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts/{id}/transactions

HTTPcURLJavaScriptPython

GET /v1/rest/accounts/{id}/transactions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": "text",
  "results": [
    {
      "id": "text",
      "hash": "text",
      "block": {
        "height": "text",
        "time": "text"
      },
      "status": "SUCCESSFUL",
      "confirmations": "text",
      "amount": "text",
      "fee": "text",
      "senders": [
        "text"
      ],
      "recipients": [
        "text"
      ],
      "type": "BITCOIN_LIKE_SEND",
      "note": {
        "title": "text",
        "content": "text"
      },
      "requestId": "text"
    }
  ]
}

Estimate transaction fees

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target account

Body

application/json

transactionone ofRequired

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

Responses

200

Successful response

application/json

or

or

or

or

or

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/accounts/{id}/estimate-fees

HTTPcURLJavaScriptPython

POST /v1/rest/accounts/{id}/estimate-fees HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "transaction": {
    "amount": "text",
    "currency": "text",
    "maxFee": "text",
    "recipient": "text",
    "type": "text",
    "feeStrategy": {
      "type": "SLOW",
      "feePerByte": "text"
    }
  }
}

{
  "type": "text",
  "fee": "text"
}

Securely get a verified address for an UTXO based account

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target account

indexinteger · max: 9007199254740991Required

Index of the address to retrieve

Responses

200

Successful response

application/json

stringOptional

JWT signed by the HSM, and containing the account address

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts/{id}/addresses/{index}

HTTPcURLJavaScriptPython

GET /v1/rest/accounts/{id}/addresses/{index} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Securely get a verified address for an EOA account

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target account

Responses

200

Successful response

application/json

stringOptional

JWT signed by the HSM, and containing the account address

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts/{id}/address

HTTPcURLJavaScriptPython

GET /v1/rest/accounts/{id}/address HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Get balance of a single account

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target account

Responses

200

Successful response

application/json

Account live data

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts/{id}/balance

HTTPcURLJavaScriptPython

GET /v1/rest/accounts/{id}/balance HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "balance": {
    "total": "text",
    "pending": "text"
  },
  "type": "text"
}

Get parent account info or own account info if there is no parent

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target account

Responses

200

Successful response

application/json

objectOptional

Account live data

or

or

or

or

or

or

or

or

or

or

or

or

or

and

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts/{id}/parent-account-info

HTTPcURLJavaScriptPython

GET /v1/rest/accounts/{id}/parent-account-info HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "balance": {
    "total": "text",
    "pending": "text"
  },
  "type": "text",
  "name": "text",
  "network": "text"
}

Get balances of multiple accounts

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idsstring[] · max: 30Required

Ids of the target accounts, maximum 30

Responses

200

Successful response

application/json

Account live data

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts/batch/balances

HTTPcURLJavaScriptPython

GET /v1/rest/accounts/batch/balances?ids=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "balance": {
      "total": "text",
      "pending": "text"
    },
    "type": "text"
  }
]

Get a fresh address of an account

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target account

Responses

200

Successful response

application/json

addressstringRequired

Address

derivationPathany ofRequired

Derivation path

stringOptional

or

nullOptional

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts/{id}/fresh-address

HTTPcURLJavaScriptPython

GET /v1/rest/accounts/{id}/fresh-address HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "address": "text",
  "derivationPath": "text"
}

List account stakes

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target account

Query parameters

cursorstringOptional

Optional cursor to get next pages (based on the next key on query response)

sortBystring · enumOptional

Sort by attribute

Default: totalPossible values:

sortOrderstring · enumOptional

Sort order

Default: descPossible values:

Responses

200

Successful response

application/json

nextany ofRequired

Next page cursor

stringOptional

or

nullOptional

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts/{id}/stakes

HTTPcURLJavaScriptPython

GET /v1/rest/accounts/{id}/stakes HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": "text",
  "results": [
    {
      "id": "text",
      "validator": "text",
      "state": "ACTIVE",
      "staked": "text",
      "rewards": {
        "total": "text"
      }
    }
  ]
}

List staking validators for account

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target account

Query parameters

cursorstringOptional

Optional cursor to get next pages (based on the next key on query response)

sortBystring · enumOptional

Sort by attribute

Default: balancePossible values:

sortOrderstring · enumOptional

Sort order

Default: descPossible values:

Responses

200

Successful response

application/json

nextany ofRequired

Next page cursor

stringOptional

or

nullOptional

resultsone of[]Required

Array of results

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts/{id}/staking-validators

HTTPcURLJavaScriptPython

GET /v1/rest/accounts/{id}/staking-validators HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": "text",
  "results": [
    {
      "address": "text",
      "apy": "text",
      "balance": "text",
      "commissionRate": "text",
      "description": "text",
      "logo": "text",
      "name": "text",
      "url": "text",
      "type": "text"
    }
  ]
}

Get pre-approval state of a Canton account

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target Canton account

Responses

200

Successful response

application/json

Pre-approval state of the account

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts/{id}/canton/pre-approval-state

HTTPcURLJavaScriptPython

GET /v1/rest/accounts/{id}/canton/pre-approval-state HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "enabled": true,
  "contractId": "text",
  "expiresAt": "text",
  "lastRenewedAt": "text",
  "provider": "text",
  "recipient": "text",
  "validFrom": "text"
}

Get transfer proposals to a Canton account

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the target Canton account

Responses

200

Successful response

application/json

A pending asset-transfer request

amountstring · min: 1Required

Transfer amount

Pattern: ^([1-9]\d*|0)$

contractIdstringRequired

ID of the transfer-proposal contract

instrumentAdminstringRequired

Issuer of the instrument being transferred

instrumentIdstringRequired

ID of the instrument being transferred

expiresAtMicrosinteger · min: -9007199254740991 · max: 9007199254740991Required

Expiration timestamp in microseconds

reasonany ofRequired

Optional reason attached to the transfer

stringOptional

or

nullOptional

senderstringRequired

Party proposing to send the asset

recipientstringRequired

Intended recipient of the proposed transfer

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/accounts/{id}/canton/transfer-proposals

HTTPcURLJavaScriptPython

GET /v1/rest/accounts/{id}/canton/transfer-proposals HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "amount": "text",
    "contractId": "text",
    "instrumentAdmin": "text",
    "instrumentId": "text",
    "expiresAtMicros": 1,
    "reason": "text",
    "sender": "text",
    "recipient": "text"
  }
]

List signed digests by account

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · min: 1 · max: 9007199254740991Optional

Which page to fetch

Default: 1

pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30

accountIdstringRequired

Id of the target account

Responses

200

Successful response

application/json

pagenumberRequired

Current page

nextany ofRequired

Next page or null if there is none

numberOptional

or

nullOptional

prevany ofRequired

Previous page or null if there is none

numberOptional

or

nullOptional

pageSizenumberRequired

Max count of items per page

totalnumberRequired

Total count of items

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/signed-digests

HTTPcURLJavaScriptPython

GET /v1/rest/signed-digests?accountId=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "id": "text",
      "items": [
        {
          "digest": "text",
          "derivationPath": "text",
          "signature": {
            "digest": "text",
            "derivationPath": "text",
            "r": "text",
            "s": "text",
            "v": 1,
            "der": "text",
            "pubkey": "text"
          }
        }
      ],
      "createdById": "text",
      "createdAt": "text"
    }
  ]
}

Get signed digests

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the signed digests

Responses

200

Successful response

application/json

idstringRequired

Unique identifier

createdByIdstringRequired

ID of the creator

createdAtstringRequired

Creation timestamp

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/signed-digests/{id}

HTTPcURLJavaScriptPython

GET /v1/rest/signed-digests/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "items": [
    {
      "digest": "text",
      "derivationPath": "text",
      "signature": {
        "digest": "text",
        "derivationPath": "text",
        "r": "text",
        "s": "text",
        "v": 1,
        "der": "text",
        "pubkey": "text"
      }
    }
  ],
  "createdById": "text",
  "createdAt": "text"
}

List signed messages by account

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · min: 1 · max: 9007199254740991Optional

Which page to fetch

Default: 1

pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30

accountIdstringRequired

Id of the target account

Responses

200

Successful response

application/json

pagenumberRequired

Current page

nextany ofRequired

Next page or null if there is none

numberOptional

or

nullOptional

prevany ofRequired

Previous page or null if there is none

numberOptional

or

nullOptional

pageSizenumberRequired

Max count of items per page

totalnumberRequired

Total count of items

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/signed-messages

HTTPcURLJavaScriptPython

GET /v1/rest/signed-messages?accountId=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "id": "text",
      "address": "text",
      "derivationPath": "text",
      "signature": {
        "digest": "text",
        "derivationPath": "text",
        "r": "text",
        "s": "text",
        "v": 1,
        "der": "text",
        "pubkey": "text"
      },
      "createdById": "text",
      "createdAt": "text",
      "type": "text",
      "data": "text"
    }
  ]
}

Get a single signed message

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Id of the signed message

Responses

200

Successful response

application/json

Signed message

and

objectOptional

or

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/signed-messages/{id}

HTTPcURLJavaScriptPython

GET /v1/rest/signed-messages/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "address": "text",
  "derivationPath": "text",
  "signature": {
    "digest": "text",
    "derivationPath": "text",
    "r": "text",
    "s": "text",
    "v": 1,
    "der": "text",
    "pubkey": "text"
  },
  "createdById": "text",
  "createdAt": "text",
  "type": "text",
  "data": "text"
}

Get a single outgoing transaction

get

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

targetId of the outgoing transaction request

Responses

200

Successful response

application/json

idstringRequired

Unique identifier

workspaceNamestring · min: 1 · max: 20Required

Workspace name

Pattern: ^[a-z0-9]+$

accountIdstringRequired

Account that initiated the transaction

hashany ofRequired

Transaction's hash

stringOptional

or

nullOptional

statusstring · enumRequired

Status of the transaction

Possible values:

intentone ofRequired

Transaction intent data

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/outgoing-transactions/{id}

HTTPcURLJavaScriptPython

GET /v1/rest/outgoing-transactions/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "workspaceName": "text",
  "accountId": "text",
  "hash": "text",
  "status": "SCHEDULED",
  "intent": {
    "amount": "text",
    "currency": "text",
    "maxFee": "text",
    "recipient": "text",
    "type": "text",
    "feeStrategy": {
      "type": "SLOW",
      "feePerByte": "text"
    }
  }
}