Skip to main content

API Reference

API docs by Redocly

ark/v1/admin.proto (version not set)

Download OpenAPI specification:Download

AdminService

AdminService_GetMarketHourConfig

Responses

Response samples

Content type
application/json
{
  • "config": {
    }
}

AdminService_UpdateMarketHourConfig

Request Body schema: application/json
required
object (v1MarketHourConfig)
startTime
string <date-time>
endTime
string <date-time>
period
string
roundInterval
string

Responses

Request samples

Content type
application/json
{
  • "config": {
    }
}

Response samples

Content type
application/json
{ }

AdminService_CreateNote

Request Body schema: application/json
required
amount
integer <int64>
quantity
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "amount": 0,
  • "quantity": 0
}

Response samples

Content type
application/json
{
  • "notes": [
    ]
}

AdminService_GetTxRequestQueue

query Parameters
requestIds
Array of strings

Responses

Response samples

Content type
application/json
{
  • "requests": [
    ]
}

AdminService_DeleteTxRequests

Request Body schema: application/json
required
requestIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "requestIds": [
    ]
}

Response samples

Content type
application/json
{ }

AdminService_GetRoundDetails

path Parameters
roundId
required
string

Responses

Response samples

Content type
application/json
{
  • "roundId": "string",
  • "txid": "string",
  • "forfeitedAmount": "string",
  • "totalVtxosAmount": "string",
  • "totalExitAmount": "string",
  • "feesAmount": "string",
  • "inputsVtxos": [
    ],
  • "outputsVtxos": [
    ],
  • "exitAddresses": [
    ]
}

AdminService_GetRounds

Request Body schema: application/json
required
after
string <int64>
before
string <int64>

Responses

Request samples

Content type
application/json
{
  • "after": "string",
  • "before": "string"
}

Response samples

Content type
application/json
{
  • "rounds": [
    ]
}

AdminService_GetScheduledSweep

Responses

Response samples

Content type
application/json
{
  • "sweeps": [
    ]
}

AdminService_Withdraw

Request Body schema: application/json
required
address
string
amount
string <uint64>

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "amount": "string"
}

Response samples

Content type
application/json
{
  • "txid": "string"
}

ExplorerService

ExplorerService_GetRoundById

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "round": {
    }
}

ExplorerService_GetRound

path Parameters
txid
required
string

Responses

Response samples

Content type
application/json
{
  • "round": {
    }
}

ExplorerService_ListVtxos

path Parameters
address
required
string

Responses

Response samples

Content type
application/json
{
  • "spendableVtxos": [
    ],
  • "spentVtxos": [
    ]
}

ExplorerService_SubscribeForAddress

path Parameters
address
required
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "error": {
    }
}

IndexerService

IndexerService_GetVtxoTree

path Parameters
batchOutpoint.txid
required
string
batchOutpoint.vout
required
integer <int64>
query Parameters
page.size
integer <int32>
page.index
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "vtxoTree": [
    ],
  • "page": {
    }
}

IndexerService_GetVtxoTreeLeaves

path Parameters
batchOutpoint.txid
required
string
batchOutpoint.vout
required
integer <int64>
query Parameters
page.size
integer <int32>
page.index
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "leaves": [
    ],
  • "page": {
    }
}

IndexerService_GetCommitmentTx

path Parameters
txid
required
string

Responses

Response samples

Content type
application/json
{
  • "startedAt": "string",
  • "endedAt": "string",
  • "batches": {
    },
  • "totalInputAmount": "string",
  • "totalInputVtxos": 0,
  • "totalOutputAmount": "string",
  • "totalOutputVtxos": 0
}

IndexerService_GetConnectors

path Parameters
txid
required
string
query Parameters
page.size
integer <int32>
page.index
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "connectors": [
    ],
  • "page": {
    }
}

IndexerService_GetForfeitTxs

path Parameters
txid
required
string
query Parameters
page.size
integer <int32>
page.index
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "txids": [
    ],
  • "page": {
    }
}

IndexerService_GetCommitmentTxLeaves

path Parameters
txid
required
string
query Parameters
page.size
integer <int32>
page.index
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "leaves": [
    ],
  • "page": {
    }
}

IndexerService_GetSweptCommitmentTx

path Parameters
txid
required
string

Responses

Response samples

Content type
application/json
{
  • "sweptBy": [
    ]
}

IndexerService_GetVtxos

path Parameters
addresses
required
Array of strings non-empty
query Parameters
spendableOnly
boolean
spentOnly
boolean
page.size
integer <int32>
page.index
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "vtxos": [
    ],
  • "page": {
    }
}

IndexerService_GetVtxosByOutpoint

path Parameters
outpoints
required
Array of strings non-empty
query Parameters
page.size
integer <int32>
page.index
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "vtxos": [
    ],
  • "page": {
    }
}

IndexerService_GetTransactionHistory

path Parameters
address
required
string
query Parameters
startTime
string <int64>
endTime
string <int64>
page.size
integer <int32>
page.index
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "history": [
    ],
  • "page": {
    }
}

IndexerService_SubscribeForScripts

Request Body schema: application/json
required
scripts
Array of strings
subscriptionId
string (if set, update an existing subscription)

Responses

Request samples

Content type
application/json
{
  • "scripts": [
    ],
  • "subscriptionId": "string"
}

Response samples

Content type
application/json
{
  • "subscriptionId": "string"
}

IndexerService_GetSubscription

path Parameters
subscriptionId
required
string

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "error": {
    }
}

IndexerService_UnsubscribeForScripts

Request Body schema: application/json
required
subscriptionId
string
scripts
Array of strings (if empty, unsubscribe all scripts)

Responses

Request samples

Content type
application/json
{
  • "subscriptionId": "string",
  • "scripts": [
    ]
}

Response samples

Content type
application/json
{ }

IndexerService_GetVirtualTxs

path Parameters
txids
required
Array of strings non-empty
query Parameters
page.size
integer <int32>
page.index
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "txs": [
    ],
  • "page": {
    }
}

IndexerService_GetVtxoChain

path Parameters
outpoint.txid
required
string
outpoint.vout
required
integer <int64>
query Parameters
page.size
integer <int32>
page.index
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "chain": [
    ],
  • "depth": 0,
  • "rootCommitmentTxid": "string",
  • "page": {
    }
}

ArkService

ArkService_GetBoardingAddress

Request Body schema: application/json
required
pubkey
string

Responses

Request samples

Content type
application/json
{
  • "pubkey": "string"
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "descriptor": "string",
  • "tapscripts": {
    }
}

ArkService_GetEventStream

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "error": {
    }
}

ArkService_GetInfo

Responses

Response samples

Content type
application/json
{
  • "pubkey": "string",
  • "vtxoTreeExpiry": "string",
  • "unilateralExitDelay": "string",
  • "roundInterval": "string",
  • "network": "string",
  • "dust": "string",
  • "boardingDescriptorTemplate": "string",
  • "vtxoDescriptorTemplates": [
    ],
  • "forfeitAddress": "string",
  • "marketHour": {
    },
  • "version": "string",
  • "utxoMinAmount": "string",
  • "utxoMaxAmount": "string",
  • "vtxoMinAmount": "string",
  • "vtxoMaxAmount": "string",
  • "boardingExitDelay": "string"
}

ArkService_SubmitRedeemTx

Request Body schema: application/json
required
redeemTx
string

Responses

Request samples

Content type
application/json
{
  • "redeemTx": "string"
}

Response samples

Content type
application/json
{
  • "signedRedeemTx": "string",
  • "txid": "string"
}

ArkService_Ping

path Parameters
requestId
required
string

The id used to register inputs and ouptuts.

Responses

Response samples

Content type
application/json
{ }

ArkService_RegisterInputsForNextRound

Request Body schema: application/json
required
Array of objects (v1Input)
notes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "inputs": [
    ],
  • "notes": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

ArkService_RegisterIntent

Request Body schema: application/json
required
object (v1Bip322Signature)
notes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "bip322Signature": {
    },
  • "notes": [
    ]
}

Response samples

Content type
application/json
{
  • "requestId": "string"
}

ArkService_RegisterOutputsForNextRound

Request Body schema: application/json
required
requestId
string
Array of objects (v1Output)

List of receivers for to convert to leaves in the next VTXO tree.

object (v1Musig2)

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "outputs": [
    ],
  • "musig2": {
    }
}

Response samples

Content type
application/json
{ }

ArkService_SubmitSignedForfeitTxs

Request Body schema: application/json
required
signedForfeitTxs
Array of strings

Forfeit txs signed by the user.

signedRoundTx
string

The user has to sign also the round tx if he registerd a boarding UTXO.

Responses

Request samples

Content type
application/json
{
  • "signedForfeitTxs": [
    ],
  • "signedRoundTx": "string"
}

Response samples

Content type
application/json
{ }

ArkService_SubmitTreeNonces

Request Body schema: application/json
required
roundId
string
pubkey
string
treeNonces
string

Responses

Request samples

Content type
application/json
{
  • "roundId": "string",
  • "pubkey": "string",
  • "treeNonces": "string"
}

Response samples

Content type
application/json
{ }

ArkService_SubmitTreeSignatures

Request Body schema: application/json
required
roundId
string
pubkey
string
treeSignatures
string

Responses

Request samples

Content type
application/json
{
  • "roundId": "string",
  • "pubkey": "string",
  • "treeSignatures": "string"
}

Response samples

Content type
application/json
{ }

ArkService_GetTransactionsStream

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "error": {
    }
}

WalletService

WalletService_DeriveAddress

Responses

Response samples

Content type
application/json
{
  • "address": "string"
}

WalletService_GetBalance

Responses

Response samples

Content type
application/json
{
  • "mainAccount": {
    },
  • "connectorsAccount": {
    }
}

WalletService_Lock

Request Body schema: application/json
required
password
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{ }

WalletInitializerService

WalletInitializerService_Create

Request Body schema: application/json
required
seed
string
password
string

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{ }

WalletInitializerService_Restore

Request Body schema: application/json
required
seed
string
password
string
gapLimit
string <uint64>

Responses

Request samples

Content type
application/json
{
  • "seed": "string",
  • "password": "string",
  • "gapLimit": "string"
}

Response samples

Content type
application/json
{ }

WalletInitializerService_GenSeed

Responses

Response samples

Content type
application/json
{
  • "seed": "string"
}

WalletInitializerService_GetStatus

Responses

Response samples

Content type
application/json
{
  • "initialized": true,
  • "unlocked": true,
  • "synced": true
}

WalletInitializerService_Unlock

Request Body schema: application/json
required
password
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{ }