Platform APIEmbedded Wallets API
1.8.0
OAS 3.0.0

Fireblocks API

Fireblocks provides a robust REST API for developers to leverage Fireblocks' capabilities programmatically. Our REST API is the base layer for all Fireblocks SDKs.

Each endpoint is described with the required user role for interacting with it. For more information about the different user roles, please read the Manage Users guide.

Fireblocks Production Environment Base URL

Client Libraries
cURL Shell

Vault Accounts​

Vault Accounts Management APIs. Learn more about Fireblocks Vault Accounts in the following guide

Vault Accounts Endpoints

Create a new vault account​

Creates a new vault account with the requested name.

Learn more in the following guide.

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Headers
  • Idempotency-Key
    string

    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.

    Learn more in the following guide

    Examplesome-unique-id
Body
application/json
name
string

Vault Account name

ExampleMyVaultAccount
hiddenOnUI
boolean

Optional - if true, the created account and all related transactions will not be shown on Fireblocks console

customerRefId
string

Optional - Sets a customer reference ID for AML integrations

Examplesome-reference
autoFuel
boolean

Optional - Sets the autoFuel property of the vault account for the Fireblocks Gas Station

vaultType
string enum
default: 
MPC

Type of vault account. The default type will be set to MPC.
If the workspace does not support the selected type, it will return an error.

  • MPC
  • KEY_LINK
autoAssign
boolean
default: 
false

Applicable only when the vault account type is KEY_LINK. For MPC, this parameter will be ignored.
If set to true and there are available keys, random keys will be assigned to the newly created vault account.
If set to true and there are no available keys to be assigned, it will return an error.
If set to false, the vault account will be created without any keys.

Responses
POST/vault/accounts
vaultAccount = fireblocks.create_vault_account(name, hiddenOnUI, customer_ref_id, auto_fueling)

{
  "id": "0",
  "name": "MyVaultAccount",
  "assets": [
    {
      "id": "ETH",
      "total": "10.5",
      "balance": "10.5",
      "available": "9",
      "pending": "0.5",
      "frozen": "0.5",
      "lockedAmount": "0.5",
      "staked": "…",
      "totalStakedCPU": 1,
      "totalStakedNetwork": "…",
      "selfStakedCPU": "…",
      "selfStakedNetwork": "…",
      "pendingRefundCPU": "…",
      "pendingRefundNetwork": "…",
      "blockHeight": "19911062",
      "blockHash": "0xcc16c4ab5e018d1f05d3a18fcd122a3ef94276c10a4c89bbab10830f5c1ca742",
      "rewardsInfo": {
        "pendingRewards": "12"
      }
    }
  ],
  "hiddenOnUI": true,
  "customerRefId": "some-reference",
  "autoFuel": true,
  "vaultType": "MPC",
  "autoAssign": false
}

A Vault Account object

Models