API Reference

• NotificationService
  • getGetVtxoNotifications streams notifications for subscribed addresses
  • postSubscribeForAddresses subscribes for notifications for given addresses
  • postUnsubscribeForAddresses unsubscribes from notifications for given addresses
• Service
  • getGetAddress returns offchain address
  • getGetBalance returns ark balance
  • getGetDelegatePublicKey retrieves the Fulmine's public key to be included in VTXO scripts.
  • postUnwatchAddress unsubscribes an address from vtxo rollover
  • postWatchAddressForRollover watches an address for rollover
  • getListWatchedAddresses lists all watched addresses
  • getGetInfo returns info about the ark account
  • postService_CreateInvoice
  • postService_PayInvoice
  • getService_IsInvoiceSettled
  • postRedeems an ark note by joining a round
  • postGetOnboardAddress returns onchain address and invoice for requested amount
  • getReturns round info for optional round_id (no round_id returns current round info)
  • postSend asks to send amount to ark address by joining a round
  • postSendOnChain asks to send requested amount to requested onchain address
  • getSettle vtxos and boarding utxos
  • postService_SignTransaction
  • getGetTransactionHistory returns virtual transactions history
  • getListVHTLC = list all vhtlc OR filter by preimage_hash
  • postCreateVHTLCAddress computes a VHTLC address
  • postClaimVHTLC = self send vHTLC -> VTXO
  • postService_RefundVHTLCWithoutReceiver
• WalletService
  • postChangePassword changes the password used to encrypt/decrypt the HD seeds. It requires the wallet to be locked.
  • postAuth verifies whether the given password is valid without unlocking the wallet
  • postCreateWallet creates an HD Wallet based on signing seeds, encrypts them with the password and persists the encrypted seeds.
  • getGenSeed returns signing seed that should be used to create a new HD Wallet.
  • postLock locks the HD wallet.
  • postRestoreWallet restores an HD Wallet based on signing seeds, encrypts them with the password and persists the encrypted seeds.
  • getStatus returns info about the status of the wallet.
  • postUnlock tries to unlock the HD Wallet using the given password.

API docs by Redocly

fulmine/v1/notification.proto (version not set)

Download OpenAPI specification:Download

NotificationService

GetVtxoNotifications streams notifications for subscribed addresses

Responses

https://docs.arklabs.xyz/v1/notifications

Response samples

• 200
• default

Content type

application/json

{

• "result": {

  • "notification": {

    • "address": "string",
    • "newVtxos": [

      • {

        • "outpoint": {

          • "txid": "string",
          • "vout": 0

          },
        • "receiver": {

          • "pubkey": "string",
          • "amount": "string"

          },
        • "roundTxid": "string",
        • "spentBy": "string",
        • "expireAt": "string"

        }

      ],
    • "spentVtxos": [

      • {

        • "outpoint": {

          • "txid": "string",
          • "vout": 0

          },
        • "receiver": {

          • "pubkey": "string",
          • "amount": "string"

          },
        • "roundTxid": "string",
        • "spentBy": "string",
        • "expireAt": "string"

        }

      ]

    }

  },
• "error": {

  • "code": 0,
  • "message": "string",
  • "details": [

    • {

      • "@type": "string",
      • "property1": null,
      • "property2": null

      }

    ]

  }

}

SubscribeForAddresses subscribes for notifications for given addresses

Request Body schema: application/json

required

addresses

Array of strings

Responses

https://docs.arklabs.xyz/v1/subscribe

Request samples

• Payload

Content type

application/json

{

• "addresses": [

  • "string"

  ]

}

Response samples

• 200
• default

Content type

application/json

{ }

UnsubscribeForAddresses unsubscribes from notifications for given addresses

Request Body schema: application/json

required

addresses

Array of strings

Responses

https://docs.arklabs.xyz/v1/unsubscribe

Request samples

• Payload

Content type

application/json

{

• "addresses": [

  • "string"

  ]

}

Response samples

• 200
• default

Content type

application/json

{ }

Service

GetAddress returns offchain address

Responses

https://docs.arklabs.xyz/v1/address

Response samples

• 200
• default

Content type

application/json

{

• "address": "string",
• "pubkey": "string"

}

GetBalance returns ark balance

Responses

https://docs.arklabs.xyz/v1/balance

Response samples

• 200
• default

Content type

application/json

{

• "amount": "string"

}

GetDelegatePublicKey retrieves the Fulmine's public key to be included in VTXO scripts.

Responses

https://docs.arklabs.xyz/v1/delegate/pubkey

Response samples

• 200
• default

Content type

application/json

{

• "publicKey": "string"

}

UnwatchAddress unsubscribes an address from vtxo rollover

Request Body schema: application/json

required

address

string (The address to stop watching)

Responses

https://docs.arklabs.xyz/v1/delegate/unwatch

Request samples

• Payload

Content type

application/json

{

• "address": "string"

}

Response samples

• 200
• default

Content type

application/json

{ }

WatchAddressForRollover watches an address for rollover

Request Body schema: application/json

required

	object (v1RolloverAddress)
address string (The watched address) object (v1Tapscripts) destinationAddress string (Where funds will be rolled over to)

Responses

https://docs.arklabs.xyz/v1/delegate/watch

Request samples

• Payload

Content type

application/json

{

• "rolloverAddress": {

  • "address": "string",
  • "taprootTree": {

    • "scripts": [

      • "string"

      ]

    },
  • "destinationAddress": "string"

  }

}

Response samples

• 200
• default

Content type

application/json

{ }

ListWatchedAddresses lists all watched addresses

Responses

https://docs.arklabs.xyz/v1/delegate/watched

Response samples

• 200
• default

Content type

application/json

{

• "addresses": [

  • {

    • "address": "string",
    • "taprootTree": {

      • "scripts": [

        • "string"

        ]

      },
    • "destinationAddress": "string"

    }

  ]

}

GetInfo returns info about the ark account

Responses

https://docs.arklabs.xyz/v1/info

Response samples

• 200
• default

Content type

application/json

{

• "network": "NETWORK_UNSPECIFIED",
• "addrPrefix": "string",
• "serverUrl": "string",
• "buildInfo": {

  • "version": "string",
  • "commit": "string",
  • "date": "string"

  },
• "pubkey": "string"

}

Service_CreateInvoice

Request Body schema: application/json

required

amount	string <uint64>
memo	string
preimage	string

Responses

https://docs.arklabs.xyz/v1/invoice

Request samples

• Payload

Content type

application/json

{

• "amount": "string",
• "memo": "string",
• "preimage": "string"

}

Response samples

• 200
• default

Content type

application/json

{

• "invoice": "string",
• "preimageHash": "string"

}

Service_PayInvoice

Request Body schema: application/json

required

invoice

string

Responses

https://docs.arklabs.xyz/v1/invoice/pay

Request samples

• Payload

Content type

application/json

{

• "invoice": "string"

}

Response samples

• 200
• default

Content type

application/json

{

• "preimage": "string"

}

Service_IsInvoiceSettled

query Parameters

invoice

string

Responses

https://docs.arklabs.xyz/v1/invoice/status

Response samples

• 200
• default

Content type

application/json

{

• "settled": true

}

Redeems an ark note by joining a round

Request Body schema: application/json

required

note

string

Responses

https://docs.arklabs.xyz/v1/note/redeem

Request samples

• Payload

Content type

application/json

{

• "note": "string"

}

Response samples

• 200
• default

Content type

application/json

{

• "txid": "string"

}

GetOnboardAddress returns onchain address and invoice for requested amount

Request Body schema: application/json

required

amount

string <uint64>

Responses

https://docs.arklabs.xyz/v1/onboard

Request samples

• Payload

Content type

application/json

{

• "amount": "string"

}

Response samples

• 200
• default

Content type

application/json

{

• "address": "string"

}

Returns round info for optional round_id (no round_id returns current round info)

path Parameters

roundId required

string

Responses

https://docs.arklabs.xyz/v1/round/{roundId}

Response samples

• 200
• default

Content type

application/json

{

• "round": {

  • "id": "string",
  • "start": "string",
  • "end": "string",
  • "roundTx": "string",
  • "congestionTree": {

    • "levels": [

      • {

        • "nodes": [

          • {

            • "txid": "string",
            • "tx": "string",
            • "parentTxid": "string"

            }

          ]

        }

      ]

    },
  • "forfeitTxs": [

    • "string"

    ],
  • "connectors": [

    • "string"

    ]

  }

}

Send asks to send amount to ark address by joining a round

Request Body schema: application/json

required

address	string
amount	string <uint64>

Responses

https://docs.arklabs.xyz/v1/send/offchain

Request samples

• Payload

Content type

application/json

{

• "address": "string",
• "amount": "string"

}

Response samples

• 200
• default

Content type

application/json

{

• "txid": "string"

}

SendOnChain asks to send requested amount to requested onchain address

Request Body schema: application/json

required

address	string
amount	string <uint64>

Responses

https://docs.arklabs.xyz/v1/send/onchain

Request samples

• Payload

Content type

application/json

{

• "address": "string",
• "amount": "string"

}

Response samples

• 200
• default

Content type

application/json

{

• "txid": "string"

}

Settle vtxos and boarding utxos

Responses

https://docs.arklabs.xyz/v1/settle

Response samples

• 200
• default

Content type

application/json

{

• "txid": "string"

}

Service_SignTransaction

Request Body schema: application/json

required

tx

string

Responses

https://docs.arklabs.xyz/v1/transaction/sign

Request samples

• Payload

Content type

application/json

{

• "tx": "string"

}

Response samples

• 200
• default

Content type

application/json

{

• "signedTx": "string"

}

GetTransactionHistory returns virtual transactions history

Responses

https://docs.arklabs.xyz/v1/transactions

Response samples

• 200
• default

Content type

application/json

{

• "transactions": [

  • {

    • "date": "string",
    • "amount": "string",
    • "roundTxid": "string",
    • "redeemTxid": "string",
    • "boardingTxid": "string",
    • "type": "TX_TYPE_UNSPECIFIED",
    • "settled": true

    }

  ]

}

ListVHTLC = list all vhtlc OR filter by preimage_hash

query Parameters

preimageHashFilter

string

Responses

https://docs.arklabs.xyz/v1/vhtlc

Response samples

• 200
• default

Content type

application/json

{

• "vhtlcs": [

  • {

    • "outpoint": {

      • "txid": "string",
      • "vout": 0

      },
    • "receiver": {

      • "pubkey": "string",
      • "amount": "string"

      },
    • "roundTxid": "string",
    • "spentBy": "string",
    • "expireAt": "string"

    }

  ]

}

CreateVHTLCAddress computes a VHTLC address

Request Body schema: application/json

required

preimageHash	string
senderPubkey	string
receiverPubkey	string
refundLocktime	integer <int64> (Optional absolute locktime for refund condition (in blocks))
	object (RelativeLocktime represents a relative timelock)
	object (RelativeLocktime represents a relative timelock)
	object (RelativeLocktime represents a relative timelock)

Responses

https://docs.arklabs.xyz/v1/vhtlc

Request samples

• Payload

Content type

application/json

{

• "preimageHash": "string",
• "senderPubkey": "string",
• "receiverPubkey": "string",
• "refundLocktime": 0,
• "unilateralClaimDelay": {

  • "type": "LOCKTIME_TYPE_UNSPECIFIED",
  • "value": 0

  },
• "unilateralRefundDelay": {

  • "type": "LOCKTIME_TYPE_UNSPECIFIED",
  • "value": 0

  },
• "unilateralRefundWithoutReceiverDelay": {

  • "type": "LOCKTIME_TYPE_UNSPECIFIED",
  • "value": 0

  }

}

Response samples

• 200
• default

Content type

application/json

{

• "address": "string",
• "claimPubkey": "string",
• "refundPubkey": "string",
• "serverPubkey": "string",
• "swapTree": {

  • "claimLeaf": {

    • "version": 0,
    • "output": "string"

    },
  • "refundLeaf": {

    • "version": 0,
    • "output": "string"

    },
  • "refundWithoutBoltzLeaf": {

    • "version": 0,
    • "output": "string"

    },
  • "unilateralClaimLeaf": {

    • "version": 0,
    • "output": "string"

    },
  • "unilateralRefundLeaf": {

    • "version": 0,
    • "output": "string"

    },
  • "unilateralRefundWithoutBoltzLeaf": {

    • "version": 0,
    • "output": "string"

    }

  },
• "refundLocktime": "string",
• "unilateralClaimDelay": "string",
• "unilateralRefundDelay": "string",
• "unilateralRefundWithoutReceiverDelay": "string"

}

ClaimVHTLC = self send vHTLC -> VTXO

Request Body schema: application/json

required

preimage

string

Responses

https://docs.arklabs.xyz/v1/vhtlc/claim

Request samples

• Payload

Content type

application/json

{

• "preimage": "string"

}

Response samples

• 200
• default

Content type

application/json

{

• "redeemTxid": "string"

}

Service_RefundVHTLCWithoutReceiver

Request Body schema: application/json

required

preimageHash

string

Responses

https://docs.arklabs.xyz/v1/vhtlc/refundWithoutReceiver

Request samples

• Payload

Content type

application/json

{

• "preimageHash": "string"

}

Response samples

• 200
• default

Content type

application/json

{

• "redeemTxid": "string"

}

WalletService

ChangePassword changes the password used to encrypt/decrypt the HD seeds. It requires the wallet to be locked.

Request Body schema: application/json

required

currentPassword	string The current password used to encrypt the walley.
newPassword	string The new password replacing the current one.

Responses

https://docs.arklabs.xyz/v1/password/change

Request samples

• Payload

Content type

application/json

{

• "currentPassword": "string",
• "newPassword": "string"

}

Response samples

• 200
• default

Content type

application/json

{ }

Auth verifies whether the given password is valid without unlocking the wallet

Request Body schema: application/json

required

password

string

Responses

https://docs.arklabs.xyz/v1/wallet/auth

Request samples

• Payload

Content type

application/json

{

• "password": "string"

}

Response samples

• 200
• default

Content type

application/json

{

• "verified": true

}

CreateWallet creates an HD Wallet based on signing seeds, encrypts them with the password and persists the encrypted seeds.

Request Body schema: application/json

required

privateKey	string The private key from where signing key pairs are derived. In 64 chars hexadecimal format.
password	string The password to decrypt HD wallet. After creation, the wallet is locked and the same password is required to unlock it.
serverUrl	string The url of the Server to connect to.

Responses

https://docs.arklabs.xyz/v1/wallet/create

Request samples

• Payload

Content type

application/json

{

• "privateKey": "string",
• "password": "string",
• "serverUrl": "string"

}

Response samples

• 200
• default

Content type

application/json

{ }

GenSeed returns signing seed that should be used to create a new HD Wallet.

Responses

https://docs.arklabs.xyz/v1/wallet/genseed

Response samples

• 200
• default

Content type

application/json

{

• "hex": "string",
• "nsec": "string"

}

Lock locks the HD wallet.

Request Body schema: application/json

required

password

string The password to lock the wallet.

Responses

https://docs.arklabs.xyz/v1/wallet/lock

Request samples

• Payload

Content type

application/json

{

• "password": "string"

}

Response samples

• 200
• default

Content type

application/json

{ }

RestoreWallet restores an HD Wallet based on signing seeds, encrypts them with the password and persists the encrypted seeds.

Request Body schema: application/json

required

mnemonic	string The mnemonic from where deriving signing key pairs.
password	string The password to decrypt HD wallet. After restoration, the wallet is locked and the same password is required to unlock it.
serverUrl	string The url of the Server to connect to.

Responses

https://docs.arklabs.xyz/v1/wallet/restore

Request samples

• Payload

Content type

application/json

{

• "mnemonic": "string",
• "password": "string",
• "serverUrl": "string"

}

Response samples

• 200
• default

Content type

application/json

{

• "result": { },
• "error": {

  • "code": 0,
  • "message": "string",
  • "details": [

    • {

      • "@type": "string",
      • "property1": null,
      • "property2": null

      }

    ]

  }

}

Status returns info about the status of the wallet.

Responses

https://docs.arklabs.xyz/v1/wallet/status

Response samples

• 200
• default

Content type

application/json

{

• "initialized": true,
• "synced": true,
• "unlocked": true

}

Unlock tries to unlock the HD Wallet using the given password.

Request Body schema: application/json

required

password

string The password to unlock the wallet.

Responses

https://docs.arklabs.xyz/v1/wallet/unlock

Request samples

• Payload

Content type

application/json

{

• "password": "string"

}

Response samples

• 200
• default

Content type

application/json

{ }