Skip to main content
GET
Get Ark server info

Authorizations

Authorization
string
header
required

Base64url-encoded auth token

Response

Returns the Ark info

fees
object
required

The fee schedule outlining any fees that must be paid to interact with the Ark server.

htlc_expiry_delta
integer<int32>
required

The number of blocks to keep between Lightning and Ark HTLCs expiries

Required range: x >= 0
htlc_send_expiry_delta
integer<int32>
required

The number of blocks after which an HTLC-send VTXO expires once granted.

Required range: x >= 0
ln_receive_anti_dos_required
boolean
required

Indicates whether the Ark server requires clients to either provide a VTXO ownership proof, or a lightning receive token when preparing a lightning claim.

mailbox_pubkey
string
required

The pubkey used for blinding unified mailbox IDs

max_offboard_inputs
integer
required

The maximum number of inputs for an offboard

Required range: x >= 0
max_user_invoice_cltv_delta
integer<int32>
required

Maximum CLTV delta server will allow clients to request an invoice generation with.

Required range: x >= 0
max_vtxo_amount
integer<int64>
required

Maximum amount of a VTXO

Required range: x >= 0
max_vtxo_exit_depth
integer<int32>
required

Maximum exit depth (genesis chain length) allowed for a VTXO. Once a VTXO's exit depth reaches this value the server will refuse to cosign further OOR transactions spending it. Clients should refresh their VTXOs into a round before this limit is reached.

Required range: x >= 0
min_board_amount_sat
integer<int64>
required

Minimum amount for a board the server will cosign

Required range: x >= 0
nb_round_nonces
integer
required

Number of nonces per round

Required range: x >= 0
network
string
required

The bitcoin network the server operates on

offboard_feerate_sat_per_kvb
integer<int64>
required

offboard feerate in sat per kvb

Required range: x >= 0
required_board_confirmations
integer
required

The number of confirmations required to register a board vtxo

Required range: x >= 0
round_interval
string
required

The interval between each round

server_pubkey
string
required

The Ark server pubkey

vtxo_exit_delta
integer<int32>
required

Delta between exit confirmation and coins becoming spendable

Required range: x >= 0
vtxo_expiry_delta
integer<int32>
required

Expiration delta of the VTXO

Required range: x >= 0