SiaQL Documentation

GraphQL API for Sia Network components: Renterd, Hostd, and Walletd.

Contact

Mert Köklü

kklumert@gmail.com

https://t.me/mertkklu

License

Apache 2.0

https://github.com/justmert/SiaQL/blob/master/LICENSE

API Endpoints

<<url is missing>>

Queries

`hostdAccountFunding`

Response

Returns [FundingSource!]!

Arguments

Name	Description
`account` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdAccountFunding(
  $account: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdAccountFunding(
    account: $account,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    contractID
    accountID
    amount
  }
}

Variables

{
  "account": "xyz789",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "hostdAccountFunding": [
      {
        "contractID": FileContractID,
        "accountID": PublicKey,
        "amount": "USD"
      }
    ]
  }
}

Queries

`hostdAccounts`

Response

Returns [HostdAccount!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdAccounts(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdAccounts(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    balance
    expiration
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdAccounts": [
      {
        "id": PublicKey,
        "balance": "USD",
        "expiration": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

Queries

`hostdAlerts`

Response

Returns [Alert!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdAlerts(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdAlerts(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    severity
    message
    data
    timestamp
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdAlerts": [
      {
        "id": Hash256,
        "severity": "INFO",
        "message": "xyz789",
        "data": {},
        "timestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

Queries

`hostdConsensusNetwork`

Response

Returns a Network!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdConsensusNetwork(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdConsensusNetwork(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    name
    initialCoinbase
    minimumCoinbase
    initialTarget
    blockInterval
    maturityDelay
    hardforkDevAddr {
      ...HardforkDevAddrFragment
    }
    hardforkTax {
      ...HardforkTaxFragment
    }
    hardforkStorageProof {
      ...HardforkStorageProofFragment
    }
    hardforkOak {
      ...HardforkOakFragment
    }
    hardforkASIC {
      ...HardforkASICFragment
    }
    hardforkFoundation {
      ...HardforkFoundationFragment
    }
    hardforkV2 {
      ...HardforkV2Fragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdConsensusNetwork": {
      "name": "xyz789",
      "initialCoinbase": "USD",
      "minimumCoinbase": "USD",
      "initialTarget": BlockID,
      "blockInterval": "P3Y6M4DT12H30M5S",
      "maturityDelay": 123,
      "hardforkDevAddr": HardforkDevAddr,
      "hardforkTax": HardforkTax,
      "hardforkStorageProof": HardforkStorageProof,
      "hardforkOak": HardforkOak,
      "hardforkASIC": HardforkASIC,
      "hardforkFoundation": HardforkFoundation,
      "hardforkV2": HardforkV2
    }
  }
}

Queries

`hostdConsensusTip`

Response

Returns a ChainIndex!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdConsensusTip(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdConsensusTip(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    height
    id
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdConsensusTip": {"height": 123, "id": BlockID}
  }
}

Queries

`hostdConsensusTipState`

Response

Returns a ConsensusState!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdConsensusTipState(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdConsensusTipState(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    blockHeight
    lastBlockTime
    synced
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdConsensusTipState": {
      "blockHeight": 987,
      "lastBlockTime": "2007-12-03T10:15:30Z",
      "synced": true
    }
  }
}

Queries

`hostdContract`

Response

Returns a Contract!

Arguments

Name	Description
`id` - `FileContractID!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdContract(
  $id: FileContractID!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdContract(
    id: $id,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    hostIP
    hostKey
    siamuxAddr
    proofHeight
    revisionHeight
    revisionNumber
    size
    startHeight
    state
    windowStart
    windowEnd
    contractPrice
    renewedFrom
    spending {
      ...ContractSpendingFragment
    }
    totalCost
    contractSets
    revision {
      ...FileContractRevisionFragment
    }
  }
}

Variables

{
  "id": FileContractID,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "hostdContract": {
      "id": FileContractID,
      "hostIP": "abc123",
      "hostKey": PublicKey,
      "siamuxAddr": "xyz789",
      "proofHeight": 987,
      "revisionHeight": 123,
      "revisionNumber": RevisionNumber,
      "size": 123,
      "startHeight": 123,
      "state": "abc123",
      "windowStart": 123,
      "windowEnd": 123,
      "contractPrice": "USD",
      "renewedFrom": FileContractID,
      "spending": ContractSpending,
      "totalCost": "USD",
      "contractSets": ["abc123"],
      "revision": FileContractRevision
    }
  }
}

Queries

`hostdContractIntegrity`

Response

Returns an IntegrityCheckResult

Arguments

Name	Description
`id` - `FileContractID!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdContractIntegrity(
  $id: FileContractID!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdContractIntegrity(
    id: $id,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    start
    end
    checkedSectors
    totalSectors
    badSectors {
      ...IntegrityResultFragment
    }
  }
}

Variables

{
  "id": FileContractID,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "hostdContractIntegrity": {
      "start": "2007-12-03T10:15:30Z",
      "end": "2007-12-03T10:15:30Z",
      "checkedSectors": 987,
      "totalSectors": 123,
      "badSectors": [IntegrityResult]
    }
  }
}

Queries

`hostdContracts`

Response

Returns a HostdContractsResponse!

Arguments

Name	Description
`filter` - `ContractFilterInput!`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdContracts(
  $filter: ContractFilterInput!,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdContracts(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    count
    contracts {
      ...HostdContractFragment
    }
  }
}

Variables

{
  "filter": ContractFilterInput,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "hostdContracts": {
      "count": 123,
      "contracts": [HostdContract]
    }
  }
}

Queries

`hostdIndexTip`

Response

Returns a ChainIndex!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdIndexTip(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdIndexTip(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    height
    id
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdIndexTip": {"height": 123, "id": BlockID}
  }
}

Queries

`hostdMetrics`

Response

Returns a Metrics!

Arguments

Name	Description
`timestamp` - `DateTime`	Default = `null`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdMetrics(
  $timestamp: DateTime,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdMetrics(
    timestamp: $timestamp,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    accounts {
      ...AccountsFragment
    }
    revenue {
      ...RevenueMetricsFragment
    }
    pricing {
      ...PricingFragment
    }
    contracts {
      ...ContractsFragment
    }
    storage {
      ...StorageFragment
    }
    registry {
      ...RegistryFragment
    }
    data {
      ...DataMetricsFragment
    }
    wallet {
      ...WalletMetricsFragment
    }
    timestamp
  }
}

Variables

{"timestamp": null, "filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdMetrics": {
      "accounts": Accounts,
      "revenue": RevenueMetrics,
      "pricing": Pricing,
      "contracts": Contracts,
      "storage": Storage,
      "registry": Registry,
      "data": DataMetrics,
      "wallet": WalletMetrics,
      "timestamp": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

`hostdPeriodMetrics`

Response

Returns [Metrics!]!

Arguments

Name	Description
`start` - `DateTime!`
`periods` - `Int!`
`interval` - `MetricsInterval!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdPeriodMetrics(
  $start: DateTime!,
  $periods: Int!,
  $interval: MetricsInterval!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdPeriodMetrics(
    start: $start,
    periods: $periods,
    interval: $interval,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    accounts {
      ...AccountsFragment
    }
    revenue {
      ...RevenueMetricsFragment
    }
    pricing {
      ...PricingFragment
    }
    contracts {
      ...ContractsFragment
    }
    storage {
      ...StorageFragment
    }
    registry {
      ...RegistryFragment
    }
    data {
      ...DataMetricsFragment
    }
    wallet {
      ...WalletMetricsFragment
    }
    timestamp
  }
}

Variables

{
  "start": "2007-12-03T10:15:30Z",
  "periods": 987,
  "interval": "FIVE_MINUTES",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "hostdPeriodMetrics": [
      {
        "accounts": Accounts,
        "revenue": RevenueMetrics,
        "pricing": Pricing,
        "contracts": Contracts,
        "storage": Storage,
        "registry": Registry,
        "data": DataMetrics,
        "wallet": WalletMetrics,
        "timestamp": "2007-12-03T10:15:30Z"
      }
    ]
  }
}

Queries

`hostdPinnedSettings`

Response

Returns a PinnedSettings!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdPinnedSettings(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdPinnedSettings(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    currency
    threshold
    storage {
      ...PinFragment
    }
    ingress {
      ...PinFragment
    }
    egress {
      ...PinFragment
    }
    maxCollateral {
      ...PinFragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdPinnedSettings": {
      "currency": "abc123",
      "threshold": 987.65,
      "storage": Pin,
      "ingress": Pin,
      "egress": Pin,
      "maxCollateral": Pin
    }
  }
}

Queries

`hostdSettings`

Response

Returns a HostSettings!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdSettings(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdSettings(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    acceptingContracts
    netAddress
    maxContractDuration
    windowSize
    contractPrice
    baseRPCPrice
    sectorAccessPrice
    collateralMultiplier
    maxCollateral
    storagePrice
    egressPrice
    ingressPrice
    priceTableValidity
    maxRegistryEntries
    accountExpiry
    maxAccountBalance
    ingressLimit
    egressLimit
    ddns {
      ...DNSSettingsFragment
    }
    sectorCacheSize
    revision
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdSettings": {
      "acceptingContracts": false,
      "netAddress": "xyz789",
      "maxContractDuration": 123,
      "windowSize": 123,
      "contractPrice": "USD",
      "baseRPCPrice": "USD",
      "sectorAccessPrice": "USD",
      "collateralMultiplier": 987.65,
      "maxCollateral": "USD",
      "storagePrice": "USD",
      "egressPrice": "USD",
      "ingressPrice": "USD",
      "priceTableValidity": "P3Y6M4DT12H30M5S",
      "maxRegistryEntries": 987,
      "accountExpiry": "P3Y6M4DT12H30M5S",
      "maxAccountBalance": "USD",
      "ingressLimit": 987,
      "egressLimit": 123,
      "ddns": DNSSettings,
      "sectorCacheSize": 123,
      "revision": 987
    }
  }
}

Queries

`hostdState`

Response

Returns a HostdState!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdState(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdState(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    version
    commit
    os
    buildTime
    name
    publicKey
    lastAnnouncement {
      ...AnnouncementFragment
    }
    startTime
    explorer {
      ...ExplorerStateFragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdState": {
      "version": "abc123",
      "commit": "abc123",
      "os": "xyz789",
      "buildTime": "2007-12-03T10:15:30Z",
      "name": "xyz789",
      "publicKey": PublicKey,
      "lastAnnouncement": Announcement,
      "startTime": "2007-12-03T10:15:30Z",
      "explorer": ExplorerState
    }
  }
}

Queries

`hostdSyncerAddress`

Response

Returns a String!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdSyncerAddress(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdSyncerAddress(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{"data": {"hostdSyncerAddress": "abc123"}}

Queries

`hostdSyncerPeers`

Response

Returns [Peer!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdSyncerPeers(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdSyncerPeers(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    address
    inbound
    version
    firstSeen
    connectedSince
    syncedBlocks
    syncDuration
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdSyncerPeers": [
      {
        "address": "xyz789",
        "inbound": false,
        "version": "xyz789",
        "firstSeen": "2007-12-03T10:15:30Z",
        "connectedSince": "2007-12-03T10:15:30Z",
        "syncedBlocks": 123,
        "syncDuration": "P3Y6M4DT12H30M5S"
      }
    ]
  }
}

Queries

`hostdSystemDir`

Response

Returns a SystemDirResponse!

Arguments

Name	Description
`path` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdSystemDir(
  $path: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdSystemDir(
    path: $path,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    path
    totalBytes
    freeBytes
    directories
  }
}

Variables

{
  "path": "xyz789",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "hostdSystemDir": {
      "path": "abc123",
      "totalBytes": 123,
      "freeBytes": 123,
      "directories": ["xyz789"]
    }
  }
}

Queries

`hostdTpoolFee`

Response

Returns a Currency!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdTpoolFee(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdTpoolFee(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{"data": {"hostdTpoolFee": "USD"}}

Queries

`hostdVerifySector`

Response

Returns a VerifySectorResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdVerifySector(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdVerifySector(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    sectorReference
    error
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdVerifySector": {
      "sectorReference": {},
      "error": "xyz789"
    }
  }
}

Queries

`hostdVolume`

Response

Returns a VolumeMeta!

Arguments

Name	Description
`id` - `Int!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdVolume(
  $id: Int!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdVolume(
    id: $id,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    localPath
    usedSectors
    totalSectors
    readOnly
    available
    failedReads
    failedWrites
    successfulReads
    successfulWrites
    status
    errors
  }
}

Variables

{"id": 987, "filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdVolume": {
      "id": 123,
      "localPath": "xyz789",
      "usedSectors": 123,
      "totalSectors": 987,
      "readOnly": true,
      "available": true,
      "failedReads": 987,
      "failedWrites": 123,
      "successfulReads": 987,
      "successfulWrites": 987,
      "status": "xyz789",
      "errors": ["xyz789"]
    }
  }
}

Queries

`hostdVolumes`

Response

Returns [VolumeMeta!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdVolumes(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdVolumes(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    localPath
    usedSectors
    totalSectors
    readOnly
    available
    failedReads
    failedWrites
    successfulReads
    successfulWrites
    status
    errors
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdVolumes": [
      {
        "id": 987,
        "localPath": "xyz789",
        "usedSectors": 123,
        "totalSectors": 123,
        "readOnly": true,
        "available": true,
        "failedReads": 987,
        "failedWrites": 987,
        "successfulReads": 123,
        "successfulWrites": 123,
        "status": "abc123",
        "errors": ["xyz789"]
      }
    ]
  }
}

Queries

`hostdWallet`

Response

Returns a WalletResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdWallet(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdWallet(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    scanHeight
    address
    spendable
    confirmed
    unconfirmed
    immature
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdWallet": {
      "scanHeight": 123,
      "address": Address,
      "spendable": "USD",
      "confirmed": "USD",
      "unconfirmed": "USD",
      "immature": "USD"
    }
  }
}

Queries

`hostdWalletEvents`

Response

Returns [WalletEvent!]!

Arguments

Name	Description
`limit` - `Int!`	Default = `100`
`offset` - `Int!`	Default = `0`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdWalletEvents(
  $limit: Int!,
  $offset: Int!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdWalletEvents(
    limit: $limit,
    offset: $offset,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    index {
      ...ChainIndexFragment
    }
    type
    data
    maturityHeight
    timestamp
    relevant
  }
}

Variables

{"limit": 100, "offset": 0, "filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdWalletEvents": [
      {
        "id": Hash256,
        "index": ChainIndex,
        "type": "xyz789",
        "data": {},
        "maturityHeight": 987,
        "timestamp": "2007-12-03T10:15:30Z",
        "relevant": [Address]
      }
    ]
  }
}

Queries

`hostdWalletPending`

Response

Returns [WalletEvent!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdWalletPending(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdWalletPending(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    index {
      ...ChainIndexFragment
    }
    type
    data
    maturityHeight
    timestamp
    relevant
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdWalletPending": [
      {
        "id": Hash256,
        "index": ChainIndex,
        "type": "abc123",
        "data": {},
        "maturityHeight": 987,
        "timestamp": "2007-12-03T10:15:30Z",
        "relevant": [Address]
      }
    ]
  }
}

Queries

`hostdWebhooks`

Response

Returns [Webhook!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query hostdWebhooks(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  hostdWebhooks(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    module
    event
    url
    headers
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "hostdWebhooks": [
      {
        "module": "abc123",
        "event": "abc123",
        "url": "xyz789",
        "headers": {}
      }
    ]
  }
}

Queries

`renterdAccounts`

Response

Returns [Account!]!

Arguments

Name	Description
`owner` - `String`	Default = `null`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdAccounts(
  $owner: String,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdAccounts(
    owner: $owner,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    cleanShutdown
    hostKey
    balance
    drift
    owner
    requiresSync
  }
}

Variables

{"owner": null, "filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdAccounts": [
      {
        "id": PublicKey,
        "cleanShutdown": false,
        "hostKey": PublicKey,
        "balance": 123,
        "drift": 987,
        "owner": "abc123",
        "requiresSync": false
      }
    ]
  }
}

Queries

`renterdAlerts`

Response

Returns an AlertsResponse!

Arguments

Name	Description
`opts` - `AlertsOptsInput!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdAlerts(
  $opts: AlertsOptsInput!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdAlerts(
    opts: $opts,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    alerts {
      ...AlertFragment
    }
    hasMore
    totals {
      ...AlertTotalsFragment
    }
  }
}

Variables

{
  "opts": AlertsOptsInput,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdAlerts": {
      "alerts": [Alert],
      "hasMore": true,
      "totals": AlertTotals
    }
  }
}

Queries

`renterdAutopilot`

Response

Returns an Autopilot!

Arguments

Name	Description
`id` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdAutopilot(
  $id: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdAutopilot(
    id: $id,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    config {
      ...AutopilotConfigFragment
    }
    currentPeriod
  }
}

Variables

{
  "id": "abc123",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdAutopilot": {
      "id": "abc123",
      "config": AutopilotConfig,
      "currentPeriod": 987
    }
  }
}

Queries

`renterdAutopilotConfig`

Response

Returns an AutopilotConfig!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdAutopilotConfig(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdAutopilotConfig(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    contracts {
      ...ContractsConfigFragment
    }
    hosts {
      ...HostsConfigFragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdAutopilotConfig": {
      "contracts": ContractsConfig,
      "hosts": HostsConfig
    }
  }
}

Queries

`renterdAutopilotHost`

Response

Returns a HostResponse!

Arguments

Name	Description
`hostKey` - `PublicKey!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdAutopilotHost(
  $hostKey: PublicKey!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdAutopilotHost(
    hostKey: $hostKey,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    host {
      ...HostFragment
    }
    checks {
      ...HostChecksFragment
    }
  }
}

Variables

{
  "hostKey": PublicKey,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdAutopilotHost": {
      "host": Host,
      "checks": HostChecks
    }
  }
}

Queries

`renterdAutopilotHosts`

Response

Returns [HostResponse!]!

Arguments

Name	Description
`opts` - `SearchHostsRequestInput!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdAutopilotHosts(
  $opts: SearchHostsRequestInput!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdAutopilotHosts(
    opts: $opts,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    host {
      ...HostFragment
    }
    checks {
      ...HostChecksFragment
    }
  }
}

Variables

{
  "opts": SearchHostsRequestInput,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdAutopilotHosts": [
      {
        "host": Host,
        "checks": HostChecks
      }
    ]
  }
}

Queries

`renterdAutopilotState`

Response

Returns an AutopilotStateResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdAutopilotState(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdAutopilotState(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    version
    commit
    os
    buildTime
    configured
    migrating
    migratingLastStart
    pruning
    pruningLastStart
    scanning
    scanningLastStart
    uptimeMs
    startTime
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdAutopilotState": {
      "version": "xyz789",
      "commit": "abc123",
      "os": "abc123",
      "buildTime": "2007-12-03T10:15:30Z",
      "configured": true,
      "migrating": true,
      "migratingLastStart": "2007-12-03T10:15:30Z",
      "pruning": false,
      "pruningLastStart": "2007-12-03T10:15:30Z",
      "scanning": true,
      "scanningLastStart": "2007-12-03T10:15:30Z",
      "uptimeMs": "P3Y6M4DT12H30M5S",
      "startTime": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

`renterdAutopilots`

Response

Returns [Autopilot!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdAutopilots(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdAutopilots(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    config {
      ...AutopilotConfigFragment
    }
    currentPeriod
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdAutopilots": [
      {
        "id": "abc123",
        "config": AutopilotConfig,
        "currentPeriod": 987
      }
    ]
  }
}

Queries

`renterdBucket`

Response

Returns a Bucket!

Arguments

Name	Description
`name` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdBucket(
  $name: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdBucket(
    name: $name,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    createdAt
    name
    policy {
      ...BucketPolicyFragment
    }
  }
}

Variables

{
  "name": "abc123",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdBucket": {
      "createdAt": "2007-12-03T10:15:30Z",
      "name": "xyz789",
      "policy": BucketPolicy
    }
  }
}

Queries

`renterdBuckets`

Response

Returns [Bucket!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdBuckets(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdBuckets(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    createdAt
    name
    policy {
      ...BucketPolicyFragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdBuckets": [
      {
        "createdAt": "2007-12-03T10:15:30Z",
        "name": "abc123",
        "policy": BucketPolicy
      }
    ]
  }
}

Queries

`renterdConsensusNetwork`

Response

Returns a Network!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdConsensusNetwork(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdConsensusNetwork(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    name
    initialCoinbase
    minimumCoinbase
    initialTarget
    blockInterval
    maturityDelay
    hardforkDevAddr {
      ...HardforkDevAddrFragment
    }
    hardforkTax {
      ...HardforkTaxFragment
    }
    hardforkStorageProof {
      ...HardforkStorageProofFragment
    }
    hardforkOak {
      ...HardforkOakFragment
    }
    hardforkASIC {
      ...HardforkASICFragment
    }
    hardforkFoundation {
      ...HardforkFoundationFragment
    }
    hardforkV2 {
      ...HardforkV2Fragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdConsensusNetwork": {
      "name": "abc123",
      "initialCoinbase": "USD",
      "minimumCoinbase": "USD",
      "initialTarget": BlockID,
      "blockInterval": "P3Y6M4DT12H30M5S",
      "maturityDelay": 123,
      "hardforkDevAddr": HardforkDevAddr,
      "hardforkTax": HardforkTax,
      "hardforkStorageProof": HardforkStorageProof,
      "hardforkOak": HardforkOak,
      "hardforkASIC": HardforkASIC,
      "hardforkFoundation": HardforkFoundation,
      "hardforkV2": HardforkV2
    }
  }
}

Queries

`renterdConsensusSiafundFee`

Response

Returns a Currency!

Arguments

Name	Description
`payout` - `Currency!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdConsensusSiafundFee(
  $payout: Currency!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdConsensusSiafundFee(
    payout: $payout,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{
  "payout": "USD",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdConsensusSiafundFee": "USD"
  }
}

Queries

`renterdConsensusState`

Response

Returns a ConsensusState!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdConsensusState(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdConsensusState(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    blockHeight
    lastBlockTime
    synced
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdConsensusState": {
      "blockHeight": 123,
      "lastBlockTime": "2007-12-03T10:15:30Z",
      "synced": true
    }
  }
}

Queries

`renterdContract`

Response

Returns a ContractMetadata!

Arguments

Name	Description
`id` - `FileContractID!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdContract(
  $id: FileContractID!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdContract(
    id: $id,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    hostIP
    hostKey
    siamuxAddr
    proofHeight
    revisionHeight
    revisionNumber
    size
    startHeight
    state
    windowStart
    windowEnd
    contractPrice
    renewedFrom
    spending {
      ...ContractSpendingFragment
    }
    totalCost
    contractSets
  }
}

Variables

{
  "id": FileContractID,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdContract": {
      "id": FileContractID,
      "hostIP": "abc123",
      "hostKey": PublicKey,
      "siamuxAddr": "xyz789",
      "proofHeight": 987,
      "revisionHeight": 123,
      "revisionNumber": RevisionNumber,
      "size": 123,
      "startHeight": 123,
      "state": "abc123",
      "windowStart": 123,
      "windowEnd": 123,
      "contractPrice": "USD",
      "renewedFrom": FileContractID,
      "spending": ContractSpending,
      "totalCost": "USD",
      "contractSets": ["abc123"]
    }
  }
}

Queries

`renterdContractAncestors`

Response

Returns [ArchivedContract!]!

Arguments

Name	Description
`id` - `FileContractID!`
`minStartHeight` - `Int!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdContractAncestors(
  $id: FileContractID!,
  $minStartHeight: Int!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdContractAncestors(
    id: $id,
    minStartHeight: $minStartHeight,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    hostIP
    hostKey
    renewedTo
    spending {
      ...ContractSpendingFragment
    }
    archivalReason
    contractPrice
    proofHeight
    renewedFrom
    revisionHeight
    revisionNumber
    size
    startHeight
    state
    totalCost
    windowStart
    windowEnd
  }
}

Variables

{
  "id": FileContractID,
  "minStartHeight": 987,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdContractAncestors": [
      {
        "id": FileContractID,
        "hostIP": "xyz789",
        "hostKey": PublicKey,
        "renewedTo": FileContractID,
        "spending": ContractSpending,
        "archivalReason": "abc123",
        "contractPrice": "USD",
        "proofHeight": 987,
        "renewedFrom": FileContractID,
        "revisionHeight": 987,
        "revisionNumber": 123,
        "size": 987,
        "startHeight": 987,
        "state": "abc123",
        "totalCost": "USD",
        "windowStart": 987,
        "windowEnd": 987
      }
    ]
  }
}

Queries

`renterdContractRenewed`

Response

Returns a ContractMetadata!

Arguments

Name	Description
`id` - `FileContractID!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdContractRenewed(
  $id: FileContractID!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdContractRenewed(
    id: $id,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    hostIP
    hostKey
    siamuxAddr
    proofHeight
    revisionHeight
    revisionNumber
    size
    startHeight
    state
    windowStart
    windowEnd
    contractPrice
    renewedFrom
    spending {
      ...ContractSpendingFragment
    }
    totalCost
    contractSets
  }
}

Variables

{
  "id": FileContractID,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdContractRenewed": {
      "id": FileContractID,
      "hostIP": "abc123",
      "hostKey": PublicKey,
      "siamuxAddr": "xyz789",
      "proofHeight": 123,
      "revisionHeight": 987,
      "revisionNumber": RevisionNumber,
      "size": 987,
      "startHeight": 123,
      "state": "xyz789",
      "windowStart": 987,
      "windowEnd": 123,
      "contractPrice": "USD",
      "renewedFrom": FileContractID,
      "spending": ContractSpending,
      "totalCost": "USD",
      "contractSets": ["xyz789"]
    }
  }
}

Queries

`renterdContractRoots`

Response

Returns a ContractRootsResponse!

Arguments

Name	Description
`id` - `FileContractID!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdContractRoots(
  $id: FileContractID!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdContractRoots(
    id: $id,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    roots
    uploading
  }
}

Variables

{
  "id": FileContractID,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdContractRoots": {
      "roots": [Hash256],
      "uploading": [Hash256]
    }
  }
}

Queries

`renterdContractSets`

Response

Returns [String!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdContractSets(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdContractSets(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdContractSets": ["xyz789"]
  }
}

Queries

`renterdContractSize`

Response

Returns a ContractSize!

Arguments

Name	Description
`id` - `FileContractID!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdContractSize(
  $id: FileContractID!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdContractSize(
    id: $id,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    prunable
    size
  }
}

Variables

{
  "id": FileContractID,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{"data": {"renterdContractSize": {"prunable": 987, "size": 123}}}

Queries

`renterdContracts`

Response

Returns [ContractMetadata!]!

Arguments

Name	Description
`contractSet` - `String`	Default = `null`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdContracts(
  $contractSet: String,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdContracts(
    contractSet: $contractSet,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    hostIP
    hostKey
    siamuxAddr
    proofHeight
    revisionHeight
    revisionNumber
    size
    startHeight
    state
    windowStart
    windowEnd
    contractPrice
    renewedFrom
    spending {
      ...ContractSpendingFragment
    }
    totalCost
    contractSets
  }
}

Variables

{"contractSet": null, "filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdContracts": [
      {
        "id": FileContractID,
        "hostIP": "xyz789",
        "hostKey": PublicKey,
        "siamuxAddr": "xyz789",
        "proofHeight": 987,
        "revisionHeight": 123,
        "revisionNumber": RevisionNumber,
        "size": 987,
        "startHeight": 987,
        "state": "abc123",
        "windowStart": 987,
        "windowEnd": 987,
        "contractPrice": "USD",
        "renewedFrom": FileContractID,
        "spending": ContractSpending,
        "totalCost": "USD",
        "contractSets": ["xyz789"]
      }
    ]
  }
}

Queries

`renterdContractsPrunable`

Response

Returns a ContractsPrunableDataResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdContractsPrunable(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdContractsPrunable(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    contracts {
      ...ContractPrunableDataFragment
    }
    totalPrunable
    totalSize
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdContractsPrunable": {
      "contracts": [ContractPrunableData],
      "totalPrunable": 987,
      "totalSize": 987
    }
  }
}

Queries

`renterdDownloadStats`

Response

Returns a DownloadStatsResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdDownloadStats(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdDownloadStats(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    avgDownloadSpeedMbps
    avgOverdrivePct
    healthyDownloaders
    numDownloaders
    downloadersStats {
      ...DownloaderStatsFragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdDownloadStats": {
      "avgDownloadSpeedMbps": 987.65,
      "avgOverdrivePct": 987.65,
      "healthyDownloaders": 987,
      "numDownloaders": 123,
      "downloadersStats": [DownloaderStats]
    }
  }
}

Queries

`renterdGetHosts`

Response

Returns [Host!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdGetHosts(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdGetHosts(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    knownSince
    lastAnnouncement
    publicKey
    netAddress
    priceTable {
      ...HostPriceTableFragment
    }
    settings {
      ...HostV2SettingsFragment
    }
    interactions {
      ...HostInteractionsFragment
    }
    scanned
    blocked
    checks
    storedData
    resolvedAddresses
    subnets
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdGetHosts": [
      {
        "knownSince": "2007-12-03T10:15:30Z",
        "lastAnnouncement": "2007-12-03T10:15:30Z",
        "publicKey": PublicKey,
        "netAddress": "xyz789",
        "priceTable": HostPriceTable,
        "settings": HostV2Settings,
        "interactions": HostInteractions,
        "scanned": false,
        "blocked": false,
        "checks": {},
        "storedData": 123,
        "resolvedAddresses": ["abc123"],
        "subnets": ["abc123"]
      }
    ]
  }
}

Queries

`renterdGetState`

Response

Returns a BusStateResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdGetState(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdGetState(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    version
    commit
    os
    buildTime
    startTime
    network
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdGetState": {
      "version": "abc123",
      "commit": "abc123",
      "os": "abc123",
      "buildTime": "2007-12-03T10:15:30Z",
      "startTime": "2007-12-03T10:15:30Z",
      "network": "xyz789"
    }
  }
}

Queries

`renterdGougingParams`

Response

Returns a GougingParams!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdGougingParams(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdGougingParams(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    consensusState {
      ...ConsensusStateFragment
    }
    gougingSettings {
      ...GougingSettingsFragment
    }
    redundancySettings {
      ...RedundancySettingsFragment
    }
    transactionFee
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdGougingParams": {
      "consensusState": ConsensusState,
      "gougingSettings": GougingSettings,
      "redundancySettings": RedundancySettings,
      "transactionFee": "USD"
    }
  }
}

Queries

`renterdHost`

Response

Returns a Host!

Arguments

Name	Description
`publicKey` - `PublicKey!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdHost(
  $publicKey: PublicKey!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdHost(
    publicKey: $publicKey,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    knownSince
    lastAnnouncement
    publicKey
    netAddress
    priceTable {
      ...HostPriceTableFragment
    }
    settings {
      ...HostV2SettingsFragment
    }
    interactions {
      ...HostInteractionsFragment
    }
    scanned
    blocked
    checks
    storedData
    resolvedAddresses
    subnets
  }
}

Variables

{
  "publicKey": PublicKey,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdHost": {
      "knownSince": "2007-12-03T10:15:30Z",
      "lastAnnouncement": "2007-12-03T10:15:30Z",
      "publicKey": PublicKey,
      "netAddress": "abc123",
      "priceTable": HostPriceTable,
      "settings": HostV2Settings,
      "interactions": HostInteractions,
      "scanned": true,
      "blocked": false,
      "checks": {},
      "storedData": 987,
      "resolvedAddresses": ["abc123"],
      "subnets": ["xyz789"]
    }
  }
}

Queries

`renterdHostsAllowlist`

Response

Returns [PublicKey!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdHostsAllowlist(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdHostsAllowlist(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{"data": {"renterdHostsAllowlist": [PublicKey]}}

Queries

`renterdHostsBlocklist`

Response

Returns [String!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdHostsBlocklist(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdHostsBlocklist(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdHostsBlocklist": ["abc123"]
  }
}

Queries

`renterdHostsScanning`

Response

Returns [HostAddress!]!

Arguments

Name	Description
`lastScan` - `String`	Default = `null`
`offset` - `Int!`	Default = `0`
`limit` - `Int!`	Default = `-1`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdHostsScanning(
  $lastScan: String,
  $offset: Int!,
  $limit: Int!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdHostsScanning(
    lastScan: $lastScan,
    offset: $offset,
    limit: $limit,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    publicKey
    netAddress
  }
}

Variables

{
  "lastScan": null,
  "offset": 0,
  "limit": -1,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdHostsScanning": [
      {
        "publicKey": PublicKey,
        "netAddress": "abc123"
      }
    ]
  }
}

Queries

`renterdMetric`

Response

Returns a JSON!

Arguments

Name	Description
`key` - `String!`
`start` - `String!`
`n` - `Int!`
`interval` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdMetric(
  $key: String!,
  $start: String!,
  $n: Int!,
  $interval: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdMetric(
    key: $key,
    start: $start,
    n: $n,
    interval: $interval,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{
  "key": "xyz789",
  "start": "abc123",
  "n": 123,
  "interval": "xyz789",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{"data": {"renterdMetric": {}}}

Queries

`renterdMultipartListParts`

Response

Returns a MultipartListPartsResponse!

Arguments

Name	Description
`req` - `MultipartListPartsRequestInput!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdMultipartListParts(
  $req: MultipartListPartsRequestInput!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdMultipartListParts(
    req: $req,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    hasMore
    nextMarker
    parts {
      ...MultipartListPartItemFragment
    }
  }
}

Variables

{
  "req": MultipartListPartsRequestInput,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdMultipartListParts": {
      "hasMore": true,
      "nextMarker": 123,
      "parts": [MultipartListPartItem]
    }
  }
}

Queries

`renterdMultipartListUploads`

Response

Returns a MultipartListUploadsResponse!

Arguments

Name	Description
`req` - `MultipartListUploadsRequestInput!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdMultipartListUploads(
  $req: MultipartListUploadsRequestInput!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdMultipartListUploads(
    req: $req,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    hasMore
    nextMarker
    nextUploadIDMarker
    uploads {
      ...MultipartUploadFragment
    }
  }
}

Variables

{
  "req": MultipartListUploadsRequestInput,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdMultipartListUploads": {
      "hasMore": false,
      "nextMarker": "abc123",
      "nextUploadIDMarker": "abc123",
      "uploads": [MultipartUpload]
    }
  }
}

Queries

`renterdMultipartUpload`

Response

Returns a MultipartUpload!

Arguments

Name	Description
`id` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdMultipartUpload(
  $id: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdMultipartUpload(
    id: $id,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    bucket
    key
    path
    uploadID
    createdAt
  }
}

Variables

{
  "id": "xyz789",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdMultipartUpload": {
      "bucket": "abc123",
      "key": EncryptionKey,
      "path": "xyz789",
      "uploadID": "abc123",
      "createdAt": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

`renterdObject`

Response

Returns an Object!

Arguments

Name	Description
`path` - `String!`
`bucket` - `String`	Default = `null`
`onlyMetadata` - `Boolean!`	Default = `false`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdObject(
  $path: String!,
  $bucket: String,
  $onlyMetadata: Boolean!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdObject(
    path: $path,
    bucket: $bucket,
    onlyMetadata: $onlyMetadata,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    metadata {
      ...ObjectMetadataFragment
    }
    key
    slabs {
      ...SlabSliceFragment
    }
    eTag
    health
    modTime
    name
    size
    mimeType
  }
}

Variables

{
  "path": "abc123",
  "bucket": null,
  "onlyMetadata": false,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdObject": {
      "metadata": ObjectMetadata,
      "key": EncryptionKey,
      "slabs": [SlabSlice],
      "eTag": "xyz789",
      "health": 123.45,
      "modTime": "2007-12-03T10:15:30Z",
      "name": "abc123",
      "size": 123,
      "mimeType": "abc123"
    }
  }
}

Queries

`renterdObjectsStats`

Response

Returns an ObjectsStatsResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdObjectsStats(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdObjectsStats(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    numObjects
    numUnfinishedObjects
    minHealth
    totalObjectsSize
    totalUnfinishedObjectsSize
    totalSectorsSize
    totalUploadedSize
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdObjectsStats": {
      "numObjects": 987,
      "numUnfinishedObjects": 987,
      "minHealth": 987.65,
      "totalObjectsSize": 987,
      "totalUnfinishedObjectsSize": 987,
      "totalSectorsSize": 987,
      "totalUploadedSize": 987
    }
  }
}

Queries

`renterdSearchHosts`

Response

Returns [Host!]!

Arguments

Name	Description
`req` - `SearchHostsRequestInput!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdSearchHosts(
  $req: SearchHostsRequestInput!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdSearchHosts(
    req: $req,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    knownSince
    lastAnnouncement
    publicKey
    netAddress
    priceTable {
      ...HostPriceTableFragment
    }
    settings {
      ...HostV2SettingsFragment
    }
    interactions {
      ...HostInteractionsFragment
    }
    scanned
    blocked
    checks
    storedData
    resolvedAddresses
    subnets
  }
}

Variables

{
  "req": SearchHostsRequestInput,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdSearchHosts": [
      {
        "knownSince": "2007-12-03T10:15:30Z",
        "lastAnnouncement": "2007-12-03T10:15:30Z",
        "publicKey": PublicKey,
        "netAddress": "abc123",
        "priceTable": HostPriceTable,
        "settings": HostV2Settings,
        "interactions": HostInteractions,
        "scanned": true,
        "blocked": false,
        "checks": {},
        "storedData": 987,
        "resolvedAddresses": ["abc123"],
        "subnets": ["xyz789"]
      }
    ]
  }
}

Queries

`renterdSearchObjects`

Response

Returns [ObjectMetadata!]!

Arguments

Name	Description
`key` - `String!`
`bucket` - `String!`	Default = `"default"`
`offset` - `Int!`	Default = `0`
`limit` - `Int!`	Default = `-1`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdSearchObjects(
  $key: String!,
  $bucket: String!,
  $offset: Int!,
  $limit: Int!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdSearchObjects(
    key: $key,
    bucket: $bucket,
    offset: $offset,
    limit: $limit,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    eTag
    health
    modTime
    name
    size
    mimeType
  }
}

Variables

{
  "key": "abc123",
  "bucket": "default",
  "offset": 0,
  "limit": -1,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdSearchObjects": [
      {
        "eTag": "xyz789",
        "health": 987.65,
        "modTime": "2007-12-03T10:15:30Z",
        "name": "xyz789",
        "size": 123,
        "mimeType": "abc123"
      }
    ]
  }
}

Queries

`renterdSetting`

Response

Returns a String!

Arguments

Name	Description
`key` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdSetting(
  $key: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdSetting(
    key: $key,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{
  "key": "xyz789",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{"data": {"renterdSetting": "xyz789"}}

Queries

`renterdSettings`

Response

Returns [String!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdSettings(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdSettings(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{"data": {"renterdSettings": ["xyz789"]}}

Queries

`renterdSlab`

Response

Returns a Slab!

Arguments

Name	Description
`key` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdSlab(
  $key: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdSlab(
    key: $key,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    health
    key
    minShards
    shards {
      ...SectorFragment
    }
  }
}

Variables

{
  "key": "xyz789",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdSlab": {
      "health": 123.45,
      "key": EncryptionKey,
      "minShards": 123,
      "shards": [Sector]
    }
  }
}

Queries

`renterdSlabBuffers`

Response

Returns [SlabBuffer!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdSlabBuffers(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdSlabBuffers(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    contractSet
    complete
    filename
    size
    maxSize
    locked
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdSlabBuffers": [
      {
        "contractSet": "abc123",
        "complete": false,
        "filename": "abc123",
        "size": 987,
        "maxSize": 987,
        "locked": true
      }
    ]
  }
}

Queries

`renterdSlabObjects`

Response

Returns [ObjectMetadata!]!

Arguments

Name	Description
`key` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdSlabObjects(
  $key: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdSlabObjects(
    key: $key,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    eTag
    health
    modTime
    name
    size
    mimeType
  }
}

Variables

{
  "key": "xyz789",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdSlabObjects": [
      {
        "eTag": "xyz789",
        "health": 987.65,
        "modTime": "2007-12-03T10:15:30Z",
        "name": "abc123",
        "size": 987,
        "mimeType": "xyz789"
      }
    ]
  }
}

Queries

`renterdSlabsPartial`

Response

Returns a String!

Arguments

Name	Description
`key` - `String!`
`offset` - `Int!`
`length` - `Int!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdSlabsPartial(
  $key: String!,
  $offset: Int!,
  $length: Int!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdSlabsPartial(
    key: $key,
    offset: $offset,
    length: $length,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{
  "key": "xyz789",
  "offset": 123,
  "length": 123,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{"data": {"renterdSlabsPartial": "abc123"}}

Queries

`renterdSyncerAddress`

Response

Returns a String!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdSyncerAddress(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdSyncerAddress(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{"data": {"renterdSyncerAddress": "xyz789"}}

Queries

`renterdSyncerPeers`

Response

Returns [String!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdSyncerPeers(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdSyncerPeers(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{"data": {"renterdSyncerPeers": ["abc123"]}}

Queries

`renterdTxpoolRecommendedFee`

Response

Returns a Currency!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdTxpoolRecommendedFee(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdTxpoolRecommendedFee(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdTxpoolRecommendedFee": "USD"
  }
}

Queries

`renterdTxpoolTransactions`

Response

Returns [Transaction!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdTxpoolTransactions(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdTxpoolTransactions(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    siacoinInputs {
      ...SiacoinInputFragment
    }
    siacoinOutputs {
      ...SiacoinOutputFragment
    }
    fileContracts {
      ...FileContractFragment
    }
    fileContractRevisions {
      ...FileContractRevisionFragment
    }
    storageProofs {
      ...StorageProofFragment
    }
    siafundInputs {
      ...SiafundInputFragment
    }
    siafundOutputs {
      ...SiafundOutputFragment
    }
    minerFees
    arbitraryData
    signatures {
      ...TransactionSignatureFragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdTxpoolTransactions": [
      {
        "siacoinInputs": [SiacoinInput],
        "siacoinOutputs": [SiacoinOutput],
        "fileContracts": [FileContract],
        "fileContractRevisions": [FileContractRevision],
        "storageProofs": [StorageProof],
        "siafundInputs": [SiafundInput],
        "siafundOutputs": [SiafundOutput],
        "minerFees": ["USD"],
        "arbitraryData": ["abc123"],
        "signatures": [TransactionSignature]
      }
    ]
  }
}

Queries

`renterdUploadParams`

Response

Returns an UploadParams!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdUploadParams(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdUploadParams(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    consensusState {
      ...ConsensusStateFragment
    }
    gougingSettings {
      ...GougingSettingsFragment
    }
    redundancySettings {
      ...RedundancySettingsFragment
    }
    transactionFee
    currentHeight
    contractSet
    uploadPacking
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdUploadParams": {
      "consensusState": ConsensusState,
      "gougingSettings": GougingSettings,
      "redundancySettings": RedundancySettings,
      "transactionFee": "USD",
      "currentHeight": 987,
      "contractSet": "xyz789",
      "uploadPacking": true
    }
  }
}

Queries

`renterdUploadStats`

Response

Returns an UploadStatsResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdUploadStats(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdUploadStats(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    avgSlabUploadSpeedMbps
    avgOverdrivePct
    healthyUploaders
    numUploaders
    uploadersStats {
      ...UploaderStatsFragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdUploadStats": {
      "avgSlabUploadSpeedMbps": 987.65,
      "avgOverdrivePct": 987.65,
      "healthyUploaders": 123,
      "numUploaders": 987,
      "uploadersStats": [UploaderStats]
    }
  }
}

Queries

`renterdWallet`

Response

Returns a WalletResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdWallet(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdWallet(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    scanHeight
    address
    spendable
    confirmed
    unconfirmed
    immature
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdWallet": {
      "scanHeight": 123,
      "address": Address,
      "spendable": "USD",
      "confirmed": "USD",
      "unconfirmed": "USD",
      "immature": "USD"
    }
  }
}

Queries

`renterdWalletOutputs`

Response

Returns [SiacoinElement!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdWalletOutputs(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdWalletOutputs(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    value
    address
    id
    maturityHeight
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdWalletOutputs": [
      {
        "value": "USD",
        "address": Address,
        "id": SiacoinOutputID,
        "maturityHeight": 987
      }
    ]
  }
}

Queries

`renterdWalletPending`

Response

Returns [Transaction!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdWalletPending(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdWalletPending(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    siacoinInputs {
      ...SiacoinInputFragment
    }
    siacoinOutputs {
      ...SiacoinOutputFragment
    }
    fileContracts {
      ...FileContractFragment
    }
    fileContractRevisions {
      ...FileContractRevisionFragment
    }
    storageProofs {
      ...StorageProofFragment
    }
    siafundInputs {
      ...SiafundInputFragment
    }
    siafundOutputs {
      ...SiafundOutputFragment
    }
    minerFees
    arbitraryData
    signatures {
      ...TransactionSignatureFragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdWalletPending": [
      {
        "siacoinInputs": [SiacoinInput],
        "siacoinOutputs": [SiacoinOutput],
        "fileContracts": [FileContract],
        "fileContractRevisions": [FileContractRevision],
        "storageProofs": [StorageProof],
        "siafundInputs": [SiafundInput],
        "siafundOutputs": [SiafundOutput],
        "minerFees": ["USD"],
        "arbitraryData": ["xyz789"],
        "signatures": [TransactionSignature]
      }
    ]
  }
}

Queries

`renterdWalletTransactions`

Response

Returns [Transaction!]!

Arguments

Name	Description
`offset` - `Int!`	Default = `0`
`limit` - `Int!`	Default = `-1`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdWalletTransactions(
  $offset: Int!,
  $limit: Int!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdWalletTransactions(
    offset: $offset,
    limit: $limit,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    siacoinInputs {
      ...SiacoinInputFragment
    }
    siacoinOutputs {
      ...SiacoinOutputFragment
    }
    fileContracts {
      ...FileContractFragment
    }
    fileContractRevisions {
      ...FileContractRevisionFragment
    }
    storageProofs {
      ...StorageProofFragment
    }
    siafundInputs {
      ...SiafundInputFragment
    }
    siafundOutputs {
      ...SiafundOutputFragment
    }
    minerFees
    arbitraryData
    signatures {
      ...TransactionSignatureFragment
    }
  }
}

Variables

{"offset": 0, "limit": -1, "filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdWalletTransactions": [
      {
        "siacoinInputs": [SiacoinInput],
        "siacoinOutputs": [SiacoinOutput],
        "fileContracts": [FileContract],
        "fileContractRevisions": [FileContractRevision],
        "storageProofs": [StorageProof],
        "siafundInputs": [SiafundInput],
        "siafundOutputs": [SiafundOutput],
        "minerFees": ["USD"],
        "arbitraryData": ["xyz789"],
        "signatures": [TransactionSignature]
      }
    ]
  }
}

Queries

`renterdWebhooks`

Response

Returns a WebhookResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdWebhooks(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdWebhooks(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    webhooks {
      ...WebhookFragment
    }
    queues {
      ...WebhookQueueInfoFragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdWebhooks": {
      "webhooks": [Webhook],
      "queues": [WebhookQueueInfo]
    }
  }
}

Queries

`renterdWorkerAccount`

Response

Returns an Account!

Arguments

Name	Description
`hostKey` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdWorkerAccount(
  $hostKey: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdWorkerAccount(
    hostKey: $hostKey,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    cleanShutdown
    hostKey
    balance
    drift
    owner
    requiresSync
  }
}

Variables

{
  "hostKey": "xyz789",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdWorkerAccount": {
      "id": PublicKey,
      "cleanShutdown": false,
      "hostKey": PublicKey,
      "balance": 987,
      "drift": 987,
      "owner": "xyz789",
      "requiresSync": false
    }
  }
}

Queries

`renterdWorkerAccounts`

Response

Returns [Account!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdWorkerAccounts(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdWorkerAccounts(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    cleanShutdown
    hostKey
    balance
    drift
    owner
    requiresSync
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdWorkerAccounts": [
      {
        "id": PublicKey,
        "cleanShutdown": true,
        "hostKey": PublicKey,
        "balance": 987,
        "drift": 123,
        "owner": "abc123",
        "requiresSync": true
      }
    ]
  }
}

Queries

`renterdWorkerContracts`

Response

Returns a ContractsResponse!

Arguments

Name	Description
`hostTimeout` - `Int`	Default = `null`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdWorkerContracts(
  $hostTimeout: Int,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdWorkerContracts(
    hostTimeout: $hostTimeout,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    contracts {
      ...ContractFragment
    }
    errors
    error
  }
}

Variables

{"hostTimeout": null, "filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdWorkerContracts": {
      "contracts": [Contract],
      "errors": {},
      "error": "abc123"
    }
  }
}

Queries

`renterdWorkerId`

Response

Returns a String!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdWorkerId(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdWorkerId(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{"data": {"renterdWorkerId": "abc123"}}

Queries

`renterdWorkerMemory`

Response

Returns a MemoryResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdWorkerMemory(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdWorkerMemory(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    download {
      ...MemoryStatusFragment
    }
    upload {
      ...MemoryStatusFragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdWorkerMemory": {
      "download": MemoryStatus,
      "upload": MemoryStatus
    }
  }
}

Queries

`renterdWorkerObject`

Response

Returns a GetObjectResponse!

Arguments

Name	Description
`bucket` - `String!`
`path` - `String!`
`opts` - `GetObjectOptionsInput!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdWorkerObject(
  $bucket: String!,
  $path: String!,
  $opts: GetObjectOptionsInput!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdWorkerObject(
    bucket: $bucket,
    path: $path,
    opts: $opts,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    contentType
    etag
    lastModified
    range {
      ...ContentRangeFragment
    }
    size
    metadata
    content
  }
}

Variables

{
  "bucket": "xyz789",
  "path": "xyz789",
  "opts": GetObjectOptionsInput,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "renterdWorkerObject": {
      "contentType": "xyz789",
      "etag": "xyz789",
      "lastModified": "2007-12-03T10:15:30Z",
      "range": ContentRange,
      "size": 987,
      "metadata": {},
      "content": "xyz789"
    }
  }
}

Queries

`renterdWorkerState`

Response

Returns a WorkerStateResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query renterdWorkerState(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  renterdWorkerState(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    version
    commit
    os
    buildTime
    id
    startTime
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "renterdWorkerState": {
      "version": "abc123",
      "commit": "xyz789",
      "os": "xyz789",
      "buildTime": "2007-12-03T10:15:30Z",
      "id": "abc123",
      "startTime": "2007-12-03T10:15:30Z"
    }
  }
}

Queries

`walletdAddressBalance`

Response

Returns a Balance!

Arguments

Name	Description
`address` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdAddressBalance(
  $address: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdAddressBalance(
    address: $address,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    siacoins
    immatureSiacoins
    siafunds
  }
}

Variables

{
  "address": "xyz789",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdAddressBalance": {
      "siacoins": "USD",
      "immatureSiacoins": "USD",
      "siafunds": 123
    }
  }
}

Queries

`walletdAddressEvents`

Response

Returns [WalletEvent!]!

Arguments

Name	Description
`address` - `String!`
`offset` - `Int!`	Default = `0`
`limit` - `Int!`	Default = `500`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdAddressEvents(
  $address: String!,
  $offset: Int!,
  $limit: Int!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdAddressEvents(
    address: $address,
    offset: $offset,
    limit: $limit,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    index {
      ...ChainIndexFragment
    }
    type
    data
    maturityHeight
    timestamp
    relevant
  }
}

Variables

{
  "address": "abc123",
  "offset": 0,
  "limit": 500,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdAddressEvents": [
      {
        "id": Hash256,
        "index": ChainIndex,
        "type": "abc123",
        "data": {},
        "maturityHeight": 987,
        "timestamp": "2007-12-03T10:15:30Z",
        "relevant": [Address]
      }
    ]
  }
}

Queries

`walletdAddressSiacoinOutputs`

Response

Returns [SiacoinElement!]!

Arguments

Name	Description
`address` - `String!`
`offset` - `Int!`	Default = `0`
`limit` - `Int!`	Default = `1000`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdAddressSiacoinOutputs(
  $address: String!,
  $offset: Int!,
  $limit: Int!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdAddressSiacoinOutputs(
    address: $address,
    offset: $offset,
    limit: $limit,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    value
    address
    id
    maturityHeight
  }
}

Variables

{
  "address": "abc123",
  "offset": 0,
  "limit": 1000,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdAddressSiacoinOutputs": [
      {
        "value": "USD",
        "address": Address,
        "id": SiacoinOutputID,
        "maturityHeight": 987
      }
    ]
  }
}

Queries

`walletdAddressSiafundOutputs`

Response

Returns [SiafundElement!]!

Arguments

Name	Description
`address` - `String!`
`offset` - `Int!`	Default = `0`
`limit` - `Int!`	Default = `1000`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdAddressSiafundOutputs(
  $address: String!,
  $offset: Int!,
  $limit: Int!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdAddressSiafundOutputs(
    address: $address,
    offset: $offset,
    limit: $limit,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    stateElement {
      ...StateElementFragment
    }
    siafundOutput {
      ...SiafundOutputFragment
    }
    claimStart
  }
}

Variables

{
  "address": "abc123",
  "offset": 0,
  "limit": 1000,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdAddressSiafundOutputs": [
      {
        "id": SiafundOutputID,
        "stateElement": StateElement,
        "siafundOutput": SiafundOutput,
        "claimStart": "USD"
      }
    ]
  }
}

Queries

`walletdAddressUnconfirmedEvents`

Response

Returns [WalletEvent!]!

Arguments

Name	Description
`address` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdAddressUnconfirmedEvents(
  $address: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdAddressUnconfirmedEvents(
    address: $address,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    index {
      ...ChainIndexFragment
    }
    type
    data
    maturityHeight
    timestamp
    relevant
  }
}

Variables

{
  "address": "xyz789",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdAddressUnconfirmedEvents": [
      {
        "id": Hash256,
        "index": ChainIndex,
        "type": "abc123",
        "data": {},
        "maturityHeight": 123,
        "timestamp": "2007-12-03T10:15:30Z",
        "relevant": [Address]
      }
    ]
  }
}

Queries

`walletdConsensusIndex`

Response

Returns a ChainIndex!

Arguments

Name	Description
`height` - `Int!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdConsensusIndex(
  $height: Int!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdConsensusIndex(
    height: $height,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    height
    id
  }
}

Variables

{"height": 987, "filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "walletdConsensusIndex": {
      "height": 987,
      "id": BlockID
    }
  }
}

Queries

`walletdConsensusNetwork`

Response

Returns a Network!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdConsensusNetwork(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdConsensusNetwork(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    name
    initialCoinbase
    minimumCoinbase
    initialTarget
    blockInterval
    maturityDelay
    hardforkDevAddr {
      ...HardforkDevAddrFragment
    }
    hardforkTax {
      ...HardforkTaxFragment
    }
    hardforkStorageProof {
      ...HardforkStorageProofFragment
    }
    hardforkOak {
      ...HardforkOakFragment
    }
    hardforkASIC {
      ...HardforkASICFragment
    }
    hardforkFoundation {
      ...HardforkFoundationFragment
    }
    hardforkV2 {
      ...HardforkV2Fragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "walletdConsensusNetwork": {
      "name": "abc123",
      "initialCoinbase": "USD",
      "minimumCoinbase": "USD",
      "initialTarget": BlockID,
      "blockInterval": "P3Y6M4DT12H30M5S",
      "maturityDelay": 987,
      "hardforkDevAddr": HardforkDevAddr,
      "hardforkTax": HardforkTax,
      "hardforkStorageProof": HardforkStorageProof,
      "hardforkOak": HardforkOak,
      "hardforkASIC": HardforkASIC,
      "hardforkFoundation": HardforkFoundation,
      "hardforkV2": HardforkV2
    }
  }
}

Queries

`walletdConsensusTip`

Response

Returns a ChainIndex!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdConsensusTip(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdConsensusTip(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    height
    id
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "walletdConsensusTip": {"height": 123, "id": BlockID}
  }
}

Queries

`walletdConsensusTipState`

Response

Returns a ConsensusState!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdConsensusTipState(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdConsensusTipState(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    blockHeight
    lastBlockTime
    synced
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "walletdConsensusTipState": {
      "blockHeight": 987,
      "lastBlockTime": "2007-12-03T10:15:30Z",
      "synced": false
    }
  }
}

Queries

`walletdConsensusUpdates`

Response

Returns a ConsensusUpdatesResponse!

Arguments

Name	Description
`index` - `ChainIndexInput!`
`limit` - `Int!`	Default = `10`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdConsensusUpdates(
  $index: ChainIndexInput!,
  $limit: Int!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdConsensusUpdates(
    index: $index,
    limit: $limit,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    applied {
      ...ApplyUpdateFragment
    }
    reverted {
      ...RevertUpdateFragment
    }
  }
}

Variables

{
  "index": ChainIndexInput,
  "limit": 10,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdConsensusUpdates": {
      "applied": [ApplyUpdate],
      "reverted": [RevertUpdate]
    }
  }
}

Queries

`walletdEvent`

Response

Returns a WalletEvent!

Arguments

Name	Description
`eventId` - `Hash256!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdEvent(
  $eventId: Hash256!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdEvent(
    eventId: $eventId,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    index {
      ...ChainIndexFragment
    }
    type
    data
    maturityHeight
    timestamp
    relevant
  }
}

Variables

{
  "eventId": Hash256,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdEvent": {
      "id": Hash256,
      "index": ChainIndex,
      "type": "abc123",
      "data": {},
      "maturityHeight": 987,
      "timestamp": "2007-12-03T10:15:30Z",
      "relevant": [Address]
    }
  }
}

Queries

`walletdGetSiacoinOutput`

Response

Returns a SiacoinElement!

Arguments

Name	Description
`id` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdGetSiacoinOutput(
  $id: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdGetSiacoinOutput(
    id: $id,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    value
    address
    id
    maturityHeight
  }
}

Variables

{
  "id": "abc123",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdGetSiacoinOutput": {
      "value": "USD",
      "address": Address,
      "id": SiacoinOutputID,
      "maturityHeight": 987
    }
  }
}

Queries

`walletdGetSiafundOutput`

Response

Returns a SiafundElement!

Arguments

Name	Description
`id` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdGetSiafundOutput(
  $id: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdGetSiafundOutput(
    id: $id,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    stateElement {
      ...StateElementFragment
    }
    siafundOutput {
      ...SiafundOutputFragment
    }
    claimStart
  }
}

Variables

{
  "id": "abc123",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdGetSiafundOutput": {
      "id": SiafundOutputID,
      "stateElement": StateElement,
      "siafundOutput": SiafundOutput,
      "claimStart": "USD"
    }
  }
}

Queries

`walletdRescanStatus`

Response

Returns a RescanResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdRescanStatus(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdRescanStatus(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    startIndex {
      ...ChainIndexFragment
    }
    index {
      ...ChainIndexFragment
    }
    startTime
    error
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "walletdRescanStatus": {
      "startIndex": ChainIndex,
      "index": ChainIndex,
      "startTime": "2007-12-03T10:15:30Z",
      "error": "abc123"
    }
  }
}

Queries

`walletdState`

Response

Returns a StateResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdState(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdState(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    version
    commit
    os
    buildTime
    startTime
    indexMode
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "walletdState": {
      "version": "abc123",
      "commit": "xyz789",
      "os": "abc123",
      "buildTime": "2007-12-03T10:15:30Z",
      "startTime": "2007-12-03T10:15:30Z",
      "indexMode": "PERSONAL"
    }
  }
}

Queries

`walletdSyncerPeers`

Response

Returns [GatewayPeer!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdSyncerPeers(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdSyncerPeers(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    address
    inbound
    version
    firstSeen
    connectedSince
    syncedBlocks
    syncDuration
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "walletdSyncerPeers": [
      {
        "address": "xyz789",
        "inbound": false,
        "version": "xyz789",
        "firstSeen": "2007-12-03T10:15:30Z",
        "connectedSince": "2007-12-03T10:15:30Z",
        "syncedBlocks": 123,
        "syncDuration": "P3Y6M4DT12H30M5S"
      }
    ]
  }
}

Queries

`walletdTxpoolFee`

Response

Returns a Currency!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdTxpoolFee(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdTxpoolFee(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{"data": {"walletdTxpoolFee": "USD"}}

Queries

`walletdTxpoolParents`

Response

Returns [Transaction!]!

Arguments

Name	Description
`transaction` - `TransactionInput!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdTxpoolParents(
  $transaction: TransactionInput!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdTxpoolParents(
    transaction: $transaction,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    siacoinInputs {
      ...SiacoinInputFragment
    }
    siacoinOutputs {
      ...SiacoinOutputFragment
    }
    fileContracts {
      ...FileContractFragment
    }
    fileContractRevisions {
      ...FileContractRevisionFragment
    }
    storageProofs {
      ...StorageProofFragment
    }
    siafundInputs {
      ...SiafundInputFragment
    }
    siafundOutputs {
      ...SiafundOutputFragment
    }
    minerFees
    arbitraryData
    signatures {
      ...TransactionSignatureFragment
    }
  }
}

Variables

{
  "transaction": TransactionInput,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdTxpoolParents": [
      {
        "siacoinInputs": [SiacoinInput],
        "siacoinOutputs": [SiacoinOutput],
        "fileContracts": [FileContract],
        "fileContractRevisions": [FileContractRevision],
        "storageProofs": [StorageProof],
        "siafundInputs": [SiafundInput],
        "siafundOutputs": [SiafundOutput],
        "minerFees": ["USD"],
        "arbitraryData": ["abc123"],
        "signatures": [TransactionSignature]
      }
    ]
  }
}

Queries

`walletdTxpoolTransactions`

Response

Returns a TxpoolTransactionsResponse!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdTxpoolTransactions(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdTxpoolTransactions(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    transactions {
      ...TransactionFragment
    }
    v2transactions {
      ...V2TransactionFragment
    }
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "walletdTxpoolTransactions": {
      "transactions": [Transaction],
      "v2transactions": [V2Transaction]
    }
  }
}

Queries

`walletdWalletAddresses`

Response

Returns [Address!]!

Arguments

Name	Description
`walletId` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdWalletAddresses(
  $walletId: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdWalletAddresses(
    walletId: $walletId,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  )
}

Variables

{
  "walletId": "xyz789",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{"data": {"walletdWalletAddresses": [Address]}}

Queries

`walletdWalletBalance`

Response

Returns a Balance!

Arguments

Name	Description
`walletId` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdWalletBalance(
  $walletId: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdWalletBalance(
    walletId: $walletId,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    siacoins
    immatureSiacoins
    siafunds
  }
}

Variables

{
  "walletId": "xyz789",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdWalletBalance": {
      "siacoins": "USD",
      "immatureSiacoins": "USD",
      "siafunds": 123
    }
  }
}

Queries

`walletdWalletEvents`

Response

Returns [WalletEvent!]!

Arguments

Name	Description
`walletId` - `String!`
`offset` - `Int!`	Default = `0`
`limit` - `Int!`	Default = `500`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdWalletEvents(
  $walletId: String!,
  $offset: Int!,
  $limit: Int!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdWalletEvents(
    walletId: $walletId,
    offset: $offset,
    limit: $limit,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    index {
      ...ChainIndexFragment
    }
    type
    data
    maturityHeight
    timestamp
    relevant
  }
}

Variables

{
  "walletId": "xyz789",
  "offset": 0,
  "limit": 500,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdWalletEvents": [
      {
        "id": Hash256,
        "index": ChainIndex,
        "type": "xyz789",
        "data": {},
        "maturityHeight": 123,
        "timestamp": "2007-12-03T10:15:30Z",
        "relevant": [Address]
      }
    ]
  }
}

Queries

`walletdWalletSiacoinOutputs`

Response

Returns [SiacoinElement!]!

Arguments

Name	Description
`walletId` - `String!`
`offset` - `Int`	Default = `0`
`limit` - `Int`	Default = `1000`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdWalletSiacoinOutputs(
  $walletId: String!,
  $offset: Int,
  $limit: Int,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdWalletSiacoinOutputs(
    walletId: $walletId,
    offset: $offset,
    limit: $limit,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    value
    address
    id
    maturityHeight
  }
}

Variables

{
  "walletId": "abc123",
  "offset": 0,
  "limit": 1000,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdWalletSiacoinOutputs": [
      {
        "value": "USD",
        "address": Address,
        "id": SiacoinOutputID,
        "maturityHeight": 123
      }
    ]
  }
}

Queries

`walletdWalletSiafundOutputs`

Response

Returns [SiafundElement!]!

Arguments

Name	Description
`walletId` - `String!`
`offset` - `Int`	Default = `0`
`limit` - `Int`	Default = `1000`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdWalletSiafundOutputs(
  $walletId: String!,
  $offset: Int,
  $limit: Int,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdWalletSiafundOutputs(
    walletId: $walletId,
    offset: $offset,
    limit: $limit,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    stateElement {
      ...StateElementFragment
    }
    siafundOutput {
      ...SiafundOutputFragment
    }
    claimStart
  }
}

Variables

{
  "walletId": "abc123",
  "offset": 0,
  "limit": 1000,
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdWalletSiafundOutputs": [
      {
        "id": SiafundOutputID,
        "stateElement": StateElement,
        "siafundOutput": SiafundOutput,
        "claimStart": "USD"
      }
    ]
  }
}

Queries

`walletdWalletUnconfirmedEvents`

Response

Returns [WalletEvent!]!

Arguments

Name	Description
`walletId` - `String!`
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdWalletUnconfirmedEvents(
  $walletId: String!,
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdWalletUnconfirmedEvents(
    walletId: $walletId,
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    index {
      ...ChainIndexFragment
    }
    type
    data
    maturityHeight
    timestamp
    relevant
  }
}

Variables

{
  "walletId": "abc123",
  "filter": null,
  "sort": null,
  "pagination": null
}

Response

{
  "data": {
    "walletdWalletUnconfirmedEvents": [
      {
        "id": Hash256,
        "index": ChainIndex,
        "type": "abc123",
        "data": {},
        "maturityHeight": 123,
        "timestamp": "2007-12-03T10:15:30Z",
        "relevant": [Address]
      }
    ]
  }
}

Queries

`walletdWallets`

Response

Returns [Wallet!]!

Arguments

Name	Description
`filter` - `FilterInput`	Default = `null`
`sort` - `SortInput`	Default = `null`
`pagination` - `PaginationInput`	Default = `null`

Example

Query

query walletdWallets(
  $filter: FilterInput,
  $sort: SortInput,
  $pagination: PaginationInput
) {
  walletdWallets(
    filter: $filter,
    sort: $sort,
    pagination: $pagination
  ) {
    id
    name
    description
    dateCreated
    lastUpdated
    metadata
  }
}

Variables

{"filter": null, "sort": null, "pagination": null}

Response

{
  "data": {
    "walletdWallets": [
      {
        "id": 123,
        "name": "abc123",
        "description": "xyz789",
        "dateCreated": "2007-12-03T10:15:30Z",
        "lastUpdated": "2007-12-03T10:15:30Z",
        "metadata": {}
      }
    ]
  }
}

Mutations

`hostdAddVolume`

Response

Returns a Volume!

Arguments

Name	Description
`req` - `AddVolumeRequestInput!`

Example

Query

mutation hostdAddVolume($req: AddVolumeRequestInput!) {
  hostdAddVolume(req: $req) {
    id
    localPath
    usedSectors
    totalSectors
    readOnly
    available
  }
}

Variables

{"req": AddVolumeRequestInput}

Response

{
  "data": {
    "hostdAddVolume": {
      "id": 123,
      "localPath": "abc123",
      "usedSectors": 987,
      "totalSectors": 123,
      "readOnly": true,
      "available": true
    }
  }
}

Mutations

`hostdAnnounce`

Response

Returns a Boolean!

Example

Query

mutation hostdAnnounce {
  hostdAnnounce
}

Response

{"data": {"hostdAnnounce": false}}

Mutations

`hostdBackupSqlite3`

Response

Returns a Boolean!

Arguments

Name	Description
`path` - `String!`

Example

Query

mutation hostdBackupSqlite3($path: String!) {
  hostdBackupSqlite3(path: $path)
}

Variables

{"path": "abc123"}

Response

{"data": {"hostdBackupSqlite3": false}}

Mutations

`hostdCancelVolumeOperation`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `Int!`

Example

Query

mutation hostdCancelVolumeOperation($id: Int!) {
  hostdCancelVolumeOperation(id: $id)
}

Variables

{"id": 123}

Response

{"data": {"hostdCancelVolumeOperation": false}}

Mutations

`hostdCheckContractIntegrity`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `FileContractID!`

Example

Query

mutation hostdCheckContractIntegrity($id: FileContractID!) {
  hostdCheckContractIntegrity(id: $id)
}

Variables

{"id": FileContractID}

Response

{"data": {"hostdCheckContractIntegrity": true}}

Mutations

`hostdConnectPeer`

Response

Returns a Boolean!

Arguments

Name	Description
`address` - `String!`

Example

Query

mutation hostdConnectPeer($address: String!) {
  hostdConnectPeer(address: $address)
}

Variables

{"address": "abc123"}

Response

{"data": {"hostdConnectPeer": true}}

Mutations

`hostdCreateDir`

Response

Returns a Boolean!

Arguments

Name	Description
`path` - `String!`

Example

Query

mutation hostdCreateDir($path: String!) {
  hostdCreateDir(path: $path)
}

Variables

{"path": "abc123"}

Response

{"data": {"hostdCreateDir": true}}

Mutations

`hostdDeleteContractIntegrity`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `FileContractID!`

Example

Query

mutation hostdDeleteContractIntegrity($id: FileContractID!) {
  hostdDeleteContractIntegrity(id: $id)
}

Variables

{"id": FileContractID}

Response

{"data": {"hostdDeleteContractIntegrity": false}}

Mutations

`hostdDeleteSector`

Response

Returns a Boolean!

Example

Query

mutation hostdDeleteSector {
  hostdDeleteSector
}

Response

{"data": {"hostdDeleteSector": true}}

Mutations

`hostdDeleteVolume`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `Int!`
`force` - `Boolean!`	Default = `false`

Example

Query

mutation hostdDeleteVolume(
  $id: Int!,
  $force: Boolean!
) {
  hostdDeleteVolume(
    id: $id,
    force: $force
  )
}

Variables

{"id": 987, "force": false}

Response

{"data": {"hostdDeleteVolume": true}}

Mutations

`hostdDeleteWebhook`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `Int!`

Example

Query

mutation hostdDeleteWebhook($id: Int!) {
  hostdDeleteWebhook(id: $id)
}

Variables

{"id": 123}

Response

{"data": {"hostdDeleteWebhook": true}}

Mutations

`hostdDismissAlerts`

Response

Returns a Boolean!

Arguments

Name	Description
`ids` - `[Hash256!]!`

Example

Query

mutation hostdDismissAlerts($ids: [Hash256!]!) {
  hostdDismissAlerts(ids: $ids)
}

Variables

{"ids": [Hash256]}

Response

{"data": {"hostdDismissAlerts": false}}

Mutations

`hostdRegisterWebhook`

Response

Returns a Webhook!

Arguments

Name	Description
`req` - `RegisterWebHookRequestInput!`

Example

Query

mutation hostdRegisterWebhook($req: RegisterWebHookRequestInput!) {
  hostdRegisterWebhook(req: $req) {
    module
    event
    url
    headers
  }
}

Variables

{"req": RegisterWebHookRequestInput}

Response

{
  "data": {
    "hostdRegisterWebhook": {
      "module": "abc123",
      "event": "xyz789",
      "url": "xyz789",
      "headers": {}
    }
  }
}

Mutations

`hostdResizeVolume`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `Int!`
`req` - `ResizeVolumeRequestInput!`

Example

Query

mutation hostdResizeVolume(
  $id: Int!,
  $req: ResizeVolumeRequestInput!
) {
  hostdResizeVolume(
    id: $id,
    req: $req
  )
}

Variables

{"id": 987, "req": ResizeVolumeRequestInput}

Response

{"data": {"hostdResizeVolume": false}}

Mutations

`hostdSendSiacoins`

Response

Returns a TransactionID!

Arguments

Name	Description
`req` - `WalletSendSiacoinsRequestInput!`

Example

Query

mutation hostdSendSiacoins($req: WalletSendSiacoinsRequestInput!) {
  hostdSendSiacoins(req: $req)
}

Variables

{"req": WalletSendSiacoinsRequestInput}

Response

{"data": {"hostdSendSiacoins": TransactionID}}

Mutations

`hostdTestWebhook`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `Int!`

Example

Query

mutation hostdTestWebhook($id: Int!) {
  hostdTestWebhook(id: $id)
}

Variables

{"id": 987}

Response

{"data": {"hostdTestWebhook": false}}

Mutations

`hostdUpdateDdns`

Response

Returns a Boolean!

Arguments

Name	Description
`force` - `Boolean!`	Default = `false`

Example

Query

mutation hostdUpdateDdns($force: Boolean!) {
  hostdUpdateDdns(force: $force)
}

Variables

{"force": false}

Response

{"data": {"hostdUpdateDdns": false}}

Mutations

`hostdUpdatePinnedSettings`

Response

Returns a Boolean!

Arguments

Name	Description
`settings` - `PinnedSettingsInput!`

Example

Query

mutation hostdUpdatePinnedSettings($settings: PinnedSettingsInput!) {
  hostdUpdatePinnedSettings(settings: $settings)
}

Variables

{"settings": PinnedSettingsInput}

Response

{"data": {"hostdUpdatePinnedSettings": true}}

Mutations

`hostdUpdateSettings`

Response

Returns a HostSettings!

Arguments

Name	Description
`settings` - `HostSettingsInput!`

Example

Query

mutation hostdUpdateSettings($settings: HostSettingsInput!) {
  hostdUpdateSettings(settings: $settings) {
    acceptingContracts
    netAddress
    maxContractDuration
    windowSize
    contractPrice
    baseRPCPrice
    sectorAccessPrice
    collateralMultiplier
    maxCollateral
    storagePrice
    egressPrice
    ingressPrice
    priceTableValidity
    maxRegistryEntries
    accountExpiry
    maxAccountBalance
    ingressLimit
    egressLimit
    ddns {
      ...DNSSettingsFragment
    }
    sectorCacheSize
    revision
  }
}

Variables

{"settings": HostSettingsInput}

Response

{
  "data": {
    "hostdUpdateSettings": {
      "acceptingContracts": true,
      "netAddress": "xyz789",
      "maxContractDuration": 987,
      "windowSize": 123,
      "contractPrice": "USD",
      "baseRPCPrice": "USD",
      "sectorAccessPrice": "USD",
      "collateralMultiplier": 987.65,
      "maxCollateral": "USD",
      "storagePrice": "USD",
      "egressPrice": "USD",
      "ingressPrice": "USD",
      "priceTableValidity": "P3Y6M4DT12H30M5S",
      "maxRegistryEntries": 987,
      "accountExpiry": "P3Y6M4DT12H30M5S",
      "maxAccountBalance": "USD",
      "ingressLimit": 123,
      "egressLimit": 123,
      "ddns": DNSSettings,
      "sectorCacheSize": 987,
      "revision": 123
    }
  }
}

Mutations

`hostdUpdateVolume`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `Int!`
`req` - `UpdateVolumeRequestInput!`

Example

Query

mutation hostdUpdateVolume(
  $id: Int!,
  $req: UpdateVolumeRequestInput!
) {
  hostdUpdateVolume(
    id: $id,
    req: $req
  )
}

Variables

{"id": 123, "req": UpdateVolumeRequestInput}

Response

{"data": {"hostdUpdateVolume": true}}

Mutations

`hostdUpdateWebhook`

Response

Returns a Webhook!

Arguments

Name	Description
`id` - `Int!`
`req` - `RegisterWebHookRequestInput!`

Example

Query

mutation hostdUpdateWebhook(
  $id: Int!,
  $req: RegisterWebHookRequestInput!
) {
  hostdUpdateWebhook(
    id: $id,
    req: $req
  ) {
    module
    event
    url
    headers
  }
}

Variables

{"id": 987, "req": RegisterWebHookRequestInput}

Response

{
  "data": {
    "hostdUpdateWebhook": {
      "module": "abc123",
      "event": "abc123",
      "url": "xyz789",
      "headers": {}
    }
  }
}

Mutations

`renterdAbortMultipartUpload`

Response

Returns a Boolean!

Arguments

Name	Description
`req` - `MultipartAbortRequestInput!`

Example

Query

mutation renterdAbortMultipartUpload($req: MultipartAbortRequestInput!) {
  renterdAbortMultipartUpload(req: $req)
}

Variables

{"req": MultipartAbortRequestInput}

Response

{"data": {"renterdAbortMultipartUpload": true}}

Mutations

`renterdAcquireContract`

Response

Returns a ContractAcquireResponse!

Arguments

Name	Description
`id` - `FileContractID!`
`req` - `ContractAcquireRequestInput!`

Example

Query

mutation renterdAcquireContract(
  $id: FileContractID!,
  $req: ContractAcquireRequestInput!
) {
  renterdAcquireContract(
    id: $id,
    req: $req
  ) {
    lockID
  }
}

Variables

{
  "id": FileContractID,
  "req": ContractAcquireRequestInput
}

Response

{"data": {"renterdAcquireContract": {"lockID": 123}}}

Mutations

`renterdAddContract`

Response

Returns a ContractMetadata!

Arguments

Name	Description
`id` - `FileContractID!`
`req` - `ContractAddRequestInput!`

Example

Query

mutation renterdAddContract(
  $id: FileContractID!,
  $req: ContractAddRequestInput!
) {
  renterdAddContract(
    id: $id,
    req: $req
  ) {
    id
    hostIP
    hostKey
    siamuxAddr
    proofHeight
    revisionHeight
    revisionNumber
    size
    startHeight
    state
    windowStart
    windowEnd
    contractPrice
    renewedFrom
    spending {
      ...ContractSpendingFragment
    }
    totalCost
    contractSets
  }
}

Variables

{
  "id": FileContractID,
  "req": ContractAddRequestInput
}

Response

{
  "data": {
    "renterdAddContract": {
      "id": FileContractID,
      "hostIP": "abc123",
      "hostKey": PublicKey,
      "siamuxAddr": "xyz789",
      "proofHeight": 987,
      "revisionHeight": 123,
      "revisionNumber": RevisionNumber,
      "size": 123,
      "startHeight": 123,
      "state": "xyz789",
      "windowStart": 123,
      "windowEnd": 123,
      "contractPrice": "USD",
      "renewedFrom": FileContractID,
      "spending": ContractSpending,
      "totalCost": "USD",
      "contractSets": ["xyz789"]
    }
  }
}

Mutations

`renterdAddMultipartPart`

Response

Returns a Boolean!

Arguments

Name	Description
`req` - `MultipartAddPartRequestInput!`

Example

Query

mutation renterdAddMultipartPart($req: MultipartAddPartRequestInput!) {
  renterdAddMultipartPart(req: $req)
}

Variables

{"req": MultipartAddPartRequestInput}

Response

{"data": {"renterdAddMultipartPart": false}}

Mutations

`renterdAddObject`

Response

Returns a Boolean!

Arguments

Name	Description
`path` - `String!`
`req` - `AddObjectRequestInput!`

Example

Query

mutation renterdAddObject(
  $path: String!,
  $req: AddObjectRequestInput!
) {
  renterdAddObject(
    path: $path,
    req: $req
  )
}

Variables

{
  "path": "abc123",
  "req": AddObjectRequestInput
}

Response

{"data": {"renterdAddObject": true}}

Mutations

`renterdAddRenewedContract`

Response

Returns a ContractMetadata!

Arguments

Name	Description
`id` - `FileContractID!`
`req` - `ContractRenewedRequestInput!`

Example

Query

mutation renterdAddRenewedContract(
  $id: FileContractID!,
  $req: ContractRenewedRequestInput!
) {
  renterdAddRenewedContract(
    id: $id,
    req: $req
  ) {
    id
    hostIP
    hostKey
    siamuxAddr
    proofHeight
    revisionHeight
    revisionNumber
    size
    startHeight
    state
    windowStart
    windowEnd
    contractPrice
    renewedFrom
    spending {
      ...ContractSpendingFragment
    }
    totalCost
    contractSets
  }
}

Variables

{
  "id": FileContractID,
  "req": ContractRenewedRequestInput
}

Response

{
  "data": {
    "renterdAddRenewedContract": {
      "id": FileContractID,
      "hostIP": "xyz789",
      "hostKey": PublicKey,
      "siamuxAddr": "abc123",
      "proofHeight": 987,
      "revisionHeight": 123,
      "revisionNumber": RevisionNumber,
      "size": 987,
      "startHeight": 987,
      "state": "abc123",
      "windowStart": 123,
      "windowEnd": 123,
      "contractPrice": "USD",
      "renewedFrom": FileContractID,
      "spending": ContractSpending,
      "totalCost": "USD",
      "contractSets": ["abc123"]
    }
  }
}

Mutations

`renterdAddSlabsPartial`

Response

Returns an AddPartialSlabResponse!

Arguments

Name	Description
`data` - `String!`
`minShards` - `Int!`
`totalShards` - `Int!`
`contractSet` - `String!`

Example

Query

mutation renterdAddSlabsPartial(
  $data: String!,
  $minShards: Int!,
  $totalShards: Int!,
  $contractSet: String!
) {
  renterdAddSlabsPartial(
    data: $data,
    minShards: $minShards,
    totalShards: $totalShards,
    contractSet: $contractSet
  ) {
    slabBufferMaxSizeSoftReached
    slabs {
      ...SlabSliceFragment
    }
  }
}

Variables

{
  "data": "abc123",
  "minShards": 123,
  "totalShards": 987,
  "contractSet": "xyz789"
}

Response

{
  "data": {
    "renterdAddSlabsPartial": {
      "slabBufferMaxSizeSoftReached": false,
      "slabs": [SlabSlice]
    }
  }
}

Mutations

`renterdArchiveContracts`

Response

Returns a Boolean!

Arguments

Name	Description
`req` - `ContractsArchiveRequestInput!`

Example

Query

mutation renterdArchiveContracts($req: ContractsArchiveRequestInput!) {
  renterdArchiveContracts(req: $req)
}

Variables

{"req": ContractsArchiveRequestInput}

Response

{"data": {"renterdArchiveContracts": true}}

Mutations

`renterdBroadcastAction`

Response

Returns a Boolean!

Arguments

Name	Description
`event` - `WebhookEventInput!`

Example

Query

mutation renterdBroadcastAction($event: WebhookEventInput!) {
  renterdBroadcastAction(event: $event)
}

Variables

{"event": WebhookEventInput}

Response

{"data": {"renterdBroadcastAction": true}}

Mutations

`renterdCompleteMultipartUpload`

Response

Returns a MultipartCompleteResponse!

Arguments

Name	Description
`req` - `MultipartCompleteRequestInput!`

Example

Query

mutation renterdCompleteMultipartUpload($req: MultipartCompleteRequestInput!) {
  renterdCompleteMultipartUpload(req: $req) {
    eTag
  }
}

Variables

{"req": MultipartCompleteRequestInput}

Response

{
  "data": {
    "renterdCompleteMultipartUpload": {"eTag": ETag}
  }
}

Mutations

`renterdConsensusAcceptBlock`

Response

Returns a Boolean!

Arguments

Name	Description
`block` - `BlockInput!`

Example

Query

mutation renterdConsensusAcceptBlock($block: BlockInput!) {
  renterdConsensusAcceptBlock(block: $block)
}

Variables

{"block": BlockInput}

Response

{"data": {"renterdConsensusAcceptBlock": true}}

Mutations

`renterdContractBroadcast`

Response

Returns a TransactionID!

Arguments

Name	Description
`id` - `FileContractID!`

Example

Query

mutation renterdContractBroadcast($id: FileContractID!) {
  renterdContractBroadcast(id: $id)
}

Variables

{"id": FileContractID}

Response

{"data": {"renterdContractBroadcast": TransactionID}}

Mutations

`renterdCopyObject`

Response

Returns an ObjectMetadata!

Arguments

Name	Description
`req` - `CopyObjectsRequestInput!`

Example

Query

mutation renterdCopyObject($req: CopyObjectsRequestInput!) {
  renterdCopyObject(req: $req) {
    eTag
    health
    modTime
    name
    size
    mimeType
  }
}

Variables

{"req": CopyObjectsRequestInput}

Response

{
  "data": {
    "renterdCopyObject": {
      "eTag": "xyz789",
      "health": 123.45,
      "modTime": "2007-12-03T10:15:30Z",
      "name": "abc123",
      "size": 123,
      "mimeType": "abc123"
    }
  }
}

Mutations

`renterdCreateBucket`

Response

Returns a Boolean!

Arguments

Name	Description
`req` - `BucketCreateRequestInput!`

Example

Query

mutation renterdCreateBucket($req: BucketCreateRequestInput!) {
  renterdCreateBucket(req: $req)
}

Variables

{"req": BucketCreateRequestInput}

Response

{"data": {"renterdCreateBucket": true}}

Mutations

`renterdCreateMultipartUpload`

Response

Returns a MultipartCreateResponse!

Arguments

Name	Description
`req` - `MultipartCreateRequestInput!`

Example

Query

mutation renterdCreateMultipartUpload($req: MultipartCreateRequestInput!) {
  renterdCreateMultipartUpload(req: $req) {
    uploadID
  }
}

Variables

{"req": MultipartCreateRequestInput}

Response

{
  "data": {
    "renterdCreateMultipartUpload": {
      "uploadID": "abc123"
    }
  }
}

Mutations

`renterdDeleteBucket`

Response

Returns a Boolean!

Arguments

Name	Description
`name` - `String!`

Example

Query

mutation renterdDeleteBucket($name: String!) {
  renterdDeleteBucket(name: $name)
}

Variables

{"name": "abc123"}

Response

{"data": {"renterdDeleteBucket": true}}

Mutations

`renterdDeleteContract`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `FileContractID!`

Example

Query

mutation renterdDeleteContract($id: FileContractID!) {
  renterdDeleteContract(id: $id)
}

Variables

{"id": FileContractID}

Response

{"data": {"renterdDeleteContract": false}}

Mutations

`renterdDeleteContractSet`

Response

Returns a Boolean!

Arguments

Name	Description
`setName` - `String!`

Example

Query

mutation renterdDeleteContractSet($setName: String!) {
  renterdDeleteContractSet(setName: $setName)
}

Variables

{"setName": "xyz789"}

Response

{"data": {"renterdDeleteContractSet": true}}

Mutations

`renterdDeleteContractsAll`

Response

Returns a Boolean!

Example

Query

mutation renterdDeleteContractsAll {
  renterdDeleteContractsAll
}

Response

{"data": {"renterdDeleteContractsAll": true}}

Mutations

`renterdDeleteHostSector`

Response

Returns an Int!

Arguments

Name	Description
`hostKey` - `PublicKey!`

Example

Query

mutation renterdDeleteHostSector($hostKey: PublicKey!) {
  renterdDeleteHostSector(hostKey: $hostKey)
}

Variables

{"hostKey": PublicKey}

Response

{"data": {"renterdDeleteHostSector": 123}}

Mutations

`renterdDeleteMetric`

Response

Returns a Boolean!

Arguments

Name	Description
`key` - `String!`
`cutoff` - `String!`

Example

Query

mutation renterdDeleteMetric(
  $key: String!,
  $cutoff: String!
) {
  renterdDeleteMetric(
    key: $key,
    cutoff: $cutoff
  )
}

Variables

{
  "key": "abc123",
  "cutoff": "xyz789"
}

Response

{"data": {"renterdDeleteMetric": true}}

Mutations

`renterdDeleteObject`

Response

Returns a Boolean!

Arguments

Name	Description
`path` - `String!`
`bucket` - `String`	Default = `null`
`batch` - `Boolean!`	Default = `false`

Example

Query

mutation renterdDeleteObject(
  $path: String!,
  $bucket: String,
  $batch: Boolean!
) {
  renterdDeleteObject(
    path: $path,
    bucket: $bucket,
    batch: $batch
  )
}

Variables

{
  "path": "xyz789",
  "bucket": null,
  "batch": false
}

Response

{"data": {"renterdDeleteObject": false}}

Mutations

`renterdDeleteSetting`

Response

Returns a Boolean!

Arguments

Name	Description
`key` - `String!`

Example

Query

mutation renterdDeleteSetting($key: String!) {
  renterdDeleteSetting(key: $key)
}

Variables

{"key": "abc123"}

Response

{"data": {"renterdDeleteSetting": true}}

Mutations

`renterdDeleteWebhook`

Response

Returns a Boolean!

Arguments

Name	Description
`webhook` - `WebhookInput!`

Example

Query

mutation renterdDeleteWebhook($webhook: WebhookInput!) {
  renterdDeleteWebhook(webhook: $webhook)
}

Variables

{"webhook": WebhookInput}

Response

{"data": {"renterdDeleteWebhook": false}}

Mutations

`renterdDismissAlerts`

Response

Returns a Boolean!

Arguments

Name	Description
`ids` - `[Hash256!]!`

Example

Query

mutation renterdDismissAlerts($ids: [Hash256!]!) {
  renterdDismissAlerts(ids: $ids)
}

Variables

{"ids": [Hash256]}

Response

{"data": {"renterdDismissAlerts": true}}

Mutations

`renterdEvaluateAutopilotConfig`

Response

Returns a ConfigEvaluationResponse!

Arguments

Name	Description
`req` - `ConfigEvaluationRequestInput!`

Example

Query

mutation renterdEvaluateAutopilotConfig($req: ConfigEvaluationRequestInput!) {
  renterdEvaluateAutopilotConfig(req: $req) {
    hosts
    usable
    unusable {
      ...ConfigEvaluationUnusableFragment
    }
    recommendation {
      ...ConfigRecommendationFragment
    }
  }
}

Variables

{"req": ConfigEvaluationRequestInput}

Response

{
  "data": {
    "renterdEvaluateAutopilotConfig": {
      "hosts": 123,
      "usable": 123,
      "unusable": ConfigEvaluationUnusable,
      "recommendation": ConfigRecommendation
    }
  }
}

Mutations

`renterdFetchPackedSlabs`

Response

Returns [PackedSlab!]!

Arguments

Name	Description
`req` - `PackedSlabsRequestGETInput!`

Example

Query

mutation renterdFetchPackedSlabs($req: PackedSlabsRequestGETInput!) {
  renterdFetchPackedSlabs(req: $req) {
    bufferID
    shards {
      ...SectorFragment
    }
  }
}

Variables

{"req": PackedSlabsRequestGETInput}

Response

{
  "data": {
    "renterdFetchPackedSlabs": [
      {"bufferID": 987, "shards": [Sector]}
    ]
  }
}

Mutations

`renterdFormContract`

Response

Returns a ContractMetadata!

Arguments

Name	Description
`req` - `ContractFormRequestInput!`

Example

Query

mutation renterdFormContract($req: ContractFormRequestInput!) {
  renterdFormContract(req: $req) {
    id
    hostIP
    hostKey
    siamuxAddr
    proofHeight
    revisionHeight
    revisionNumber
    size
    startHeight
    state
    windowStart
    windowEnd
    contractPrice
    renewedFrom
    spending {
      ...ContractSpendingFragment
    }
    totalCost
    contractSets
  }
}

Variables

{"req": ContractFormRequestInput}

Response

{
  "data": {
    "renterdFormContract": {
      "id": FileContractID,
      "hostIP": "xyz789",
      "hostKey": PublicKey,
      "siamuxAddr": "xyz789",
      "proofHeight": 123,
      "revisionHeight": 123,
      "revisionNumber": RevisionNumber,
      "size": 987,
      "startHeight": 987,
      "state": "abc123",
      "windowStart": 123,
      "windowEnd": 987,
      "contractPrice": "USD",
      "renewedFrom": FileContractID,
      "spending": ContractSpending,
      "totalCost": "USD",
      "contractSets": ["abc123"]
    }
  }
}

Mutations

`renterdFundAccount`

Response

Returns an AccountsFundResponse!

Arguments

Name	Description
`req` - `AccountsFundRequestInput!`

Example

Query

mutation renterdFundAccount($req: AccountsFundRequestInput!) {
  renterdFundAccount(req: $req) {
    deposit
  }
}

Variables

{"req": AccountsFundRequestInput}

Response

{
  "data": {
    "renterdFundAccount": {"deposit": "USD"}
  }
}

Mutations

`renterdHeadObject`

Response

Returns a HeadObjectResponse!

Arguments

Name	Description
`bucket` - `String!`
`path` - `String!`
`opts` - `HeadObjectOptionsInput!`

Example

Query

mutation renterdHeadObject(
  $bucket: String!,
  $path: String!,
  $opts: HeadObjectOptionsInput!
) {
  renterdHeadObject(
    bucket: $bucket,
    path: $path,
    opts: $opts
  ) {
    contentType
    etag
    lastModified
    range {
      ...ContentRangeFragment
    }
    size
    metadata
  }
}

Variables

{
  "bucket": "abc123",
  "path": "xyz789",
  "opts": HeadObjectOptionsInput
}

Response

{
  "data": {
    "renterdHeadObject": {
      "contentType": "xyz789",
      "etag": "xyz789",
      "lastModified": "2007-12-03T10:15:30Z",
      "range": ContentRange,
      "size": 123,
      "metadata": {}
    }
  }
}

Mutations

`renterdHostsRemove`

Response

Returns an Int!

Arguments

Name	Description
`req` - `HostsRemoveRequestInput!`

Example

Query

mutation renterdHostsRemove($req: HostsRemoveRequestInput!) {
  renterdHostsRemove(req: $req)
}

Variables

{"req": HostsRemoveRequestInput}

Response

{"data": {"renterdHostsRemove": 987}}

Mutations

`renterdHostsResetLostSectors`

Response

Returns a Boolean!

Arguments

Name	Description
`hostkey` - `PublicKey!`

Example

Query

mutation renterdHostsResetLostSectors($hostkey: PublicKey!) {
  renterdHostsResetLostSectors(hostkey: $hostkey)
}

Variables

{"hostkey": PublicKey}

Response

{"data": {"renterdHostsResetLostSectors": false}}

Mutations

`renterdKeepaliveContract`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `FileContractID!`
`req` - `ContractKeepaliveRequestInput!`

Example

Query

mutation renterdKeepaliveContract(
  $id: FileContractID!,
  $req: ContractKeepaliveRequestInput!
) {
  renterdKeepaliveContract(
    id: $id,
    req: $req
  )
}

Variables

{
  "id": FileContractID,
  "req": ContractKeepaliveRequestInput
}

Response

{"data": {"renterdKeepaliveContract": true}}

Mutations

`renterdListObjects`

Response

Returns an ObjectsListResponse!

Arguments

Name	Description
`req` - `ObjectsListRequestInput!`

Example

Query

mutation renterdListObjects($req: ObjectsListRequestInput!) {
  renterdListObjects(req: $req) {
    hasMore
    nextMarker
    objects {
      ...ObjectMetadataFragment
    }
  }
}

Variables

{"req": ObjectsListRequestInput}

Response

{
  "data": {
    "renterdListObjects": {
      "hasMore": true,
      "nextMarker": "abc123",
      "objects": [ObjectMetadata]
    }
  }
}

Mutations

`renterdMarkPackedSlabsUploaded`

Response

Returns a Boolean!

Arguments

Name	Description
`req` - `PackedSlabsRequestPOSTInput!`

Example

Query

mutation renterdMarkPackedSlabsUploaded($req: PackedSlabsRequestPOSTInput!) {
  renterdMarkPackedSlabsUploaded(req: $req)
}

Variables

{"req": PackedSlabsRequestPOSTInput}

Response

{"data": {"renterdMarkPackedSlabsUploaded": true}}

Mutations

`renterdMigrateSlab`

Response

Returns a MigrateSlabResponse!

Arguments

Name	Description
`slab` - `SlabInput!`

Example

Query

mutation renterdMigrateSlab($slab: SlabInput!) {
  renterdMigrateSlab(slab: $slab) {
    numShardsMigrated
    surchargeApplied
    error
  }
}

Variables

{"slab": SlabInput}

Response

{
  "data": {
    "renterdMigrateSlab": {
      "numShardsMigrated": 123,
      "surchargeApplied": false,
      "error": "xyz789"
    }
  }
}

Mutations

`renterdMultipartAbort`

Response

Returns a Boolean!

Arguments

Name	Description
`req` - `MultipartAbortRequestInput!`

Example

Query

mutation renterdMultipartAbort($req: MultipartAbortRequestInput!) {
  renterdMultipartAbort(req: $req)
}

Variables

{"req": MultipartAbortRequestInput}

Response

{"data": {"renterdMultipartAbort": false}}

Mutations

`renterdMultipartComplete`

Response

Returns a MultipartCompleteResponse!

Arguments

Name	Description
`req` - `MultipartCompleteRequestInput!`

Example

Query

mutation renterdMultipartComplete($req: MultipartCompleteRequestInput!) {
  renterdMultipartComplete(req: $req) {
    eTag
  }
}

Variables

{"req": MultipartCompleteRequestInput}

Response

{"data": {"renterdMultipartComplete": {"eTag": ETag}}}

Mutations

`renterdMultipartCreate`

Response

Returns a MultipartCreateResponse!

Arguments

Name	Description
`req` - `MultipartCreateRequestInput!`

Example

Query

mutation renterdMultipartCreate($req: MultipartCreateRequestInput!) {
  renterdMultipartCreate(req: $req) {
    uploadID
  }
}

Variables

{"req": MultipartCreateRequestInput}

Response

{
  "data": {
    "renterdMultipartCreate": {
      "uploadID": "xyz789"
    }
  }
}

Mutations

`renterdMultipartUpload`

Response

Returns a Boolean!

Arguments

Name	Description
`path` - `String!`
`req` - `MultipartAddPartRequestInput!`

Example

Query

mutation renterdMultipartUpload(
  $path: String!,
  $req: MultipartAddPartRequestInput!
) {
  renterdMultipartUpload(
    path: $path,
    req: $req
  )
}

Variables

{
  "path": "xyz789",
  "req": MultipartAddPartRequestInput
}

Response

{"data": {"renterdMultipartUpload": false}}

Mutations

`renterdPruneContract`

Response

Returns a ContractPruneResponse!

Arguments

Name	Description
`id` - `FileContractID!`
`req` - `ContractPruneRequestInput!`

Example

Query

mutation renterdPruneContract(
  $id: FileContractID!,
  $req: ContractPruneRequestInput!
) {
  renterdPruneContract(
    id: $id,
    req: $req
  ) {
    size
    pruned
    remaining
    error
  }
}

Variables

{
  "id": FileContractID,
  "req": ContractPruneRequestInput
}

Response

{
  "data": {
    "renterdPruneContract": {
      "size": 123,
      "pruned": 987,
      "remaining": 123,
      "error": "xyz789"
    }
  }
}

Mutations

`renterdRecordContractSpending`

Response

Returns a Boolean!

Arguments

Name	Description
`records` - `[ContractSpendingRecordInput!]!`

Example

Query

mutation renterdRecordContractSpending($records: [ContractSpendingRecordInput!]!) {
  renterdRecordContractSpending(records: $records)
}

Variables

{"records": [ContractSpendingRecordInput]}

Response

{"data": {"renterdRecordContractSpending": true}}

Mutations

`renterdRecordHostsScan`

Response

Returns a Boolean!

Arguments

Name	Description
`req` - `HostsScanRequestInput!`

Example

Query

mutation renterdRecordHostsScan($req: HostsScanRequestInput!) {
  renterdRecordHostsScan(req: $req)
}

Variables

{"req": HostsScanRequestInput}

Response

{"data": {"renterdRecordHostsScan": true}}

Mutations

`renterdRecordPriceTables`

Response

Returns a Boolean!

Arguments

Name	Description
`req` - `HostsPriceTablesRequestInput!`

Example

Query

mutation renterdRecordPriceTables($req: HostsPriceTablesRequestInput!) {
  renterdRecordPriceTables(req: $req)
}

Variables

{"req": HostsPriceTablesRequestInput}

Response

{"data": {"renterdRecordPriceTables": true}}

Mutations

`renterdRefreshHealth`

Response

Returns a Boolean!

Example

Query

mutation renterdRefreshHealth {
  renterdRefreshHealth
}

Response

{"data": {"renterdRefreshHealth": false}}

Mutations

`renterdRegisterAlert`

Response

Returns a Boolean!

Arguments

Name	Description
`alert` - `AlertInput!`

Example

Query

mutation renterdRegisterAlert($alert: AlertInput!) {
  renterdRegisterAlert(alert: $alert)
}

Variables

{"alert": AlertInput}

Response

{"data": {"renterdRegisterAlert": false}}

Mutations

`renterdRegisterWebhook`

Response

Returns a Boolean!

Arguments

Name	Description
`webhook` - `WebhookInput!`

Example

Query

mutation renterdRegisterWebhook($webhook: WebhookInput!) {
  renterdRegisterWebhook(webhook: $webhook)
}

Variables

{"webhook": WebhookInput}

Response

{"data": {"renterdRegisterWebhook": false}}

Mutations

`renterdRegisterWorkerEvent`

Response

Returns a Boolean!

Arguments

Name	Description
`event` - `WebhookEventInput!`

Example

Query

mutation renterdRegisterWorkerEvent($event: WebhookEventInput!) {
  renterdRegisterWorkerEvent(event: $event)
}

Variables

{"event": WebhookEventInput}

Response

{"data": {"renterdRegisterWorkerEvent": false}}

Mutations

`renterdReleaseContract`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `FileContractID!`
`lockId` - `Int!`

Example

Query

mutation renterdReleaseContract(
  $id: FileContractID!,
  $lockId: Int!
) {
  renterdReleaseContract(
    id: $id,
    lockId: $lockId
  )
}

Variables

{"id": FileContractID, "lockId": 987}

Response

{"data": {"renterdReleaseContract": true}}

Mutations

`renterdRenameObject`

Response

Returns a Boolean!

Arguments

Name	Description
`req` - `ObjectsRenameRequestInput!`

Example

Query

mutation renterdRenameObject($req: ObjectsRenameRequestInput!) {
  renterdRenameObject(req: $req)
}

Variables

{"req": ObjectsRenameRequestInput}

Response

{"data": {"renterdRenameObject": true}}

Mutations

`renterdRenewContract`

Response

Returns a ContractMetadata!

Arguments

Name	Description
`id` - `FileContractID!`
`req` - `ContractRenewRequestInput!`

Example

Query

mutation renterdRenewContract(
  $id: FileContractID!,
  $req: ContractRenewRequestInput!
) {
  renterdRenewContract(
    id: $id,
    req: $req
  ) {
    id
    hostIP
    hostKey
    siamuxAddr
    proofHeight
    revisionHeight
    revisionNumber
    size
    startHeight
    state
    windowStart
    windowEnd
    contractPrice
    renewedFrom
    spending {
      ...ContractSpendingFragment
    }
    totalCost
    contractSets
  }
}

Variables

{
  "id": FileContractID,
  "req": ContractRenewRequestInput
}

Response

{
  "data": {
    "renterdRenewContract": {
      "id": FileContractID,
      "hostIP": "abc123",
      "hostKey": PublicKey,
      "siamuxAddr": "xyz789",
      "proofHeight": 123,
      "revisionHeight": 123,
      "revisionNumber": RevisionNumber,
      "size": 123,
      "startHeight": 123,
      "state": "abc123",
      "windowStart": 123,
      "windowEnd": 987,
      "contractPrice": "USD",
      "renewedFrom": FileContractID,
      "spending": ContractSpending,
      "totalCost": "USD",
      "contractSets": ["abc123"]
    }
  }
}

Mutations

`renterdResetAccountDrift`

Response

Returns a Boolean!

Arguments

Name	Description
`accountId` - `String!`

Example

Query

mutation renterdResetAccountDrift($accountId: String!) {
  renterdResetAccountDrift(accountId: $accountId)
}

Variables

{"accountId": "abc123"}

Response

{"data": {"renterdResetAccountDrift": true}}

Mutations

`renterdRhpPriceTable`

Response

Returns a HostPriceTable!

Arguments

Name	Description
`req` - `RHPPriceTableRequestInput!`

Example

Query

mutation renterdRhpPriceTable($req: RHPPriceTableRequestInput!) {
  renterdRhpPriceTable(req: $req) {
    uid
    validity
    hostblockheight
    updatepricetablecost
    accountbalancecost
    fundaccountcost
    latestrevisioncost
    subscriptionmemorycost
    subscriptionnotificationcost
    initbasecost
    memorytimecost
    downloadbandwidthcost
    uploadbandwidthcost
    dropsectorsbasecost
    dropsectorsunitcost
    hassectorbasecost
    readbasecost
    readlengthcost
    renewcontractcost
    revisionbasecost
    swapsectorcost
    writebasecost
    writelengthcost
    writestorecost
    txnfeeminrecommended
    txnfeemaxrecommended
    contractprice
    collateralcost
    maxcollateral
    maxduration
    windowsize
    registryentriesleft
    registryentriestotal
    expiry
  }
}

Variables

{"req": RHPPriceTableRequestInput}

Response

{
  "data": {
    "renterdRhpPriceTable": {
      "uid": SettingsID,
      "validity": "P3Y6M4DT12H30M5S",
      "hostblockheight": 123,
      "updatepricetablecost": "USD",
      "accountbalancecost": "USD",
      "fundaccountcost": "USD",
      "latestrevisioncost": "USD",
      "subscriptionmemorycost": "USD",
      "subscriptionnotificationcost": "USD",
      "initbasecost": "USD",
      "memorytimecost": "USD",
      "downloadbandwidthcost": "USD",
      "uploadbandwidthcost": "USD",
      "dropsectorsbasecost": "USD",
      "dropsectorsunitcost": "USD",
      "hassectorbasecost": "USD",
      "readbasecost": "USD",
      "readlengthcost": "USD",
      "renewcontractcost": "USD",
      "revisionbasecost": "USD",
      "swapsectorcost": "USD",
      "writebasecost": "USD",
      "writelengthcost": "USD",
      "writestorecost": "USD",
      "txnfeeminrecommended": "USD",
      "txnfeemaxrecommended": "USD",
      "contractprice": "USD",
      "collateralcost": "USD",
      "maxcollateral": "USD",
      "maxduration": 123,
      "windowsize": 987,
      "registryentriesleft": 123,
      "registryentriestotal": 987,
      "expiry": "2007-12-03T10:15:30Z"
    }
  }
}

Mutations

`renterdRhpScan`

Response

Returns an RHPScanResponse!

Arguments

Name	Description
`req` - `RHPScanRequestInput!`

Example

Query

mutation renterdRhpScan($req: RHPScanRequestInput!) {
  renterdRhpScan(req: $req) {
    ping
    scanError
    settings {
      ...HostV2SettingsFragment
    }
    priceTable {
      ...HostPriceTableFragment
    }
  }
}

Variables

{"req": RHPScanRequestInput}

Response

{
  "data": {
    "renterdRhpScan": {
      "ping": DurationMS,
      "scanError": "abc123",
      "settings": HostV2Settings,
      "priceTable": HostPriceTable
    }
  }
}

Mutations

`renterdSaveAccounts`

Response

Returns a Boolean!

Arguments

Name	Description
`req` - `AccountsSaveRequestInput!`

Example

Query

mutation renterdSaveAccounts($req: AccountsSaveRequestInput!) {
  renterdSaveAccounts(req: $req)
}

Variables

{"req": AccountsSaveRequestInput}

Response

{"data": {"renterdSaveAccounts": false}}

Mutations

`renterdSlabsMigration`

Response

Returns an UnhealthySlabsResponse!

Arguments

Name	Description
`req` - `MigrationSlabsRequestInput!`

Example

Query

mutation renterdSlabsMigration($req: MigrationSlabsRequestInput!) {
  renterdSlabsMigration(req: $req) {
    slabs {
      ...UnhealthySlabFragment
    }
  }
}

Variables

{"req": MigrationSlabsRequestInput}

Response

{
  "data": {
    "renterdSlabsMigration": {"slabs": [UnhealthySlab]}
  }
}

Mutations

`renterdSyncConnect`

Response

Returns a Boolean!

Arguments

Name	Description
`addr` - `String!`

Example

Query

mutation renterdSyncConnect($addr: String!) {
  renterdSyncConnect(addr: $addr)
}

Variables

{"addr": "xyz789"}

Response

{"data": {"renterdSyncConnect": true}}

Mutations

`renterdTriggerAutopilot`

Response

Returns an AutopilotTriggerResponse!

Arguments

Name	Description
`req` - `AutopilotTriggerRequestInput!`

Example

Query

mutation renterdTriggerAutopilot($req: AutopilotTriggerRequestInput!) {
  renterdTriggerAutopilot(req: $req) {
    triggered
  }
}

Variables

{"req": AutopilotTriggerRequestInput}

Response

{"data": {"renterdTriggerAutopilot": {"triggered": true}}}

Mutations

`renterdTxpoolBroadcast`

Response

Returns a Boolean!

Arguments

Name	Description
`transactions` - `[TransactionInput!]!`

Example

Query

mutation renterdTxpoolBroadcast($transactions: [TransactionInput!]!) {
  renterdTxpoolBroadcast(transactions: $transactions)
}

Variables

{"transactions": [TransactionInput]}

Response

{"data": {"renterdTxpoolBroadcast": true}}

Mutations

`renterdUpdateAutopilot`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `String!`
`autopilot` - `AutopilotInput!`

Example

Query

mutation renterdUpdateAutopilot(
  $id: String!,
  $autopilot: AutopilotInput!
) {
  renterdUpdateAutopilot(
    id: $id,
    autopilot: $autopilot
  )
}

Variables

{
  "id": "abc123",
  "autopilot": AutopilotInput
}

Response

{"data": {"renterdUpdateAutopilot": true}}

Mutations

`renterdUpdateAutopilotConfig`

Response

Returns a Boolean!

Arguments

Name	Description
`config` - `AutopilotConfigInput!`

Example

Query

mutation renterdUpdateAutopilotConfig($config: AutopilotConfigInput!) {
  renterdUpdateAutopilotConfig(config: $config)
}

Variables

{"config": AutopilotConfigInput}

Response

{"data": {"renterdUpdateAutopilotConfig": false}}

Mutations

`renterdUpdateAutopilotHostCheck`

Response

Returns a Boolean!

Arguments

Name	Description
`autopilotId` - `String!`
`hostKey` - `PublicKey!`
`check` - `HostCheckInput!`

Example

Query

mutation renterdUpdateAutopilotHostCheck(
  $autopilotId: String!,
  $hostKey: PublicKey!,
  $check: HostCheckInput!
) {
  renterdUpdateAutopilotHostCheck(
    autopilotId: $autopilotId,
    hostKey: $hostKey,
    check: $check
  )
}

Variables

{
  "autopilotId": "abc123",
  "hostKey": PublicKey,
  "check": HostCheckInput
}

Response

{"data": {"renterdUpdateAutopilotHostCheck": false}}

Mutations

`renterdUpdateBucketPolicy`

Response

Returns a Boolean!

Arguments

Name	Description
`name` - `String!`
`policy` - `BucketPolicyInput!`

Example

Query

mutation renterdUpdateBucketPolicy(
  $name: String!,
  $policy: BucketPolicyInput!
) {
  renterdUpdateBucketPolicy(
    name: $name,
    policy: $policy
  )
}

Variables

{
  "name": "abc123",
  "policy": BucketPolicyInput
}

Response

{"data": {"renterdUpdateBucketPolicy": false}}

Mutations

`renterdUpdateContractSet`

Response

Returns a Boolean!

Arguments

Name	Description
`setName` - `String!`
`req` - `ContractSetUpdateRequestInput!`

Example

Query

mutation renterdUpdateContractSet(
  $setName: String!,
  $req: ContractSetUpdateRequestInput!
) {
  renterdUpdateContractSet(
    setName: $setName,
    req: $req
  )
}

Variables

{
  "setName": "abc123",
  "req": ContractSetUpdateRequestInput
}

Response

{"data": {"renterdUpdateContractSet": true}}

Mutations

`renterdUpdateHostsAllowlist`

Response

Returns a Boolean!

Arguments

Name	Description
`req` - `UpdateAllowlistRequestInput!`

Example

Query

mutation renterdUpdateHostsAllowlist($req: UpdateAllowlistRequestInput!) {
  renterdUpdateHostsAllowlist(req: $req)
}

Variables

{"req": UpdateAllowlistRequestInput}

Response

{"data": {"renterdUpdateHostsAllowlist": true}}

Mutations

`renterdUpdateHostsBlocklist`

Response

Returns a Boolean!

Arguments

Name	Description
`req` - `UpdateBlocklistRequestInput!`

Example

Query

mutation renterdUpdateHostsBlocklist($req: UpdateBlocklistRequestInput!) {
  renterdUpdateHostsBlocklist(req: $req)
}

Variables

{"req": UpdateBlocklistRequestInput}

Response

{"data": {"renterdUpdateHostsBlocklist": true}}

Mutations

`renterdUpdateMetric`

Response

Returns a Boolean!

Arguments

Name	Description
`key` - `String!`
`data` - `JSON!`

Example

Query

mutation renterdUpdateMetric(
  $key: String!,
  $data: JSON!
) {
  renterdUpdateMetric(
    key: $key,
    data: $data
  )
}

Variables

{"key": "xyz789", "data": {}}

Response

{"data": {"renterdUpdateMetric": true}}

Mutations

`renterdUpdateSetting`

Response

Returns a Boolean!

Arguments

Name	Description
`key` - `String!`
`value` - `String!`

Example

Query

mutation renterdUpdateSetting(
  $key: String!,
  $value: String!
) {
  renterdUpdateSetting(
    key: $key,
    value: $value
  )
}

Variables

{
  "key": "abc123",
  "value": "xyz789"
}

Response

{"data": {"renterdUpdateSetting": false}}

Mutations

`renterdUpdateSlab`

Response

Returns a Boolean!

Arguments

Name	Description
`slab` - `SlabInput!`

Example

Query

mutation renterdUpdateSlab($slab: SlabInput!) {
  renterdUpdateSlab(slab: $slab)
}

Variables

{"slab": SlabInput}

Response

{"data": {"renterdUpdateSlab": false}}

Mutations

`renterdUploadAddSector`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `String!`
`req` - `UploadSectorRequestInput!`

Example

Query

mutation renterdUploadAddSector(
  $id: String!,
  $req: UploadSectorRequestInput!
) {
  renterdUploadAddSector(
    id: $id,
    req: $req
  )
}

Variables

{
  "id": "abc123",
  "req": UploadSectorRequestInput
}

Response

{"data": {"renterdUploadAddSector": false}}

Mutations

`renterdUploadFinished`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `String!`

Example

Query

mutation renterdUploadFinished($id: String!) {
  renterdUploadFinished(id: $id)
}

Variables

{"id": "abc123"}

Response

{"data": {"renterdUploadFinished": false}}

Mutations

`renterdUploadObject`

Response

Returns an UploadObjectResponse!

Arguments

Name	Description
`bucket` - `String!`
`path` - `String!`
`data` - `String!`
`options` - `UploadObjectOptionsInput!`

Example

Query

mutation renterdUploadObject(
  $bucket: String!,
  $path: String!,
  $data: String!,
  $options: UploadObjectOptionsInput!
) {
  renterdUploadObject(
    bucket: $bucket,
    path: $path,
    data: $data,
    options: $options
  ) {
    etag
  }
}

Variables

{
  "bucket": "xyz789",
  "path": "abc123",
  "data": "abc123",
  "options": UploadObjectOptionsInput
}

Response

{
  "data": {
    "renterdUploadObject": {
      "etag": "abc123"
    }
  }
}

Mutations

`renterdUploadTrack`

Response

Returns a Boolean!

Arguments

Name	Description
`id` - `String!`

Example

Query

mutation renterdUploadTrack($id: String!) {
  renterdUploadTrack(id: $id)
}

Variables

{"id": "xyz789"}

Response

{"data": {"renterdUploadTrack": true}}

Mutations

`renterdWalletDiscardTransaction`

Response

Returns a Boolean!

Arguments

Name	Description
`transaction` - `TransactionInput!`

Example

Query

mutation renterdWalletDiscardTransaction($transaction: TransactionInput!) {
  renterdWalletDiscardTransaction(transaction: $transaction)
}

Variables

{"transaction": TransactionInput}

Response

{"data": {"renterdWalletDiscardTransaction": true}}

Mutations

`renterdWalletFund`

Response

Returns a WalletFundResponse!

Arguments

Name	Description
`req` - `WalletFundRequestInput!`

Example

Query

mutation renterdWalletFund($req: WalletFundRequestInput!) {
  renterdWalletFund(req: $req) {
    transaction {
      ...TransactionFragment
    }
    toSign
    dependsOn {
      ...TransactionFragment
    }
  }
}

Variables

{"req": WalletFundRequestInput}

Response

{
  "data": {
    "renterdWalletFund": {
      "transaction": Transaction,
      "toSign": [Hash256],
      "dependsOn": [Transaction]
    }
  }
}

Mutations

`renterdWalletRedistribute`

Response

Returns [FileContractID!]!

Arguments

Name	Description
`req` - `WalletRedistributeRequestInput!`

Example

Query

mutation renterdWalletRedistribute($req: WalletRedistributeRequestInput!) {
  renterdWalletRedistribute(req: $req)
}

Variables

{"req": WalletRedistributeRequestInput}

Response

{"data": {"renterdWalletRedistribute": [FileContractID]}}

Mutations

`renterdWalletSendSiacoins`

Response

Returns a TransactionID!

Arguments

Name	Description
`req` - `WalletSendRequestInput!`

Example

Query

mutation renterdWalletSendSiacoins($req: WalletSendRequestInput!) {
  renterdWalletSendSiacoins(req: $req)
}

Variables

{"req": WalletSendRequestInput}

Response

{"data": {"renterdWalletSendSiacoins": TransactionID}}

Mutations

`renterdWalletSignTransaction`

Response

Returns a Transaction!

Arguments

Name	Description
`req` - `WalletSignRequestInput!`

Example

Query

mutation renterdWalletSignTransaction($req: WalletSignRequestInput!) {
  renterdWalletSignTransaction(req: $req) {
    siacoinInputs {
      ...SiacoinInputFragment
    }
    siacoinOutputs {
      ...SiacoinOutputFragment
    }
    fileContracts {
      ...FileContractFragment
    }
    fileContractRevisions {
      ...FileContractRevisionFragment
    }
    storageProofs {
      ...StorageProofFragment
    }
    siafundInputs {
      ...SiafundInputFragment
    }
    siafundOutputs {
      ...SiafundOutputFragment
    }
    minerFees
    arbitraryData
    signatures {
      ...TransactionSignatureFragment
    }
  }
}

Variables

{"req": WalletSignRequestInput}

Response

{
  "data": {
    "renterdWalletSignTransaction": {
      "siacoinInputs": [SiacoinInput],
      "siacoinOutputs": [SiacoinOutput],
      "fileContracts": [FileContract],
      "fileContractRevisions": [FileContractRevision],
      "storageProofs": [StorageProof],
      "siafundInputs": [SiafundInput],
      "siafundOutputs": [SiafundOutput],
      "minerFees": ["USD"],
      "arbitraryData": ["abc123"],
      "signatures": [TransactionSignature]
    }
  }
}

Mutations

`walletdAddWallet`

Response

Returns a Wallet!

Arguments

Name	Description
`wallet` - `WalletUpdateRequestInput!`

Example

Query

mutation walletdAddWallet($wallet: WalletUpdateRequestInput!) {
  walletdAddWallet(wallet: $wallet) {
    id
    name
    description
    dateCreated
    lastUpdated
    metadata
  }
}

Variables

{"wallet": WalletUpdateRequestInput}

Response

{
  "data": {
    "walletdAddWallet": {
      "id": 987,
      "name": "abc123",
      "description": "xyz789",
      "dateCreated": "2007-12-03T10:15:30Z",
      "lastUpdated": "2007-12-03T10:15:30Z",
      "metadata": {}
    }
  }
}

Mutations

`walletdAddWalletAddress`

Response

Returns a Boolean!

Arguments

Name	Description
`walletId` - `String!`
`address` - `Address!`

Example

Query

mutation walletdAddWalletAddress(
  $walletId: String!,
  $address: Address!
) {
  walletdAddWalletAddress(
    walletId: $walletId,
    address: $address
  )
}

Variables

{
  "walletId": "xyz789",
  "address": Address
}

Response

{"data": {"walletdAddWalletAddress": false}}

Mutations

`walletdDeleteWallet`

Response

Returns a Boolean!

Arguments

Name	Description
`walletId` - `String!`

Example

Query

mutation walletdDeleteWallet($walletId: String!) {
  walletdDeleteWallet(walletId: $walletId)
}

Variables

{"walletId": "xyz789"}

Response

{"data": {"walletdDeleteWallet": true}}

Mutations

`walletdFundSiafundTransaction`

Response

Returns a WalletFundResponse!

Arguments

Name	Description
`walletId` - `String!`
`request` - `WalletFundSFRequestInput!`

Example

Query

mutation walletdFundSiafundTransaction(
  $walletId: String!,
  $request: WalletFundSFRequestInput!
) {
  walletdFundSiafundTransaction(
    walletId: $walletId,
    request: $request
  ) {
    transaction {
      ...TransactionFragment
    }
    toSign
    dependsOn {
      ...TransactionFragment
    }
  }
}

Variables

{
  "walletId": "abc123",
  "request": WalletFundSFRequestInput
}

Response

{
  "data": {
    "walletdFundSiafundTransaction": {
      "transaction": Transaction,
      "toSign": [Hash256],
      "dependsOn": [Transaction]
    }
  }
}

Mutations

`walletdFundTransaction`

Response

Returns a WalletFundResponse!

Arguments

Name	Description
`walletId` - `String!`
`request` - `WalletFundRequestInput!`

Example

Query

mutation walletdFundTransaction(
  $walletId: String!,
  $request: WalletFundRequestInput!
) {
  walletdFundTransaction(
    walletId: $walletId,
    request: $request
  ) {
    transaction {
      ...TransactionFragment
    }
    toSign
    dependsOn {
      ...TransactionFragment
    }
  }
}

Variables

{
  "walletId": "abc123",
  "request": WalletFundRequestInput
}

Response

{
  "data": {
    "walletdFundTransaction": {
      "transaction": Transaction,
      "toSign": [Hash256],
      "dependsOn": [Transaction]
    }
  }
}

Mutations

`walletdReleaseOutputs`

Response

Returns a Boolean!

Arguments

Name	Description
`walletId` - `String!`
`request` - `WalletReleaseRequestInput!`

Example

Query

mutation walletdReleaseOutputs(
  $walletId: String!,
  $request: WalletReleaseRequestInput!
) {
  walletdReleaseOutputs(
    walletId: $walletId,
    request: $request
  )
}

Variables

{
  "walletId": "abc123",
  "request": WalletReleaseRequestInput
}

Response

{"data": {"walletdReleaseOutputs": true}}

Mutations

`walletdRemoveWalletAddress`

Response

Returns a Boolean!

Arguments

Name	Description
`walletId` - `String!`
`address` - `String!`

Example

Query

mutation walletdRemoveWalletAddress(
  $walletId: String!,
  $address: String!
) {
  walletdRemoveWalletAddress(
    walletId: $walletId,
    address: $address
  )
}

Variables

{
  "walletId": "xyz789",
  "address": "xyz789"
}

Response

{"data": {"walletdRemoveWalletAddress": false}}

Mutations

`walletdReserveOutputs`

Response

Returns a Boolean!

Arguments

Name	Description
`walletId` - `String!`
`request` - `WalletReserveRequestInput!`

Example

Query

mutation walletdReserveOutputs(
  $walletId: String!,
  $request: WalletReserveRequestInput!
) {
  walletdReserveOutputs(
    walletId: $walletId,
    request: $request
  )
}

Variables

{
  "walletId": "abc123",
  "request": WalletReserveRequestInput
}

Response

{"data": {"walletdReserveOutputs": false}}

Mutations

`walletdStartRescan`

Response

Returns a Boolean!

Arguments

Name	Description
`height` - `Int!`

Example

Query

mutation walletdStartRescan($height: Int!) {
  walletdStartRescan(height: $height)
}

Variables

{"height": 987}

Response

{"data": {"walletdStartRescan": false}}

Mutations

`walletdSyncerBroadcastBlock`

Response

Returns a Boolean!

Arguments

Name	Description
`block` - `BlockInput!`

Example

Query

mutation walletdSyncerBroadcastBlock($block: BlockInput!) {
  walletdSyncerBroadcastBlock(block: $block)
}

Variables

{"block": BlockInput}

Response

{"data": {"walletdSyncerBroadcastBlock": false}}

Mutations

`walletdSyncerConnect`

Response

Returns a Boolean!

Arguments

Name	Description
`addr` - `String!`

Example

Query

mutation walletdSyncerConnect($addr: String!) {
  walletdSyncerConnect(addr: $addr)
}

Variables

{"addr": "abc123"}

Response

{"data": {"walletdSyncerConnect": true}}

Mutations

`walletdTxpoolBroadcast`

Response

Returns a Boolean!

Arguments

Name	Description
`req` - `TxpoolBroadcastRequestInput!`

Example

Query

mutation walletdTxpoolBroadcast($req: TxpoolBroadcastRequestInput!) {
  walletdTxpoolBroadcast(req: $req)
}

Variables

{"req": TxpoolBroadcastRequestInput}

Response

{"data": {"walletdTxpoolBroadcast": true}}

Mutations

`walletdUpdateWallet`

Response

Returns a Wallet!

Arguments

Name	Description
`walletId` - `String!`
`wallet` - `WalletUpdateRequestInput!`

Example

Query

mutation walletdUpdateWallet(
  $walletId: String!,
  $wallet: WalletUpdateRequestInput!
) {
  walletdUpdateWallet(
    walletId: $walletId,
    wallet: $wallet
  ) {
    id
    name
    description
    dateCreated
    lastUpdated
    metadata
  }
}

Variables

{
  "walletId": "abc123",
  "wallet": WalletUpdateRequestInput
}

Response

{
  "data": {
    "walletdUpdateWallet": {
      "id": 123,
      "name": "xyz789",
      "description": "xyz789",
      "dateCreated": "2007-12-03T10:15:30Z",
      "lastUpdated": "2007-12-03T10:15:30Z",
      "metadata": {}
    }
  }
}

Types

Account

Fields

Field Name	Description
`id` - `PublicKey`	The account's ID
`cleanShutdown` - `Boolean`	Whether the account has been cleanly shutdown. If not, the account will require a sync with the host.
`hostKey` - `PublicKey`	The host's public key
`balance` - `Int`	The account's balance as expected by the worker
`drift` - `Int`	The accumulated drift between the worker's expected balance and the host's actual balance. Used to track if a host is trying to cheat the renter over time.
`owner` - `String`	The owner of the account that manages it. This is the id of the worker that maintains the account. \| Min length: 1
`requiresSync` - `Boolean`	Whether the account requires a sync with the host. This is usually the case when the host reports insufficient balance for an account that the worker still believes to be funded.

Example

{
  "id": PublicKey,
  "cleanShutdown": true,
  "hostKey": PublicKey,
  "balance": 123,
  "drift": 123,
  "owner": "abc123",
  "requiresSync": true
}

Types

AccountInput

Fields

Input Field	Description
`id` - `String`	The account's ID. Default = `null`
`cleanShutdown` - `Boolean`	Whether the account has been cleanly shutdown. If not, the account will require a sync with the host. Default = `null`
`hostKey` - `String`	The host's public key. Default = `null`
`balance` - `Int`	The account's balance as expected by the worker. Default = `null`
`drift` - `Int`	The accumulated drift between the worker's expected balance and the host's actual balance. Used to track if a host is trying to cheat the renter over time. Default = `null`
`owner` - `String`	The owner of the account that manages it. This is the id of the worker that maintains the account. \| Min length: 1. Default = `null`
`requiresSync` - `Boolean`	Whether the account requires a sync with the host. This is usually the case when the host reports insufficient balance for an account that the worker still believes to be funded. Default = `null`

Example

{
  "id": "abc123",
  "cleanShutdown": true,
  "hostKey": "abc123",
  "balance": 123,
  "drift": 987,
  "owner": "abc123",
  "requiresSync": false
}

Types

Accounts

Fields

Field Name	Description
`active` - `Int`
`balance` - `Currency`

Example

{"active": 123, "balance": "USD"}

Types

AccountsFundRequestInput

Fields

Input Field	Description
`accountID` - `String`	Unique account ID (rhpv3.Account). Default = `null`
`amount` - `String`	Amount to fund the account with. Default = `null`
`contractID` - `String`	ID of the contract used for funding. Default = `null`

Example

{
  "accountID": "abc123",
  "amount": "xyz789",
  "contractID": "abc123"
}

Types

AccountsFundResponse

Fields

Field Name	Description
`deposit` - `Currency`	Amount deposited

Example

{"deposit": "USD"}

Types

AccountsSaveRequestInput

Fields

Input Field	Description
`accounts` - `[AccountInput!]`	List of accounts to save. Default = `null`

Example

{"accounts": [AccountInput]}

Types

AddObjectRequestInput

Fields

Input Field	Description
`bucket` - `String`
`contractSet` - `String`
`object` - `String`	object.Object. Default = `null`
`eTag` - `String`
`mimeType` - `String`
`metadata` - `String`	ObjectUserMetadata. Default = `null`

Example

{
  "bucket": "abc123",
  "contractSet": "abc123",
  "object": "abc123",
  "eTag": "xyz789",
  "mimeType": "xyz789",
  "metadata": "abc123"
}

Types

AddPartialSlabResponse

Fields

Field Name	Description
`slabBufferMaxSizeSoftReached` - `Boolean`
`slabs` - `[SlabSlice!]`	List of slabs (object.SlabSlice)

Example

{
  "slabBufferMaxSizeSoftReached": true,
  "slabs": [SlabSlice]
}

Types

AddVolumeRequestInput

Fields

Input Field	Description
`localPath` - `String`
`maxSectors` - `Int`

Example

{"localPath": "abc123", "maxSectors": 123}

Types

Address

Description

The hash of a set of UnlockConditions | Pattern: ^[0-9a-fA-F]{64}$

Example

Address

Types

Alert

Fields

Field Name	Description
`id` - `Hash256`	A unique identifier for the alert.
`severity` - `Severity`	The severity of the alert.
`message` - `String`	A human-readable message describing the alert.
`data` - `JSON`	A map of arbitrary data that can be used to provide additional context to the alert.
`timestamp` - `DateTime`

Example

{
  "id": Hash256,
  "severity": "INFO",
  "message": "abc123",
  "data": {},
  "timestamp": "2007-12-03T10:15:30Z"
}

Types

AlertInput

Fields

Input Field	Description
`id` - `String`	A unique identifier for the alert. Default = `null`
`severity` - `Severity`	The severity of the alert. Default = `null`
`message` - `String`	A human-readable message describing the alert. Default = `null`
`data` - `String`	A map of arbitrary data that can be used to provide additional context to the alert. Default = `null`
`timestamp` - `DateTime`

Example

{
  "id": "xyz789",
  "severity": "INFO",
  "message": "xyz789",
  "data": "xyz789",
  "timestamp": "2007-12-03T10:15:30Z"
}

Types

AlertTotals

Fields

Field Name	Description
`info` - `Int`	Number of info alerts
`warning` - `Int`	Number of warning alerts
`error` - `Int`	Number of error alerts
`critical` - `Int`	Number of critical alerts

Example

{"info": 987, "warning": 123, "error": 987, "critical": 123}

Types

AlertsOptsInput

Fields

Input Field	Description
`offset` - `Int`	Offset used in pagination. Default = `null`
`limit` - `Int`	Limit used in pagination. Default = `null`
`severity` - `Severity`	Severity filter (1=info,2=warning,3=error,4=critical). Default = `null`

Example

{"offset": 987, "limit": 987, "severity": "INFO"}

Types

AlertsResponse

Fields

Field Name	Description
`alerts` - `[Alert!]!`	List of alerts
`hasMore` - `Boolean!`	Indicates if more alerts remain
`totals` - `AlertTotals!`	Aggregate counts of alerts by severity

Example

{
  "alerts": [Alert],
  "hasMore": false,
  "totals": AlertTotals
}

Types

Announcement

Fields

Field Name	Description
`index` - `ChainIndex`	Chain index when this announcement was made
`address` - `String`	The host's announced network address

Example

{
  "index": ChainIndex,
  "address": "abc123"
}

Types

ApplyUpdate

Fields

Field Name	Description
`update` - `JSON`	consensus.ApplyUpdate
`state` - `JSON`	consensus.State
`block` - `Block`	types.Block

Example

{"update": {}, "state": {}, "block": Block}

Types

ArchivedContract

Fields

Field Name	Description
`id` - `FileContractID`	The unique identifier for the contract
`hostIP` - `String`	The IP address of the host
`hostKey` - `PublicKey`	The public key of the host
`renewedTo` - `FileContractID`	The ID of the contract this was renewed to
`spending` - `ContractSpending`	Contract spending details
`archivalReason` - `String`	The reason the contract was archived
`contractPrice` - `Currency`	The price of forming the contract
`proofHeight` - `Int`	The height at which the storage proof needs to be submitted
`renewedFrom` - `FileContractID`	The ID of the contract this was renewed from
`revisionHeight` - `Int`	The height of the latest revision
`revisionNumber` - `Int`	The revision number of the contract
`size` - `Int`	The size of the contract in bytes
`startHeight` - `Int`	The height at which the contract was created
`state` - `String`	The state of the contract
`totalCost` - `Currency`	The total cost of the contract
`windowStart` - `Int`	The height at which the proof window starts
`windowEnd` - `Int`	The height at which the proof window ends

Example

{
  "id": FileContractID,
  "hostIP": "xyz789",
  "hostKey": PublicKey,
  "renewedTo": FileContractID,
  "spending": ContractSpending,
  "archivalReason": "xyz789",
  "contractPrice": "USD",
  "proofHeight": 123,
  "renewedFrom": FileContractID,
  "revisionHeight": 123,
  "revisionNumber": 123,
  "size": 123,
  "startHeight": 987,
  "state": "xyz789",
  "totalCost": "USD",
  "windowStart": 123,
  "windowEnd": 987
}

Types

Attestation

Fields

Field Name	Description
`publicKey` - `PublicKey`
`key` - `String`
`value` - `String`
`signature` - `Signature`

Example

{
  "publicKey": PublicKey,
  "key": "abc123",
  "value": "xyz789",
  "signature": Signature
}

Types

AttestationInput

Fields

Input Field	Description
`publicKey` - `String`
`key` - `String`
`value` - `String`
`signature` - `String`

Example

{
  "publicKey": "xyz789",
  "key": "abc123",
  "value": "abc123",
  "signature": "xyz789"
}

Types

Autopilot

Fields

Field Name	Description
`id` - `String`	The identifier of the autopilot
`config` - `AutopilotConfig`	The configuration of the autopilot
`currentPeriod` - `Int`	The current period number

Example

{
  "id": "abc123",
  "config": AutopilotConfig,
  "currentPeriod": 123
}

Types

AutopilotConfig

Fields

Field Name	Description
`contracts` - `ContractsConfig`	Contract configuration settings
`hosts` - `HostsConfig`	Host configuration settings

Example

{
  "contracts": ContractsConfig,
  "hosts": HostsConfig
}

Types

AutopilotConfigInput

Fields

Input Field	Description
`contracts` - `ContractsConfigInput`	Contract configuration settings. Default = `null`
`hosts` - `HostsConfigInput`	Host configuration settings. Default = `null`

Example

{
  "contracts": ContractsConfigInput,
  "hosts": HostsConfigInput
}

Types

AutopilotInput

Fields

Input Field	Description
`id` - `String`	The identifier of the autopilot. Default = `null`
`config` - `AutopilotConfigInput`	The configuration of the autopilot. Default = `null`
`currentPeriod` - `Int`	The current period number. Default = `null`

Example

{
  "id": "xyz789",
  "config": AutopilotConfigInput,
  "currentPeriod": 987
}

Types

AutopilotStateResponse

Fields

Field Name	Description
`version` - `String`	The version of the build
`commit` - `String`	The commit hash of the build
`os` - `String`	The operating system of the build
`buildTime` - `DateTime`	The build time of the build
`configured` - `Boolean`	Indicates whether the autopilot is configured
`migrating` - `Boolean`	Autopilot is currently migrating
`migratingLastStart` - `DateTime`	Last start time for migrating
`pruning` - `Boolean`	Autopilot is currently pruning
`pruningLastStart` - `DateTime`	Last start time for pruning
`scanning` - `Boolean`	Autopilot is currently scanning hosts
`scanningLastStart` - `DateTime`	Last start time for scanning
`uptimeMs` - `Duration`	Autopilot uptime in milliseconds
`startTime` - `DateTime`	Timestamp of autopilot's start time

Example

{
  "version": "abc123",
  "commit": "xyz789",
  "os": "xyz789",
  "buildTime": "2007-12-03T10:15:30Z",
  "configured": false,
  "migrating": true,
  "migratingLastStart": "2007-12-03T10:15:30Z",
  "pruning": true,
  "pruningLastStart": "2007-12-03T10:15:30Z",
  "scanning": true,
  "scanningLastStart": "2007-12-03T10:15:30Z",
  "uptimeMs": "P3Y6M4DT12H30M5S",
  "startTime": "2007-12-03T10:15:30Z"
}

Types

AutopilotTriggerRequestInput

Fields

Input Field	Description
`forceScan` - `Boolean`	Whether to force an immediate host scan. Default = `null`

Example

{"forceScan": true}

Types

AutopilotTriggerResponse

Fields

Field Name	Description
`triggered` - `Boolean`	Indicates if the autopilot loop was triggered

Example

{"triggered": true}

Types

Balance

Fields

Field Name	Description
`siacoins` - `Currency`
`immatureSiacoins` - `Currency`
`siafunds` - `Int`

Example

{
  "siacoins": "USD",
  "immatureSiacoins": "USD",
  "siafunds": 987
}

Types

Block

Fields

Field Name	Description
`parentID` - `BlockID`	The ID of the parent block
`nonce` - `Int`	The nonce used to mine the block
`timestamp` - `DateTime`	The time the block was mined
`minerPayouts` - `[SiacoinOutput!]`
`transactions` - `[Transaction!]`
`v2` - `V2BlockData`

Example

{
  "parentID": BlockID,
  "nonce": 123,
  "timestamp": "2007-12-03T10:15:30Z",
  "minerPayouts": [SiacoinOutput],
  "transactions": [Transaction],
  "v2": V2BlockData
}

Types

BlockID

Description

A unique identifier for a block

Example

BlockID

Types

BlockInput

Fields

Input Field	Description
`parentID` - `String`	The ID of the parent block. Default = `null`
`nonce` - `Int`	The nonce used to mine the block. Default = `null`
`timestamp` - `DateTime`	The time the block was mined. Default = `null`
`minerPayouts` - `[SiacoinOutputInput!]`
`transactions` - `[TransactionInput!]`
`v2` - `V2BlockDataInput`

Example

{
  "parentID": "abc123",
  "nonce": 987,
  "timestamp": "2007-12-03T10:15:30Z",
  "minerPayouts": [SiacoinOutputInput],
  "transactions": [TransactionInput],
  "v2": V2BlockDataInput
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Bucket

Fields

Field Name	Description
`createdAt` - `DateTime`	The time the bucket was created
`name` - `String`
`policy` - `BucketPolicy`

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "policy": BucketPolicy
}

Types

BucketCreateRequestInput

Fields

Input Field	Description
`name` - `String`	Name of the new bucket. Default = `null`
`policy` - `BucketPolicyInput`	Policy configuration for this bucket. Default = `null`

Example

{
  "name": "xyz789",
  "policy": BucketPolicyInput
}

Types

BucketPolicy

Fields

Field Name	Description
`publicReadAccess` - `Boolean`	Indicates if the bucket is publicly readable

Example

{"publicReadAccess": false}

Types

BucketPolicyInput

Fields

Input Field	Description
`publicReadAccess` - `Boolean`	Indicates if the bucket is publicly readable. Default = `null`

Example

{"publicReadAccess": true}

Types

BusStateResponse

Fields

Field Name	Description
`version` - `String`	The version of the build
`commit` - `String`	The commit hash of the build
`os` - `String`	The operating system of the build
`buildTime` - `DateTime`	The build time of the build
`startTime` - `DateTime`	Timestamp when the bus started
`network` - `String`	Network identifier (e.g., 'mainnet', 'testnet')

Example

{
  "version": "xyz789",
  "commit": "xyz789",
  "os": "xyz789",
  "buildTime": "2007-12-03T10:15:30Z",
  "startTime": "2007-12-03T10:15:30Z",
  "network": "abc123"
}

Types

ChainIndex

Fields

Field Name	Description
`height` - `Int`	The height of the block in the blockchain
`id` - `BlockID`	The ID of the block

Example

{"height": 123, "id": BlockID}

Types

ChainIndexInput

Fields

Input Field	Description
`height` - `Int`	The height of the block in the blockchain. Default = `null`
`id` - `String`	The ID of the block. Default = `null`

Example

{"height": 123, "id": "xyz789"}

Types

ConfigEvaluationRequestInput

Fields

Input Field	Description
`autopilotConfig` - `AutopilotConfigInput`	Proposed autopilot config. Default = `null`
`gougingSettings` - `GougingSettingsInput`	Proposed gouging settings. Default = `null`
`redundancySettings` - `RedundancySettingsInput`	Proposed redundancy settings. Default = `null`

Example

{
  "autopilotConfig": AutopilotConfigInput,
  "gougingSettings": GougingSettingsInput,
  "redundancySettings": RedundancySettingsInput
}

Types

ConfigEvaluationResponse

Fields

Field Name	Description
`hosts` - `Int`	Total hosts scanned
`usable` - `Int`	Number of hosts determined to be usable
`unusable` - `ConfigEvaluationUnusable`	Breakdown of unusable hosts
`recommendation` - `ConfigRecommendation`	Recommended config changes

Example

{
  "hosts": 987,
  "usable": 123,
  "unusable": ConfigEvaluationUnusable,
  "recommendation": ConfigRecommendation
}

Types

ConfigEvaluationUnusable

Fields

Field Name	Description
`blocked` - `Int`
`gouging` - `GougingUnusable`
`notAcceptingContracts` - `Int`
`notScanned` - `Int`

Example

{
  "blocked": 987,
  "gouging": GougingUnusable,
  "notAcceptingContracts": 987,
  "notScanned": 987
}

Types

ConfigRecommendation

Fields

Field Name	Description
`gougingSettings` - `GougingSettings`

Example

{"gougingSettings": GougingSettings}

Types

ConsensusState

Fields

Field Name	Description
`blockHeight` - `Int`	The current block height
`lastBlockTime` - `DateTime`	The time of the last block
`synced` - `Boolean`	Whether the node is synced with the network

Example

{
  "blockHeight": 987,
  "lastBlockTime": "2007-12-03T10:15:30Z",
  "synced": true
}

Types

ConsensusUpdatesResponse

Fields

Field Name	Description
`applied` - `[ApplyUpdate!]`
`reverted` - `[RevertUpdate!]`

Example

{
  "applied": [ApplyUpdate],
  "reverted": [RevertUpdate]
}

Types

ContentRange

Fields

Field Name	Description
`offset` - `Int`	The offset of the range
`length` - `Int`	The length of the range
`size` - `Int`	The total size

Example

{"offset": 123, "length": 987, "size": 987}

Types

Contract

Fields

Field Name	Description
`id` - `FileContractID`	The unique identifier for the file contract.
`hostIP` - `String`
`hostKey` - `PublicKey`	The public key of the host.
`siamuxAddr` - `String`
`proofHeight` - `Int`	The height at which the storage proof needs to be submitted
`revisionHeight` - `Int`	The block height of the latest revision
`revisionNumber` - `RevisionNumber`	The current revision number of the contract
`size` - `Int`	The size of the contract in bytes
`startHeight` - `Int`	The block height at which the contract created
`state` - `String`	The state of the contract \| Allowed values: pending, active, complete, failed
`windowStart` - `Int`	The block height when the contract's proof window starts.
`windowEnd` - `Int`	The block height when the contract's proof window ends.
`contractPrice` - `Currency`	The price of forming the contract.
`renewedFrom` - `FileContractID`	The ID of the contract this one was renewed from
`spending` - `ContractSpending`	Costs and spending details of the contract.
`totalCost` - `Currency`
`contractSets` - `[String!]`
`revision` - `FileContractRevision`

Example

{
  "id": FileContractID,
  "hostIP": "xyz789",
  "hostKey": PublicKey,
  "siamuxAddr": "abc123",
  "proofHeight": 123,
  "revisionHeight": 123,
  "revisionNumber": RevisionNumber,
  "size": 987,
  "startHeight": 123,
  "state": "xyz789",
  "windowStart": 987,
  "windowEnd": 123,
  "contractPrice": "USD",
  "renewedFrom": FileContractID,
  "spending": ContractSpending,
  "totalCost": "USD",
  "contractSets": ["xyz789"],
  "revision": FileContractRevision
}

Types

ContractAcquireRequestInput

Fields

Input Field	Description
`duration` - `String`
`priority` - `Int`

Example

{"duration": "abc123", "priority": 987}

Types

ContractAcquireResponse

Fields

Field Name	Description
`lockID` - `Int`

Example

{"lockID": 987}

Types

ContractAddRequestInput

Fields

Input Field	Description
`contract` - `ContractRevisionInput`	rhpv2.ContractRevision. Default = `null`
`contractPrice` - `String`
`startHeight` - `Int`
`state` - `String`
`totalCost` - `String`

Example

{
  "contract": ContractRevisionInput,
  "contractPrice": "xyz789",
  "startHeight": 123,
  "state": "abc123",
  "totalCost": "xyz789"
}

Types

ContractFilterInput

Fields

Input Field	Description
`statuses` - `[ContractStatus!]`
`contractIDs` - `[String!]`
`renewedFrom` - `[String!]`
`renewedTo` - `[String!]`
`renterKey` - `[String!]`
`minNegotiationHeight` - `Int`
`maxNegotiationHeight` - `Int`
`minExpirationHeight` - `Int`
`maxExpirationHeight` - `Int`
`limit` - `Int`
`offset` - `Int`
`sortField` - `String`
`sortDesc` - `Boolean`

Example

{
  "statuses": ["PENDING"],
  "contractIDs": ["abc123"],
  "renewedFrom": ["abc123"],
  "renewedTo": ["abc123"],
  "renterKey": ["xyz789"],
  "minNegotiationHeight": 123,
  "maxNegotiationHeight": 123,
  "minExpirationHeight": 987,
  "maxExpirationHeight": 123,
  "limit": 987,
  "offset": 123,
  "sortField": "abc123",
  "sortDesc": false
}

Types

ContractFormRequestInput

Fields

Input Field	Description
`endHeight` - `Int`
`hostCollateral` - `String`
`hostKey` - `String`
`hostIP` - `String`
`renterFunds` - `String`
`renterAddress` - `String`

Example

{
  "endHeight": 123,
  "hostCollateral": "abc123",
  "hostKey": "abc123",
  "hostIP": "xyz789",
  "renterFunds": "xyz789",
  "renterAddress": "abc123"
}

Types

ContractKeepaliveRequestInput

Fields

Input Field	Description
`duration` - `String`
`lockID` - `Int`

Example

{"duration": "abc123", "lockID": 987}

Types

ContractMetadata

Fields

Field Name	Description
`id` - `FileContractID`	The unique identifier for the file contract.
`hostIP` - `String`
`hostKey` - `PublicKey`	The public key of the host.
`siamuxAddr` - `String`
`proofHeight` - `Int`	The height at which the storage proof needs to be submitted
`revisionHeight` - `Int`	The block height of the latest revision
`revisionNumber` - `RevisionNumber`	The current revision number of the contract
`size` - `Int`	The size of the contract in bytes
`startHeight` - `Int`	The block height at which the contract created
`state` - `String`	The state of the contract \| Allowed values: pending, active, complete, failed
`windowStart` - `Int`	The block height when the contract's proof window starts.
`windowEnd` - `Int`	The block height when the contract's proof window ends.
`contractPrice` - `Currency`	The price of forming the contract.
`renewedFrom` - `FileContractID`	The ID of the contract this one was renewed from
`spending` - `ContractSpending`	Costs and spending details of the contract.
`totalCost` - `Currency`
`contractSets` - `[String!]`

Example

{
  "id": FileContractID,
  "hostIP": "abc123",
  "hostKey": PublicKey,
  "siamuxAddr": "xyz789",
  "proofHeight": 987,
  "revisionHeight": 987,
  "revisionNumber": RevisionNumber,
  "size": 987,
  "startHeight": 987,
  "state": "abc123",
  "windowStart": 987,
  "windowEnd": 123,
  "contractPrice": "USD",
  "renewedFrom": FileContractID,
  "spending": ContractSpending,
  "totalCost": "USD",
  "contractSets": ["xyz789"]
}

Types

ContractPrunableData

Fields

Field Name	Description
`prunable` - `Int`	The amount of data that can be pruned from a contract
`size` - `Int`	The total size of a contract
`id` - `FileContractID`

Example

{"prunable": 123, "size": 987, "id": FileContractID}

Types

ContractPruneRequestInput

Fields

Input Field	Description
`timeout` - `String`

Example

{"timeout": "abc123"}

Types

ContractPruneResponse

Fields

Field Name	Description
`size` - `Int`
`pruned` - `Int`
`remaining` - `Int`
`error` - `String`

Example

{
  "size": 987,
  "pruned": 123,
  "remaining": 987,
  "error": "abc123"
}

Types

ContractRenewRequestInput

Fields

Input Field	Description
`endHeight` - `Int`
`expectedNewStorage` - `Int`
`maxFundAmount` - `String`
`minNewCollateral` - `String`
`renterFunds` - `String`

Example

{
  "endHeight": 987,
  "expectedNewStorage": 987,
  "maxFundAmount": "abc123",
  "minNewCollateral": "xyz789",
  "renterFunds": "abc123"
}

Types

ContractRenewedRequestInput

Fields

Input Field	Description
`contract` - `ContractRevisionInput`	rhpv2.ContractRevision. Default = `null`
`contractPrice` - `String`
`renewedFrom` - `String`
`startHeight` - `Int`
`state` - `String`
`totalCost` - `String`

Example

{
  "contract": ContractRevisionInput,
  "contractPrice": "xyz789",
  "renewedFrom": "abc123",
  "startHeight": 123,
  "state": "abc123",
  "totalCost": "xyz789"
}

Types

ContractRevisionInput

Fields

Input Field	Description
`revision` - `FileContractRevisionInput`	The revised file contract. Default = `null`
`signatures` - `[TransactionSignatureInput!]`	The transaction signatures [2]. Default = `null`

Example

{
  "revision": FileContractRevisionInput,
  "signatures": [TransactionSignatureInput]
}

Types

ContractRootsResponse

Fields

Field Name	Description
`roots` - `[Hash256!]`	List of root hashes
`uploading` - `[Hash256!]`	List of root hashes currently being uploaded

Example

{
  "roots": [Hash256],
  "uploading": [Hash256]
}

Types

ContractSetUpdateRequestInput

Fields

Input Field	Description
`toAdd` - `[String!]`	List of contract IDs to add to the set. Default = `null`
`toRemove` - `[String!]`	List of contract IDs to remove from the set. Default = `null`

Example

{
  "toAdd": ["abc123"],
  "toRemove": ["abc123"]
}

Types

ContractSize

Fields

Field Name	Description
`prunable` - `Int`	The amount of data that can be pruned from a contract
`size` - `Int`	The total size of a contract

Example

{"prunable": 987, "size": 123}

Types

ContractSpending

Fields

Field Name	Description
`uploads` - `Currency`
`downloads` - `Currency`
`fundAccount` - `Currency`
`deletions` - `Currency`
`sectorRoots` - `Currency`

Example

{
  "uploads": "USD",
  "downloads": "USD",
  "fundAccount": "USD",
  "deletions": "USD",
  "sectorRoots": "USD"
}

Types

ContractSpendingRecordInput

Fields

Input Field	Description
`uploads` - `String`
`downloads` - `String`
`fundAccount` - `String`
`deletions` - `String`
`sectorRoots` - `String`
`contractID` - `String`
`revisionNumber` - `Int`
`size` - `Int`
`missedHostPayout` - `String`
`validRenterPayout` - `String`

Example

{
  "uploads": "abc123",
  "downloads": "abc123",
  "fundAccount": "abc123",
  "deletions": "xyz789",
  "sectorRoots": "xyz789",
  "contractID": "xyz789",
  "revisionNumber": 987,
  "size": 987,
  "missedHostPayout": "xyz789",
  "validRenterPayout": "xyz789"
}

Types

ContractStatus

Values

Enum Value	Description
`PENDING`	Contract has been formed but not yet confirmed on blockchain
`REJECTED`	Contract formation transaction was never confirmed
`ACTIVE`	Contract is confirmed and currently active
`SUCCESSFUL`	Storage proof confirmed or contract expired without host burning Siacoin
`FAILED`	Contract ended without storage proof and host burned Siacoin

Example

"PENDING"

Types

Contracts

Fields

Field Name	Description
`active` - `Int`
`rejected` - `Int`
`failed` - `Int`
`renewed` - `Int`
`successful` - `Int`
`lockedCollateral` - `Currency`
`riskedCollateral` - `Currency`

Example

{
  "active": 123,
  "rejected": 123,
  "failed": 987,
  "renewed": 123,
  "successful": 987,
  "lockedCollateral": "USD",
  "riskedCollateral": "USD"
}

Types

ContractsArchiveRequestInput

Fields

Input Field	Description
`contracts` - `String`	Map of contract IDs to their archive reasons. Default = `null`

Example

{"contracts": "xyz789"}

Types

ContractsConfig

Fields

Field Name	Description
`set` - `String`
`amount` - `Int`	The minimum number of contracts to form
`allowance` - `Currency`
`period` - `Int`	The length of a contract's period in blocks (1 block being 10 minutes on average)
`renewWindow` - `Int`	The number of blocks before the end of a contract that a contract should be renewed
`download` - `Int`	Expected download bandwidth used per period in bytes
`upload` - `Int`	Expected upload bandwidth used per period in bytes
`storage` - `Int`	Expected amount of data stored in bytes
`prune` - `Boolean`	Whether to automatically prune deleted data from contracts

Example

{
  "set": "xyz789",
  "amount": 987,
  "allowance": "USD",
  "period": 987,
  "renewWindow": 987,
  "download": 123,
  "upload": 123,
  "storage": 987,
  "prune": false
}

Types

ContractsConfigInput

Fields

Input Field	Description
`set` - `String`
`amount` - `Int`	The minimum number of contracts to form. Default = `null`
`allowance` - `String`
`period` - `Int`	The length of a contract's period in blocks (1 block being 10 minutes on average). Default = `null`
`renewWindow` - `Int`	The number of blocks before the end of a contract that a contract should be renewed. Default = `null`
`download` - `Int`	Expected download bandwidth used per period in bytes. Default = `null`
`upload` - `Int`	Expected upload bandwidth used per period in bytes. Default = `null`
`storage` - `Int`	Expected amount of data stored in bytes. Default = `null`
`prune` - `Boolean`	Whether to automatically prune deleted data from contracts. Default = `null`

Example

{
  "set": "xyz789",
  "amount": 123,
  "allowance": "abc123",
  "period": 987,
  "renewWindow": 987,
  "download": 987,
  "upload": 987,
  "storage": 987,
  "prune": true
}

Types

ContractsPrunableDataResponse

Fields

Field Name	Description
`contracts` - `[ContractPrunableData!]`
`totalPrunable` - `Int`
`totalSize` - `Int`

Example

{
  "contracts": [ContractPrunableData],
  "totalPrunable": 123,
  "totalSize": 987
}

Types

ContractsResponse

Fields

Field Name	Description
`contracts` - `[Contract!]`	List of contracts
`errors` - `JSON`	Map of host public keys to error messages
`error` - `String`	Deprecated error field

Example

{
  "contracts": [Contract],
  "errors": {},
  "error": "xyz789"
}

Types

CopyObjectsRequestInput

Fields

Input Field	Description
`sourceBucket` - `String`
`sourcePath` - `String`
`destinationBucket` - `String`
`destinationPath` - `String`
`mimeType` - `String`
`metadata` - `String`	ObjectUserMetadata. Default = `null`

Example

{
  "sourceBucket": "abc123",
  "sourcePath": "abc123",
  "destinationBucket": "xyz789",
  "destinationPath": "abc123",
  "mimeType": "abc123",
  "metadata": "xyz789"
}

Types

CoveredFields

Fields

Field Name	Description
`wholeTransaction` - `Boolean`	Whether the whole transaction is covered by the signature
`siacoinInputs` - `[Int!]`
`siacoinOutputs` - `[Int!]`
`fileContracts` - `[Int!]`
`fileContractRevisions` - `[Int!]`
`storageProofs` - `[Int!]`
`siafundInputs` - `[Int!]`
`siafundOutputs` - `[Int!]`
`minerFees` - `[Int!]`
`arbitraryData` - `[Int!]`
`signatures` - `[Int!]`

Example

{
  "wholeTransaction": false,
  "siacoinInputs": [987],
  "siacoinOutputs": [123],
  "fileContracts": [987],
  "fileContractRevisions": [123],
  "storageProofs": [123],
  "siafundInputs": [123],
  "siafundOutputs": [987],
  "minerFees": [123],
  "arbitraryData": [123],
  "signatures": [987]
}

Types

CoveredFieldsInput

Fields

Input Field	Description
`wholeTransaction` - `Boolean`	Whether the whole transaction is covered by the signature. Default = `null`
`siacoinInputs` - `[Int!]`
`siacoinOutputs` - `[Int!]`
`fileContracts` - `[Int!]`
`fileContractRevisions` - `[Int!]`
`storageProofs` - `[Int!]`
`siafundInputs` - `[Int!]`
`siafundOutputs` - `[Int!]`
`minerFees` - `[Int!]`
`arbitraryData` - `[Int!]`
`signatures` - `[Int!]`

Example

{
  "wholeTransaction": true,
  "siacoinInputs": [123],
  "siacoinOutputs": [123],
  "fileContracts": [123],
  "fileContractRevisions": [987],
  "storageProofs": [123],
  "siafundInputs": [123],
  "siafundOutputs": [987],
  "minerFees": [123],
  "arbitraryData": [987],
  "signatures": [123]
}

Types

Currency

Description

An unsigned amount of Hastings, the smallest unit of currency in Sia. 1 Siacoin (SC) equals 10^24 Hastings (H). | Pattern: ^\d+$ | Max length: 39

Example

"USD"

Types

DNSSettings

Fields

Field Name	Description
`provider` - `String`
`ipv4` - `Boolean`
`ipv6` - `Boolean`
`options` - `JSON`

Example

{
  "provider": "xyz789",
  "ipv4": true,
  "ipv6": false,
  "options": {}
}

Types

DNSSettingsInput

Fields

Input Field	Description
`provider` - `String`
`ipv4` - `Boolean`
`ipv6` - `Boolean`
`options` - `String`

Example

{
  "provider": "abc123",
  "ipv4": true,
  "ipv6": false,
  "options": "xyz789"
}

Types

DataMetrics

Fields

Field Name	Description
`rhp` - `RHPData`

Example

{"rhp": RHPData}

Types

DateTime

Description

Date with time (isoformat)

Example

"2007-12-03T10:15:30Z"

Types

DownloadRangeInput

Fields

Input Field	Description
`offset` - `Int`	The offset of the range in bytes. Default = `null`
`length` - `Int`	The length of the range in bytes. Default = `null`

Example

{"offset": 123, "length": 987}

Types

DownloadStatsResponse

Fields

Field Name	Description
`avgDownloadSpeedMbps` - `Float`
`avgOverdrivePct` - `Float`
`healthyDownloaders` - `Int`
`numDownloaders` - `Int`
`downloadersStats` - `[DownloaderStats!]`

Example

{
  "avgDownloadSpeedMbps": 987.65,
  "avgOverdrivePct": 123.45,
  "healthyDownloaders": 987,
  "numDownloaders": 123,
  "downloadersStats": [DownloaderStats]
}

Types

DownloaderStats

Fields

Field Name	Description
`avgSectorDownloadSpeedMbps` - `Float`
`hostKey` - `PublicKey`
`numDownloads` - `Int`

Example

{
  "avgSectorDownloadSpeedMbps": 123.45,
  "hostKey": PublicKey,
  "numDownloads": 123
}

Types

Duration

Description

time.Duration

Example

"P3Y6M4DT12H30M5S"

Types

DurationMS

Description

A duration in millisecond

Example

DurationMS

Types

ETag

Description

An ETag representing a resource | Pattern: ^(W/)?$

Example

ETag

Types

EncryptionKey

Description

A key used to encrypt and decrypt data. The key is either a regular key (key) or a salted key (skey). The latter requires a seed to be used for encryption and decryption. | Pattern: ^(key|skey):[0-9a-fA-F]{64}$

Example

EncryptionKey

Types

ExplorerState

Fields

Field Name	Description
`enabled` - `Boolean`	Indicates whether explorer is enabled
`url` - `String`	Optional URL for the explorer source

Example

{"enabled": false, "url": "xyz789"}

Types

FileContract

Fields

Field Name	Description
`filesize` - `Int`	The size of the contract in bytes.
`fileMerkleRoot` - `Hash256`	The Merkle root of the contract's data.
`windowStart` - `Int`	The block height when the contract's proof window starts.
`windowEnd` - `Int`	The block height when the contract's proof window ends.
`payout` - `Currency`	The total payout for the contract.
`validProofOutputs` - `[SiacoinOutput!]`	List of outputs created if the contract is successfully fulfilled.
`missedProofOutputs` - `[SiacoinOutput!]`	List of outputs created if the contract is not fulfilled.
`unlockHash` - `Address`
`revisionNumber` - `RevisionNumber`

Example

{
  "filesize": 987,
  "fileMerkleRoot": Hash256,
  "windowStart": 987,
  "windowEnd": 123,
  "payout": "USD",
  "validProofOutputs": [SiacoinOutput],
  "missedProofOutputs": [SiacoinOutput],
  "unlockHash": Address,
  "revisionNumber": RevisionNumber
}

Types

FileContractID

Description

A unique identifier for a file contract | Pattern: ^fcid:[0-9a-fA-F]{64}$

Example

FileContractID

Types

FileContractInput

Fields

Input Field	Description
`filesize` - `Int`	The size of the contract in bytes. Default = `null`
`fileMerkleRoot` - `String`	The Merkle root of the contract's data. Default = `null`
`windowStart` - `Int`	The block height when the contract's proof window starts. Default = `null`
`windowEnd` - `Int`	The block height when the contract's proof window ends. Default = `null`
`payout` - `String`	The total payout for the contract. Default = `null`
`validProofOutputs` - `[SiacoinOutputInput!]`	List of outputs created if the contract is successfully fulfilled. Default = `null`
`missedProofOutputs` - `[SiacoinOutputInput!]`	List of outputs created if the contract is not fulfilled. Default = `null`
`unlockHash` - `String`
`revisionNumber` - `String`

Example

{
  "filesize": 987,
  "fileMerkleRoot": "xyz789",
  "windowStart": 987,
  "windowEnd": 123,
  "payout": "abc123",
  "validProofOutputs": [SiacoinOutputInput],
  "missedProofOutputs": [SiacoinOutputInput],
  "unlockHash": "abc123",
  "revisionNumber": "xyz789"
}

Types

FileContractRevision

Fields

Field Name	Description
`parentID` - `FileContractID`
`unlockConditions` - `UnlockConditions`

Example

{
  "parentID": FileContractID,
  "unlockConditions": UnlockConditions
}

Types

FileContractRevisionInput

Fields

Input Field	Description
`parentID` - `String`
`unlockConditions` - `UnlockConditionsInput`

Example

{
  "parentID": "abc123",
  "unlockConditions": UnlockConditionsInput
}

Types

FilterInput

Fields

Input Field	Description
`field` - `String!`
`operator` - `FilterOperator!`
`value` - `String`

Example

{
  "field": "xyz789",
  "operator": "EQ",
  "value": "abc123"
}

Types

FilterOperator

Values

Enum Value	Description
`EQ`
`NEQ`
`GT`
`LT`
`GTE`
`LTE`
`CONTAINS`
`IN`
`NIN`
`EXISTS`

Example

"EQ"

Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

123.45

Types

FundingSource

Fields

Field Name	Description
`contractID` - `FileContractID`
`accountID` - `PublicKey`
`amount` - `Currency`

Example

{
  "contractID": FileContractID,
  "accountID": PublicKey,
  "amount": "USD"
}

Types

GatewayPeer

Fields

Field Name	Description
`address` - `String`
`inbound` - `Boolean`
`version` - `String`
`firstSeen` - `DateTime`
`connectedSince` - `DateTime`
`syncedBlocks` - `Int`
`syncDuration` - `Duration`

Example

{
  "address": "xyz789",
  "inbound": true,
  "version": "xyz789",
  "firstSeen": "2007-12-03T10:15:30Z",
  "connectedSince": "2007-12-03T10:15:30Z",
  "syncedBlocks": 987,
  "syncDuration": "P3Y6M4DT12H30M5S"
}

Types

GetObjectOptionsInput

Fields

Input Field	Description
`prefix` - `String`
`offset` - `Int`
`limit` - `Int`
`ignoreDelim` - `Boolean`
`marker` - `String`
`onlyMetadata` - `Boolean`
`sortBy` - `String`
`sortDir` - `String`

Example

{
  "prefix": "abc123",
  "offset": 987,
  "limit": 123,
  "ignoreDelim": true,
  "marker": "xyz789",
  "onlyMetadata": true,
  "sortBy": "xyz789",
  "sortDir": "xyz789"
}

Types

GetObjectResponse

Fields

Field Name	Description
`contentType` - `String`
`etag` - `String`
`lastModified` - `DateTime`
`range` - `ContentRange`	ContentRange
`size` - `Int`
`metadata` - `JSON`	ObjectUserMetadata
`content` - `String`

Example

{
  "contentType": "xyz789",
  "etag": "abc123",
  "lastModified": "2007-12-03T10:15:30Z",
  "range": ContentRange,
  "size": 987,
  "metadata": {},
  "content": "abc123"
}

Types

GougingParams

Fields

Field Name	Description
`consensusState` - `ConsensusState`
`gougingSettings` - `GougingSettings`
`redundancySettings` - `RedundancySettings`
`transactionFee` - `Currency`

Example

{
  "consensusState": ConsensusState,
  "gougingSettings": GougingSettings,
  "redundancySettings": RedundancySettings,
  "transactionFee": "USD"
}

Types

GougingSettings

Fields

Field Name	Description
`maxRPCPrice` - `Currency`	The maximum base price a host can charge per RPC
`maxContractPrice` - `Currency`	The maximum price a host can charge for a contract formation
`maxDownloadPrice` - `Currency`	The maximum price a host can charge for downloading in hastings / byte
`maxUploadPrice` - `Currency`	The maximum price a host can charge for uploading in hastings / byte
`maxStoragePrice` - `Currency`	The maximum price a host can charge for storage in hastings / byte / block
`hostBlockHeightLeeway` - `Int`	The number of blocks a host's chain's height can diverge from our own before we stop using it
`minPriceTableValidity` - `Duration`	The time a host's price table should be valid after acquiring it in milliseconds
`minAccountExpiry` - `Duration`	The minimum amount of time an account on a host can be idle for before expiring
`minMaxEphemeralAccountBalance` - `Currency`	The minimum max balance a host should allow us to fund an account with
`migrationSurchargeMultiplier` - `Int`	The multiplier for the migration surcharge

Example

{
  "maxRPCPrice": "USD",
  "maxContractPrice": "USD",
  "maxDownloadPrice": "USD",
  "maxUploadPrice": "USD",
  "maxStoragePrice": "USD",
  "hostBlockHeightLeeway": 123,
  "minPriceTableValidity": "P3Y6M4DT12H30M5S",
  "minAccountExpiry": "P3Y6M4DT12H30M5S",
  "minMaxEphemeralAccountBalance": "USD",
  "migrationSurchargeMultiplier": 123
}

Types

GougingSettingsInput

Fields

Input Field	Description
`maxRPCPrice` - `String`	The maximum base price a host can charge per RPC. Default = `null`
`maxContractPrice` - `String`	The maximum price a host can charge for a contract formation. Default = `null`
`maxDownloadPrice` - `String`	The maximum price a host can charge for downloading in hastings / byte. Default = `null`
`maxUploadPrice` - `String`	The maximum price a host can charge for uploading in hastings / byte. Default = `null`
`maxStoragePrice` - `String`	The maximum price a host can charge for storage in hastings / byte / block. Default = `null`
`hostBlockHeightLeeway` - `Int`	The number of blocks a host's chain's height can diverge from our own before we stop using it. Default = `null`
`minPriceTableValidity` - `String`	The time a host's price table should be valid after acquiring it in milliseconds. Default = `null`
`minAccountExpiry` - `String`	The minimum amount of time an account on a host can be idle for before expiring. Default = `null`
`minMaxEphemeralAccountBalance` - `String`	The minimum max balance a host should allow us to fund an account with. Default = `null`
`migrationSurchargeMultiplier` - `Int`	The multiplier for the migration surcharge. Default = `null`

Example

{
  "maxRPCPrice": "xyz789",
  "maxContractPrice": "abc123",
  "maxDownloadPrice": "xyz789",
  "maxUploadPrice": "abc123",
  "maxStoragePrice": "xyz789",
  "hostBlockHeightLeeway": 987,
  "minPriceTableValidity": "xyz789",
  "minAccountExpiry": "xyz789",
  "minMaxEphemeralAccountBalance": "abc123",
  "migrationSurchargeMultiplier": 987
}

Types

GougingUnusable

Fields

Field Name	Description
`contract` - `Int`
`download` - `Int`
`gouging` - `Int`
`pruning` - `Int`
`upload` - `Int`

Example

{
  "contract": 987,
  "download": 123,
  "gouging": 987,
  "pruning": 123,
  "upload": 987
}

Types

HardforkASIC

Fields

Field Name	Description
`height` - `Int`
`oakTime` - `Duration`
`oakTarget` - `BlockID`

Example

{
  "height": 123,
  "oakTime": "P3Y6M4DT12H30M5S",
  "oakTarget": BlockID
}

Types

HardforkDevAddr

Fields

Field Name	Description
`height` - `Int`
`oldAddress` - `Address`
`newAddress` - `Address`

Example

{
  "height": 123,
  "oldAddress": Address,
  "newAddress": Address
}

Types

HardforkFoundation

Fields

Field Name	Description
`height` - `Int`
`primaryAddress` - `Address`
`failsafeAddress` - `Address`

Example

{
  "height": 987,
  "primaryAddress": Address,
  "failsafeAddress": Address
}

Types

HardforkOak

Fields

Field Name	Description
`height` - `Int`
`fixHeight` - `Int`
`genesisTimestamp` - `DateTime`

Example

{
  "height": 987,
  "fixHeight": 987,
  "genesisTimestamp": "2007-12-03T10:15:30Z"
}

Types

HardforkStorageProof

Fields

Field Name	Description
`height` - `Int`

Example

{"height": 987}

Types

HardforkTax

Fields

Field Name	Description
`height` - `Int`

Example

{"height": 123}

Types

HardforkV2

Fields

Field Name	Description
`allowHeight` - `Int`
`requireHeight` - `Int`

Example

{"allowHeight": 123, "requireHeight": 123}

Types

Hash256

Description

A 256-bit blake2b hash | Pattern: ^[0-9a-fA-F]{64}$

Example

Hash256

Types

HeadObjectOptionsInput

Fields

Input Field	Description
`ignoreDelim` - `Boolean`
`range` - `DownloadRangeInput`	DownloadRange. Default = `null`

Example

{"ignoreDelim": true, "range": DownloadRangeInput}

Types

HeadObjectResponse

Fields

Field Name	Description
`contentType` - `String`
`etag` - `String`
`lastModified` - `DateTime`
`range` - `ContentRange`	ContentRange
`size` - `Int`
`metadata` - `JSON`	ObjectUserMetadata

Example

{
  "contentType": "xyz789",
  "etag": "xyz789",
  "lastModified": "2007-12-03T10:15:30Z",
  "range": ContentRange,
  "size": 123,
  "metadata": {}
}

Types

Host

Fields

Field Name	Description
`knownSince` - `DateTime`	The time the host was first seen
`lastAnnouncement` - `DateTime`	The time the host last announced itself
`publicKey` - `PublicKey`
`netAddress` - `String`	The address of the host
`priceTable` - `HostPriceTable`
`settings` - `HostV2Settings`
`interactions` - `HostInteractions`
`scanned` - `Boolean`	Whether the host has been scanned
`blocked` - `Boolean`	Whether the host is blocked
`checks` - `JSON`
`storedData` - `Int`	The amount of data stored on the host in bytes
`resolvedAddresses` - `[String!]`
`subnets` - `[String!]`

Example

{
  "knownSince": "2007-12-03T10:15:30Z",
  "lastAnnouncement": "2007-12-03T10:15:30Z",
  "publicKey": PublicKey,
  "netAddress": "xyz789",
  "priceTable": HostPriceTable,
  "settings": HostV2Settings,
  "interactions": HostInteractions,
  "scanned": false,
  "blocked": false,
  "checks": {},
  "storedData": 123,
  "resolvedAddresses": ["xyz789"],
  "subnets": ["xyz789"]
}

Types

HostAddress

Fields

Field Name	Description
`publicKey` - `PublicKey`	The public key of the host
`netAddress` - `String`	The network address of the host

Example

{
  "publicKey": PublicKey,
  "netAddress": "xyz789"
}

Types

HostCheckInput

Fields

Input Field	Description
`gouging` - `HostGougingBreakdownInput`
`score` - `HostScoreBreakdownInput`
`usability` - `HostUsabilityBreakdownInput`

Example

{
  "gouging": HostGougingBreakdownInput,
  "score": HostScoreBreakdownInput,
  "usability": HostUsabilityBreakdownInput
}

Types

HostChecks

Fields

Field Name	Description
`gouging` - `Boolean`	Whether the host is gouging
`gougingBreakdown` - `HostGougingBreakdown`
`score` - `Float`	The host's overall score
`scoreBreakdown` - `HostScoreBreakdown`
`usable` - `Boolean`	Whether the host is usable
`unusableReasons` - `[String!]`	Reasons why the host is unusable

Example

{
  "gouging": true,
  "gougingBreakdown": HostGougingBreakdown,
  "score": 987.65,
  "scoreBreakdown": HostScoreBreakdown,
  "usable": true,
  "unusableReasons": ["xyz789"]
}

Types

HostGougingBreakdown

Fields

Field Name	Description
`contractErr` - `String`	Error message related to contract gouging checks.
`downloadErr` - `String`	Error message related to download gouging checks.
`gougingErr` - `String`	Error message related to general gouging checks.
`pruneErr` - `String`	Error message related to pruning checks.
`uploadErr` - `String`	Error message related to upload gouging checks.

Example

{
  "contractErr": "xyz789",
  "downloadErr": "xyz789",
  "gougingErr": "abc123",
  "pruneErr": "xyz789",
  "uploadErr": "abc123"
}

Types

HostGougingBreakdownInput

Fields

Input Field	Description
`contractErr` - `String`	Error message related to contract gouging checks. Default = `null`
`downloadErr` - `String`	Error message related to download gouging checks. Default = `null`
`gougingErr` - `String`	Error message related to general gouging checks. Default = `null`
`pruneErr` - `String`	Error message related to pruning checks. Default = `null`
`uploadErr` - `String`	Error message related to upload gouging checks. Default = `null`

Example

{
  "contractErr": "xyz789",
  "downloadErr": "xyz789",
  "gougingErr": "abc123",
  "pruneErr": "abc123",
  "uploadErr": "xyz789"
}

Types

HostInteractions

Fields

Field Name	Description
`totalScans` - `Int`	The total number of scans performed on the host.
`lastScan` - `DateTime`	Timestamp of the last scan performed.
`lastScanSuccess` - `Boolean`	Indicates whether the last scan was successful.
`lostSectors` - `Int`	Number of sectors lost since the last reporting period.
`secondToLastScanSuccess` - `Boolean`	Indicates whether the second-to-last scan was successful.
`uptime` - `Duration`	Total uptime duration of the host.
`downtime` - `Duration`	Total downtime duration of the host.
`successfulInteractions` - `Float`	The number of successful interactions with the host.
`failedInteractions` - `Float`	The number of failed interactions with the host.

Example

{
  "totalScans": 987,
  "lastScan": "2007-12-03T10:15:30Z",
  "lastScanSuccess": false,
  "lostSectors": 987,
  "secondToLastScanSuccess": true,
  "uptime": "P3Y6M4DT12H30M5S",
  "downtime": "P3Y6M4DT12H30M5S",
  "successfulInteractions": 987.65,
  "failedInteractions": 987.65
}

Types

HostPriceTable

Fields

Field Name	Description
`uid` - `SettingsID`	A unique specifier that identifies this price table
`validity` - `Duration`	Duration that specifies how long the host guarantees these prices for
`hostblockheight` - `Int`	The block height of the host, allows creating valid withdrawal messages if not synced
`updatepricetablecost` - `Currency`	Cost of fetching a new price table from the host
`accountbalancecost` - `Currency`	Cost of fetching the balance of an ephemeral account
`fundaccountcost` - `Currency`	Cost of funding an ephemeral account on the host
`latestrevisioncost` - `Currency`	Cost of asking the host for the latest revision of a contract
`subscriptionmemorycost` - `Currency`	Cost of storing a byte of data for SubscriptionPeriod time
`subscriptionnotificationcost` - `Currency`	Cost of a single notification on top of bandwidth charges
`initbasecost` - `Currency`	Base cost incurred when an MDM program starts to run (excluding memory)
`memorytimecost` - `Currency`	Cost per byte per time incurred by program memory consumption
`downloadbandwidthcost` - `Currency`	Cost per byte for download bandwidth
`uploadbandwidthcost` - `Currency`	Cost per byte for upload bandwidth
`dropsectorsbasecost` - `Currency`	Base cost for DropSectors instruction
`dropsectorsunitcost` - `Currency`	Cost per sector for DropSectors instruction
`hassectorbasecost` - `Currency`	Base cost for HasSector command
`readbasecost` - `Currency`	Base cost for Read instruction
`readlengthcost` - `Currency`	Cost per byte for Read instruction
`renewcontractcost` - `Currency`	Cost for RenewContract instruction
`revisionbasecost` - `Currency`	Base cost for Revision command
`swapsectorcost` - `Currency`	Cost of swapping 2 full sectors by root
`writebasecost` - `Currency`	Base cost per write operation
`writelengthcost` - `Currency`	Cost per byte written
`writestorecost` - `Currency`	Cost per byte/block of additional storage
`txnfeeminrecommended` - `Currency`	Minimum recommended transaction fee
`txnfeemaxrecommended` - `Currency`	Maximum recommended transaction fee
`contractprice` - `Currency`	Fee charged for forming/renewing contracts to cover miner fees
`collateralcost` - `Currency`	Collateral locked per byte when adding new data
`maxcollateral` - `Currency`	Maximum collateral the host will put in a single contract
`maxduration` - `Int`	Maximum contract formation duration in blocks
`windowsize` - `Int`	Minimum blocks for contract renew window
`registryentriesleft` - `Int`	Remaining available registry entries
`registryentriestotal` - `Int`	Total available registry entries
`expiry` - `DateTime`	Time when this price table expires

Example

{
  "uid": SettingsID,
  "validity": "P3Y6M4DT12H30M5S",
  "hostblockheight": 123,
  "updatepricetablecost": "USD",
  "accountbalancecost": "USD",
  "fundaccountcost": "USD",
  "latestrevisioncost": "USD",
  "subscriptionmemorycost": "USD",
  "subscriptionnotificationcost": "USD",
  "initbasecost": "USD",
  "memorytimecost": "USD",
  "downloadbandwidthcost": "USD",
  "uploadbandwidthcost": "USD",
  "dropsectorsbasecost": "USD",
  "dropsectorsunitcost": "USD",
  "hassectorbasecost": "USD",
  "readbasecost": "USD",
  "readlengthcost": "USD",
  "renewcontractcost": "USD",
  "revisionbasecost": "USD",
  "swapsectorcost": "USD",
  "writebasecost": "USD",
  "writelengthcost": "USD",
  "writestorecost": "USD",
  "txnfeeminrecommended": "USD",
  "txnfeemaxrecommended": "USD",
  "contractprice": "USD",
  "collateralcost": "USD",
  "maxcollateral": "USD",
  "maxduration": 987,
  "windowsize": 123,
  "registryentriesleft": 987,
  "registryentriestotal": 987,
  "expiry": "2007-12-03T10:15:30Z"
}

Types

HostPriceTableInput

Fields

Input Field	Description
`uid` - `String`	A unique specifier that identifies this price table. Default = `null`
`validity` - `String`	Duration that specifies how long the host guarantees these prices for. Default = `null`
`hostblockheight` - `Int`	The block height of the host, allows creating valid withdrawal messages if not synced. Default = `null`
`updatepricetablecost` - `String`	Cost of fetching a new price table from the host. Default = `null`
`accountbalancecost` - `String`	Cost of fetching the balance of an ephemeral account. Default = `null`
`fundaccountcost` - `String`	Cost of funding an ephemeral account on the host. Default = `null`
`latestrevisioncost` - `String`	Cost of asking the host for the latest revision of a contract. Default = `null`
`subscriptionmemorycost` - `String`	Cost of storing a byte of data for SubscriptionPeriod time. Default = `null`
`subscriptionnotificationcost` - `String`	Cost of a single notification on top of bandwidth charges. Default = `null`
`initbasecost` - `String`	Base cost incurred when an MDM program starts to run (excluding memory). Default = `null`
`memorytimecost` - `String`	Cost per byte per time incurred by program memory consumption. Default = `null`
`downloadbandwidthcost` - `String`	Cost per byte for download bandwidth. Default = `null`
`uploadbandwidthcost` - `String`	Cost per byte for upload bandwidth. Default = `null`
`dropsectorsbasecost` - `String`	Base cost for DropSectors instruction. Default = `null`
`dropsectorsunitcost` - `String`	Cost per sector for DropSectors instruction. Default = `null`
`hassectorbasecost` - `String`	Base cost for HasSector command. Default = `null`
`readbasecost` - `String`	Base cost for Read instruction. Default = `null`
`readlengthcost` - `String`	Cost per byte for Read instruction. Default = `null`
`renewcontractcost` - `String`	Cost for RenewContract instruction. Default = `null`
`revisionbasecost` - `String`	Base cost for Revision command. Default = `null`
`swapsectorcost` - `String`	Cost of swapping 2 full sectors by root. Default = `null`
`writebasecost` - `String`	Base cost per write operation. Default = `null`
`writelengthcost` - `String`	Cost per byte written. Default = `null`
`writestorecost` - `String`	Cost per byte/block of additional storage. Default = `null`
`txnfeeminrecommended` - `String`	Minimum recommended transaction fee. Default = `null`
`txnfeemaxrecommended` - `String`	Maximum recommended transaction fee. Default = `null`
`contractprice` - `String`	Fee charged for forming/renewing contracts to cover miner fees. Default = `null`
`collateralcost` - `String`	Collateral locked per byte when adding new data. Default = `null`
`maxcollateral` - `String`	Maximum collateral the host will put in a single contract. Default = `null`
`maxduration` - `Int`	Maximum contract formation duration in blocks. Default = `null`
`windowsize` - `Int`	Minimum blocks for contract renew window. Default = `null`
`registryentriesleft` - `Int`	Remaining available registry entries. Default = `null`
`registryentriestotal` - `Int`	Total available registry entries. Default = `null`
`expiry` - `DateTime`	Time when this price table expires. Default = `null`

Example

{
  "uid": "abc123",
  "validity": "abc123",
  "hostblockheight": 123,
  "updatepricetablecost": "xyz789",
  "accountbalancecost": "xyz789",
  "fundaccountcost": "xyz789",
  "latestrevisioncost": "xyz789",
  "subscriptionmemorycost": "abc123",
  "subscriptionnotificationcost": "xyz789",
  "initbasecost": "xyz789",
  "memorytimecost": "xyz789",
  "downloadbandwidthcost": "abc123",
  "uploadbandwidthcost": "abc123",
  "dropsectorsbasecost": "abc123",
  "dropsectorsunitcost": "abc123",
  "hassectorbasecost": "abc123",
  "readbasecost": "abc123",
  "readlengthcost": "xyz789",
  "renewcontractcost": "xyz789",
  "revisionbasecost": "xyz789",
  "swapsectorcost": "xyz789",
  "writebasecost": "abc123",
  "writelengthcost": "abc123",
  "writestorecost": "abc123",
  "txnfeeminrecommended": "xyz789",
  "txnfeemaxrecommended": "abc123",
  "contractprice": "xyz789",
  "collateralcost": "xyz789",
  "maxcollateral": "abc123",
  "maxduration": 123,
  "windowsize": 123,
  "registryentriesleft": 987,
  "registryentriestotal": 987,
  "expiry": "2007-12-03T10:15:30Z"
}

Types

HostResponse

Fields

Field Name	Description
`host` - `Host`	Host information
`checks` - `HostChecks`	Host check results

Example

{"host": Host, "checks": HostChecks}

Types

HostScanInput

Fields

Input Field	Description
`hostKey` - `String`
`priceTable` - `HostPriceTableInput`
`settings` - `HostV2SettingsInput`
`resolvedAddresses` - `[String!]`
`subnets` - `[String!]`
`success` - `Boolean`
`timestamp` - `DateTime`

Example

{
  "hostKey": "xyz789",
  "priceTable": HostPriceTableInput,
  "settings": HostV2SettingsInput,
  "resolvedAddresses": ["xyz789"],
  "subnets": ["abc123"],
  "success": true,
  "timestamp": "2007-12-03T10:15:30Z"
}

Types

HostScoreBreakdown

Fields

Field Name	Description
`age` - `Float`	Score contribution based on the host's age.
`collateral` - `Float`	Score contribution based on the host's collateral amount.
`interactions` - `Float`	Score contribution based on successful interactions.
`storageRemaining` - `Float`	Score contribution based on remaining storage capacity.
`uptime` - `Float`	Score contribution based on host uptime.
`version` - `Float`	Score contribution based on the host's software version.
`prices` - `Float`	Score contribution based on pricing metrics.

Example

{
  "age": 987.65,
  "collateral": 123.45,
  "interactions": 987.65,
  "storageRemaining": 987.65,
  "uptime": 123.45,
  "version": 987.65,
  "prices": 123.45
}

Types

HostScoreBreakdownInput

Fields

Input Field	Description
`age` - `Float`	Score contribution based on the host's age. Default = `null`
`collateral` - `Float`	Score contribution based on the host's collateral amount. Default = `null`
`interactions` - `Float`	Score contribution based on successful interactions. Default = `null`
`storageRemaining` - `Float`	Score contribution based on remaining storage capacity. Default = `null`
`uptime` - `Float`	Score contribution based on host uptime. Default = `null`
`version` - `Float`	Score contribution based on the host's software version. Default = `null`
`prices` - `Float`	Score contribution based on pricing metrics. Default = `null`

Example

{
  "age": 123.45,
  "collateral": 987.65,
  "interactions": 123.45,
  "storageRemaining": 987.65,
  "uptime": 123.45,
  "version": 987.65,
  "prices": 123.45
}

Types

HostSettings

Fields

Field Name	Description
`acceptingContracts` - `Boolean`	Whether the host is accepting new contracts
`netAddress` - `String`	Network address of the host
`maxContractDuration` - `Int`	Maximum allowed contract duration in blocks
`windowSize` - `Int`	Size of the proof window in blocks
`contractPrice` - `Currency`	Cost to form a contract with the host
`baseRPCPrice` - `Currency`	Base cost for RPCs
`sectorAccessPrice` - `Currency`	Cost to access a sector
`collateralMultiplier` - `Float`	Multiplier for collateral
`maxCollateral` - `Currency`	Maximum collateral per contract
`storagePrice` - `Currency`	Cost per byte per block of storage
`egressPrice` - `Currency`	Cost per byte of egress bandwidth
`ingressPrice` - `Currency`	Cost per byte of ingress bandwidth
`priceTableValidity` - `Duration`	Duration a price table remains valid
`maxRegistryEntries` - `Int`	Maximum number of registry entries
`accountExpiry` - `Duration`	Duration before an account expires
`maxAccountBalance` - `Currency`	Maximum balance allowed in an account
`ingressLimit` - `Int`	Maximum ingress bandwidth in bytes per second
`egressLimit` - `Int`	Maximum egress bandwidth in bytes per second
`ddns` - `DNSSettings`	Dynamic DNS settings
`sectorCacheSize` - `Int`	Size of sector cache
`revision` - `Int`	Settings revision number

Example

{
  "acceptingContracts": false,
  "netAddress": "abc123",
  "maxContractDuration": 123,
  "windowSize": 123,
  "contractPrice": "USD",
  "baseRPCPrice": "USD",
  "sectorAccessPrice": "USD",
  "collateralMultiplier": 123.45,
  "maxCollateral": "USD",
  "storagePrice": "USD",
  "egressPrice": "USD",
  "ingressPrice": "USD",
  "priceTableValidity": "P3Y6M4DT12H30M5S",
  "maxRegistryEntries": 987,
  "accountExpiry": "P3Y6M4DT12H30M5S",
  "maxAccountBalance": "USD",
  "ingressLimit": 123,
  "egressLimit": 123,
  "ddns": DNSSettings,
  "sectorCacheSize": 123,
  "revision": 123
}

Types

HostSettingsInput

Fields

Input Field	Description
`acceptingContracts` - `Boolean`	Whether the host is accepting new contracts. Default = `null`
`netAddress` - `String`	Network address of the host. Default = `null`
`maxContractDuration` - `Int`	Maximum allowed contract duration in blocks. Default = `null`
`windowSize` - `Int`	Size of the proof window in blocks. Default = `null`
`contractPrice` - `String`	Cost to form a contract with the host. Default = `null`
`baseRPCPrice` - `String`	Base cost for RPCs. Default = `null`
`sectorAccessPrice` - `String`	Cost to access a sector. Default = `null`
`collateralMultiplier` - `Float`	Multiplier for collateral. Default = `null`
`maxCollateral` - `String`	Maximum collateral per contract. Default = `null`
`storagePrice` - `String`	Cost per byte per block of storage. Default = `null`
`egressPrice` - `String`	Cost per byte of egress bandwidth. Default = `null`
`ingressPrice` - `String`	Cost per byte of ingress bandwidth. Default = `null`
`priceTableValidity` - `String`	Duration a price table remains valid. Default = `null`
`maxRegistryEntries` - `Int`	Maximum number of registry entries. Default = `null`
`accountExpiry` - `String`	Duration before an account expires. Default = `null`
`maxAccountBalance` - `String`	Maximum balance allowed in an account. Default = `null`
`ingressLimit` - `Int`	Maximum ingress bandwidth in bytes per second. Default = `null`
`egressLimit` - `Int`	Maximum egress bandwidth in bytes per second. Default = `null`
`ddns` - `DNSSettingsInput`	Dynamic DNS settings. Default = `null`
`sectorCacheSize` - `Int`	Size of sector cache. Default = `null`
`revision` - `Int`	Settings revision number. Default = `null`

Example

{
  "acceptingContracts": true,
  "netAddress": "abc123",
  "maxContractDuration": 123,
  "windowSize": 987,
  "contractPrice": "abc123",
  "baseRPCPrice": "xyz789",
  "sectorAccessPrice": "xyz789",
  "collateralMultiplier": 987.65,
  "maxCollateral": "xyz789",
  "storagePrice": "xyz789",
  "egressPrice": "xyz789",
  "ingressPrice": "abc123",
  "priceTableValidity": "xyz789",
  "maxRegistryEntries": 987,
  "accountExpiry": "abc123",
  "maxAccountBalance": "abc123",
  "ingressLimit": 987,
  "egressLimit": 123,
  "ddns": DNSSettingsInput,
  "sectorCacheSize": 123,
  "revision": 123
}

Types

HostUsabilityBreakdownInput

Fields

Input Field	Description
`blocked` - `Boolean`	Indicates if the host is blocked. Default = `null`
`offline` - `Boolean`	Indicates if the host is offline. Default = `null`
`lowScore` - `Boolean`	Indicates if the host has a low score. Default = `null`
`redundantIP` - `Boolean`	Indicates if the host's IP address is redundant. Default = `null`
`gouging` - `Boolean`	Indicates if the host is gouging prices. Default = `null`
`notAcceptingContracts` - `Boolean`	Indicates if the host is not accepting new contracts. Default = `null`
`notAnnounced` - `Boolean`	Indicates if the host has not been announced on the network. Default = `null`
`notCompletingScan` - `Boolean`	Indicates if the host is failing to complete scans. Default = `null`

Example

{
  "blocked": false,
  "offline": false,
  "lowScore": false,
  "redundantIP": true,
  "gouging": true,
  "notAcceptingContracts": false,
  "notAnnounced": true,
  "notCompletingScan": false
}

Types

HostV2Settings

Fields

Field Name	Description
`acceptingcontracts` - `Boolean`	Whether the host is accepting new contracts
`maxdownloadbatchsize` - `Int`	Maximum allowed download batch size
`maxduration` - `Int`	Maximum allowed duration
`maxrevisebatchsize` - `Int`	Maximum allowed revision batch size
`netaddress` - `String`	Network address of the host
`remainingstorage` - `Int`	Amount of storage the host has remaining
`sectorsize` - `Int`	Size of a storage sector
`totalstorage` - `Int`	Total amount of storage space
`unlockhash` - `Address`
`windowsize` - `Int`	Size of the proof window
`collateral` - `Currency`
`maxcollateral` - `Currency`
`baserpcprice` - `Currency`
`contractprice` - `Currency`
`downloadbandwidthprice` - `Currency`
`sectoraccessprice` - `Currency`
`storageprice` - `Currency`
`uploadbandwidthprice` - `Currency`
`ephemeralaccountexpiry` - `Duration`	Duration before an ephemeral account expires
`maxephemeralaccountbalance` - `Currency`
`revisionnumber` - `Int`
`version` - `String`	Version of the host software
`release` - `String`	Release tag of the host software
`siamuxport` - `String`	Port used for siamux connections

Example

{
  "acceptingcontracts": false,
  "maxdownloadbatchsize": 123,
  "maxduration": 987,
  "maxrevisebatchsize": 123,
  "netaddress": "xyz789",
  "remainingstorage": 987,
  "sectorsize": 987,
  "totalstorage": 123,
  "unlockhash": Address,
  "windowsize": 987,
  "collateral": "USD",
  "maxcollateral": "USD",
  "baserpcprice": "USD",
  "contractprice": "USD",
  "downloadbandwidthprice": "USD",
  "sectoraccessprice": "USD",
  "storageprice": "USD",
  "uploadbandwidthprice": "USD",
  "ephemeralaccountexpiry": "P3Y6M4DT12H30M5S",
  "maxephemeralaccountbalance": "USD",
  "revisionnumber": 123,
  "version": "abc123",
  "release": "xyz789",
  "siamuxport": "xyz789"
}

Types

HostV2SettingsInput

Fields

Input Field	Description
`acceptingcontracts` - `Boolean`	Whether the host is accepting new contracts. Default = `null`
`maxdownloadbatchsize` - `Int`	Maximum allowed download batch size. Default = `null`
`maxduration` - `Int`	Maximum allowed duration. Default = `null`
`maxrevisebatchsize` - `Int`	Maximum allowed revision batch size. Default = `null`
`netaddress` - `String`	Network address of the host. Default = `null`
`remainingstorage` - `Int`	Amount of storage the host has remaining. Default = `null`
`sectorsize` - `Int`	Size of a storage sector. Default = `null`
`totalstorage` - `Int`	Total amount of storage space. Default = `null`
`unlockhash` - `String`
`windowsize` - `Int`	Size of the proof window. Default = `null`
`collateral` - `String`
`maxcollateral` - `String`
`baserpcprice` - `String`
`contractprice` - `String`
`downloadbandwidthprice` - `String`
`sectoraccessprice` - `String`
`storageprice` - `String`
`uploadbandwidthprice` - `String`
`ephemeralaccountexpiry` - `String`	Duration before an ephemeral account expires. Default = `null`
`maxephemeralaccountbalance` - `String`
`revisionnumber` - `Int`
`version` - `String`	Version of the host software. Default = `null`
`release` - `String`	Release tag of the host software. Default = `null`
`siamuxport` - `String`	Port used for siamux connections. Default = `null`

Example

{
  "acceptingcontracts": false,
  "maxdownloadbatchsize": 987,
  "maxduration": 123,
  "maxrevisebatchsize": 987,
  "netaddress": "xyz789",
  "remainingstorage": 987,
  "sectorsize": 123,
  "totalstorage": 123,
  "unlockhash": "xyz789",
  "windowsize": 987,
  "collateral": "abc123",
  "maxcollateral": "abc123",
  "baserpcprice": "xyz789",
  "contractprice": "xyz789",
  "downloadbandwidthprice": "xyz789",
  "sectoraccessprice": "xyz789",
  "storageprice": "xyz789",
  "uploadbandwidthprice": "xyz789",
  "ephemeralaccountexpiry": "xyz789",
  "maxephemeralaccountbalance": "xyz789",
  "revisionnumber": 123,
  "version": "xyz789",
  "release": "xyz789",
  "siamuxport": "xyz789"
}

Types

HostdAccount

Fields

Field Name	Description
`id` - `PublicKey`
`balance` - `Currency`
`expiration` - `DateTime`

Example

{
  "id": PublicKey,
  "balance": "USD",
  "expiration": "2007-12-03T10:15:30Z"
}

Types

HostdContract

Fields

Field Name	Description
`revision` - `FileContractRevision`
`hostSignature` - `Signature`
`renterSignature` - `Signature`
`status` - `ContractStatus`
`lockedCollateral` - `Currency`
`usage` - `Usage`
`negotiationHeight` - `Int`
`formationConfirmed` - `Boolean`
`revisionConfirmed` - `Boolean`
`resolutionHeight` - `Int`
`renewedTo` - `FileContractID`
`renewedFrom` - `FileContractID`

Example

{
  "revision": FileContractRevision,
  "hostSignature": Signature,
  "renterSignature": Signature,
  "status": "PENDING",
  "lockedCollateral": "USD",
  "usage": Usage,
  "negotiationHeight": 987,
  "formationConfirmed": false,
  "revisionConfirmed": true,
  "resolutionHeight": 123,
  "renewedTo": FileContractID,
  "renewedFrom": FileContractID
}

Types

HostdContractsResponse

Fields

Field Name	Description
`count` - `Int`	Total number of contracts
`contracts` - `[HostdContract!]`	List of contracts

Example

{"count": 123, "contracts": [HostdContract]}

Types

HostdState

Fields

Field Name	Description
`version` - `String`
`commit` - `String`
`os` - `String`
`buildTime` - `DateTime`
`name` - `String`
`publicKey` - `PublicKey`
`lastAnnouncement` - `Announcement`	settings.Announcement
`startTime` - `DateTime`
`explorer` - `ExplorerState`

Example

{
  "version": "abc123",
  "commit": "xyz789",
  "os": "abc123",
  "buildTime": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "publicKey": PublicKey,
  "lastAnnouncement": Announcement,
  "startTime": "2007-12-03T10:15:30Z",
  "explorer": ExplorerState
}

Types

HostsConfig

Fields

Field Name	Description
`allowRedundantIPs` - `Boolean`	Whether to allow hosts with redundant IPs
`maxDowntimeHours` - `Int`	The maximum number of hours a host can be offline before it is removed from the database
`minProtocolVersion` - `String`	The minimum supported protocol version of a host to be considered good
`maxConsecutiveScanFailures` - `Int`	The maximum number of consecutive scan failures before a host is removed from the database
`scoreOverrides` - `JSON`	Map of host public keys to score override values

Example

{
  "allowRedundantIPs": false,
  "maxDowntimeHours": 123,
  "minProtocolVersion": "abc123",
  "maxConsecutiveScanFailures": 987,
  "scoreOverrides": {}
}

Types

HostsConfigInput

Fields

Input Field	Description
`allowRedundantIPs` - `Boolean`	Whether to allow hosts with redundant IPs. Default = `null`
`maxDowntimeHours` - `Int`	The maximum number of hours a host can be offline before it is removed from the database. Default = `null`
`minProtocolVersion` - `String`	The minimum supported protocol version of a host to be considered good. Default = `null`
`maxConsecutiveScanFailures` - `Int`	The maximum number of consecutive scan failures before a host is removed from the database. Default = `null`
`scoreOverrides` - `String`	Map of host public keys to score override values. Default = `null`

Example

{
  "allowRedundantIPs": false,
  "maxDowntimeHours": 987,
  "minProtocolVersion": "abc123",
  "maxConsecutiveScanFailures": 123,
  "scoreOverrides": "abc123"
}

Types

HostsPriceTablesRequestInput

Fields

Input Field	Description
`priceTableUpdates` - `[String!]`	List of price table updates (host -> updated price table info). Default = `null`

Example

{"priceTableUpdates": ["abc123"]}

Types

HostsRemoveRequestInput

Fields

Input Field	Description
`maxDowntimeHours` - `String`
`maxConsecutiveScanFailures` - `Int`

Example

{
  "maxDowntimeHours": "abc123",
  "maxConsecutiveScanFailures": 123
}

Types

HostsScanRequestInput

Fields

Input Field	Description
`scans` - `[HostScanInput!]`	List of host scan results. Default = `null`

Example

{"scans": [HostScanInput]}

Types

IndexMode

Values

Enum Value	Description
`PERSONAL`	Personal mode - indexes only relevant transactions.
`FULL`	Full mode - indexes all transactions.
`NONE`	None mode - does not index transactions.

Example

"PERSONAL"

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

IntegrityCheckResult

Fields

Field Name	Description
`start` - `DateTime`	Start time of the integrity check
`end` - `DateTime`	End time of the integrity check
`checkedSectors` - `Int`	Number of sectors that were checked
`totalSectors` - `Int`	Total number of sectors in the contract
`badSectors` - `[IntegrityResult!]`	List of sectors that failed the integrity check

Example

{
  "start": "2007-12-03T10:15:30Z",
  "end": "2007-12-03T10:15:30Z",
  "checkedSectors": 123,
  "totalSectors": 987,
  "badSectors": [IntegrityResult]
}

Types

IntegrityResult

Fields

Field Name	Description
`expectedRoot` - `Hash256`	The expected root hash for this sector
`actualRoot` - `Hash256`	The actual root hash found during verification
`error` - `String`	Error message if verification failed

Example

{
  "expectedRoot": Hash256,
  "actualRoot": Hash256,
  "error": "xyz789"
}

Types

JSON

Description

The JSON scalar type represents JSON values as specified by ECMA-404.

Example

{}

Types

MemoryResponse

Fields

Field Name	Description
`download` - `MemoryStatus`
`upload` - `MemoryStatus`

Example

{
  "download": MemoryStatus,
  "upload": MemoryStatus
}

Types

MemoryStatus

Fields

Field Name	Description
`available` - `Int`	The amount of remaining memory currently available in bytes
`total` - `Int`	The total amount of memory available in bytes \| Minimum: 1

Example

{"available": 987, "total": 123}

Types

Metrics

Fields

Field Name	Description
`accounts` - `Accounts`
`revenue` - `RevenueMetrics`
`pricing` - `Pricing`
`contracts` - `Contracts`
`storage` - `Storage`
`registry` - `Registry`
`data` - `DataMetrics`
`wallet` - `WalletMetrics`
`timestamp` - `DateTime`

Example

{
  "accounts": Accounts,
  "revenue": RevenueMetrics,
  "pricing": Pricing,
  "contracts": Contracts,
  "storage": Storage,
  "registry": Registry,
  "data": DataMetrics,
  "wallet": WalletMetrics,
  "timestamp": "2007-12-03T10:15:30Z"
}

Types

MetricsInterval

Values

Enum Value	Description
`FIVE_MINUTES`	5 minute interval
`FIFTEEN_MINUTES`	15 minute interval
`HOURLY`	1 hour interval
`DAILY`	1 day interval
`WEEKLY`	1 week interval
`MONTHLY`	1 month interval
`YEARLY`	1 year interval

Example

"FIVE_MINUTES"

Types

MigrateSlabResponse

Fields

Field Name	Description
`numShardsMigrated` - `Int`
`surchargeApplied` - `Boolean`
`error` - `String`

Example

{
  "numShardsMigrated": 123,
  "surchargeApplied": true,
  "error": "abc123"
}

Types

MigrationSlabsRequestInput

Fields

Input Field	Description
`contractSet` - `String`
`healthCutoff` - `Float`
`limit` - `Int`

Example

{
  "contractSet": "abc123",
  "healthCutoff": 123.45,
  "limit": 123
}

Types

MultipartAbortRequestInput

Fields

Input Field	Description
`bucket` - `String`
`key` - `String`
`uploadID` - `String`

Example

{
  "bucket": "xyz789",
  "key": "abc123",
  "uploadID": "xyz789"
}

Types

MultipartAddPartRequestInput

Fields

Input Field	Description
`bucket` - `String`
`eTag` - `String`
`path` - `String`
`contractSet` - `String`
`uploadID` - `String`
`partNumber` - `Int`
`slices` - `[SlabSliceInput!]`	List of slices (object.SlabSlice). Default = `null`

Example

{
  "bucket": "abc123",
  "eTag": "abc123",
  "path": "abc123",
  "contractSet": "abc123",
  "uploadID": "xyz789",
  "partNumber": 123,
  "slices": [SlabSliceInput]
}

Types

MultipartCompleteRequestInput

Fields

Input Field	Description
`bucket` - `String`
`metadata` - `String`	ObjectUserMetadata. Default = `null`
`key` - `String`
`uploadID` - `String`
`parts` - `[MultipartCompletedPartInput!]`

Example

{
  "bucket": "abc123",
  "metadata": "abc123",
  "key": "abc123",
  "uploadID": "abc123",
  "parts": [MultipartCompletedPartInput]
}

Types

MultipartCompleteResponse

Fields

Field Name	Description
`eTag` - `ETag`

Example

{"eTag": ETag}

Types

MultipartCompletedPartInput

Fields

Input Field	Description
`partNumber` - `Int`	The number of this part. Default = `null`
`eTag` - `String`

Example

{"partNumber": 123, "eTag": "xyz789"}

Types

MultipartCreateRequestInput

Fields

Input Field	Description
`bucket` - `String`
`key` - `String`
`mimeType` - `String`
`metadata` - `String`	ObjectUserMetadata. Default = `null`
`disableClientSideEncryption` - `Boolean`

Example

{
  "bucket": "abc123",
  "key": "xyz789",
  "mimeType": "abc123",
  "metadata": "abc123",
  "disableClientSideEncryption": false
}

Types

MultipartCreateResponse

Fields

Field Name	Description
`uploadID` - `String`

Example

{"uploadID": "xyz789"}

Types

MultipartListPartItem

Fields

Field Name	Description
`partNumber` - `Int`	The number of this part
`lastModified` - `DateTime`	When this part was last modified
`eTag` - `ETag`
`size` - `Int`	The size of this part in bytes

Example

{
  "partNumber": 987,
  "lastModified": "2007-12-03T10:15:30Z",
  "eTag": ETag,
  "size": 987
}

Types

MultipartListPartsRequestInput

Fields

Input Field	Description
`bucket` - `String`
`path` - `String`
`uploadID` - `String`
`partNumberMarker` - `Int`
`limit` - `Int`

Example

{
  "bucket": "xyz789",
  "path": "abc123",
  "uploadID": "xyz789",
  "partNumberMarker": 987,
  "limit": 987
}

Types

MultipartListPartsResponse

Fields

Field Name	Description
`hasMore` - `Boolean`
`nextMarker` - `Int`
`parts` - `[MultipartListPartItem!]`

Example

{
  "hasMore": false,
  "nextMarker": 987,
  "parts": [MultipartListPartItem]
}

Types

MultipartListUploadsRequestInput

Fields

Input Field	Description
`bucket` - `String`
`prefix` - `String`
`pathMarker` - `String`
`uploadIDMarker` - `String`
`limit` - `Int`

Example

{
  "bucket": "abc123",
  "prefix": "abc123",
  "pathMarker": "xyz789",
  "uploadIDMarker": "xyz789",
  "limit": 987
}

Types

MultipartListUploadsResponse

Fields

Field Name	Description
`hasMore` - `Boolean`
`nextMarker` - `String`
`nextUploadIDMarker` - `String`
`uploads` - `[MultipartUpload!]`

Example

{
  "hasMore": false,
  "nextMarker": "abc123",
  "nextUploadIDMarker": "abc123",
  "uploads": [MultipartUpload]
}

Types

MultipartUpload

Fields

Field Name	Description
`bucket` - `String`	The name of the bucket
`key` - `EncryptionKey`
`path` - `String`
`uploadID` - `String`
`createdAt` - `DateTime`

Example

{
  "bucket": "xyz789",
  "key": EncryptionKey,
  "path": "xyz789",
  "uploadID": "abc123",
  "createdAt": "2007-12-03T10:15:30Z"
}

Types

Network

Fields

Field Name	Description
`name` - `String`	The name of the network
`initialCoinbase` - `Currency`	The initial coinbase reward
`minimumCoinbase` - `Currency`	The minimum coinbase reward
`initialTarget` - `BlockID`	The initial target
`blockInterval` - `Duration`	The block interval
`maturityDelay` - `Int`	The maturity delay
`hardforkDevAddr` - `HardforkDevAddr`
`hardforkTax` - `HardforkTax`
`hardforkStorageProof` - `HardforkStorageProof`
`hardforkOak` - `HardforkOak`
`hardforkASIC` - `HardforkASIC`
`hardforkFoundation` - `HardforkFoundation`
`hardforkV2` - `HardforkV2`

Example

{
  "name": "xyz789",
  "initialCoinbase": "USD",
  "minimumCoinbase": "USD",
  "initialTarget": BlockID,
  "blockInterval": "P3Y6M4DT12H30M5S",
  "maturityDelay": 123,
  "hardforkDevAddr": HardforkDevAddr,
  "hardforkTax": HardforkTax,
  "hardforkStorageProof": HardforkStorageProof,
  "hardforkOak": HardforkOak,
  "hardforkASIC": HardforkASIC,
  "hardforkFoundation": HardforkFoundation,
  "hardforkV2": HardforkV2
}

Types

Object

Fields

Field Name	Description
`metadata` - `ObjectMetadata`
`key` - `EncryptionKey`
`slabs` - `[SlabSlice!]`
`eTag` - `String`
`health` - `Float`
`modTime` - `DateTime`
`name` - `String`
`size` - `Int`
`mimeType` - `String`

Example

{
  "metadata": ObjectMetadata,
  "key": EncryptionKey,
  "slabs": [SlabSlice],
  "eTag": "abc123",
  "health": 987.65,
  "modTime": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "size": 123,
  "mimeType": "xyz789"
}

Types

ObjectMetadata

Fields

Field Name	Description
`eTag` - `String`	The ETag of the object
`health` - `Float`	The health of the object
`modTime` - `DateTime`	When the object was last modified
`name` - `String`	The name of the object
`size` - `Int`	The size of the object in bytes
`mimeType` - `String`	The MIME type of the object

Example

{
  "eTag": "xyz789",
  "health": 123.45,
  "modTime": "2007-12-03T10:15:30Z",
  "name": "abc123",
  "size": 987,
  "mimeType": "abc123"
}

Types

ObjectsListRequestInput

Fields

Input Field	Description
`bucket` - `String`
`limit` - `Int`
`sortBy` - `String`
`sortDir` - `String`
`prefix` - `String`
`marker` - `String`

Example

{
  "bucket": "abc123",
  "limit": 987,
  "sortBy": "xyz789",
  "sortDir": "abc123",
  "prefix": "abc123",
  "marker": "abc123"
}

Types

ObjectsListResponse

Fields

Field Name	Description
`hasMore` - `Boolean`	Whether there are more objects to list
`nextMarker` - `String`	Marker for the next page of results
`objects` - `[ObjectMetadata!]`	List of object metadata entries

Example

{
  "hasMore": false,
  "nextMarker": "xyz789",
  "objects": [ObjectMetadata]
}

Types

ObjectsRenameRequestInput

Fields

Input Field	Description
`bucket` - `String`
`force` - `Boolean`
`from` - `String`
`to` - `String`
`mode` - `String`

Example

{
  "bucket": "abc123",
  "force": false,
  "from": "abc123",
  "to": "xyz789",
  "mode": "xyz789"
}

Types

ObjectsStatsResponse

Fields

Field Name	Description
`numObjects` - `Int`
`numUnfinishedObjects` - `Int`
`minHealth` - `Float`
`totalObjectsSize` - `Int`
`totalUnfinishedObjectsSize` - `Int`
`totalSectorsSize` - `Int`
`totalUploadedSize` - `Int`

Example

{
  "numObjects": 987,
  "numUnfinishedObjects": 123,
  "minHealth": 123.45,
  "totalObjectsSize": 987,
  "totalUnfinishedObjectsSize": 987,
  "totalSectorsSize": 987,
  "totalUploadedSize": 123
}

Types

PackedSlab

Fields

Field Name	Description
`bufferID` - `Int`	ID of the buffer containing the slab
`shards` - `[Sector!]`

Example

{"bufferID": 123, "shards": [Sector]}

Types

PackedSlabsRequestGETInput

Fields

Input Field	Description
`lockingDuration` - `String`
`minShards` - `Int`
`totalShards` - `Int`
`contractSet` - `String`
`limit` - `Int`

Example

{
  "lockingDuration": "abc123",
  "minShards": 987,
  "totalShards": 987,
  "contractSet": "abc123",
  "limit": 987
}

Types

PackedSlabsRequestPOSTInput

Fields

Input Field	Description
`slabs` - `[UploadedPackedSlabInput!]`

Example

{"slabs": [UploadedPackedSlabInput]}

Types

PaginationInput

Fields

Input Field	Description
`offset` - `Int!`
`limit` - `Int!`

Example

{"offset": 123, "limit": 123}

Types

Peer

Fields

Field Name	Description
`address` - `String`
`inbound` - `Boolean`
`version` - `String`
`firstSeen` - `DateTime`
`connectedSince` - `DateTime`
`syncedBlocks` - `Int`
`syncDuration` - `Duration`

Example

{
  "address": "xyz789",
  "inbound": true,
  "version": "abc123",
  "firstSeen": "2007-12-03T10:15:30Z",
  "connectedSince": "2007-12-03T10:15:30Z",
  "syncedBlocks": 123,
  "syncDuration": "P3Y6M4DT12H30M5S"
}

Types

Fields

Field Name	Description
`pinned` - `Boolean`	Whether pin is enabled
`value` - `Float`	The value of the underlying currency to which the setting is pinned

Example

{"pinned": false, "value": 987.65}

Types

PinInput

Fields

Input Field	Description
`pinned` - `Boolean`	Whether pin is enabled. Default = `null`
`value` - `Float`	The value of the underlying currency to which the setting is pinned. Default = `null`

Example

{"pinned": false, "value": 123.45}

Types

PinnedSettings

Fields

Field Name	Description
`currency` - `String`
`threshold` - `Float`
`storage` - `Pin`
`ingress` - `Pin`
`egress` - `Pin`
`maxCollateral` - `Pin`

Example

{
  "currency": "xyz789",
  "threshold": 987.65,
  "storage": Pin,
  "ingress": Pin,
  "egress": Pin,
  "maxCollateral": Pin
}

Types

PinnedSettingsInput

Fields

Input Field	Description
`currency` - `String`
`threshold` - `Float`
`storage` - `PinInput`
`ingress` - `PinInput`
`egress` - `PinInput`
`maxCollateral` - `PinInput`

Example

{
  "currency": "xyz789",
  "threshold": 123.45,
  "storage": PinInput,
  "ingress": PinInput,
  "egress": PinInput,
  "maxCollateral": PinInput
}

Types

Pricing

Fields

Field Name	Description
`contractPrice` - `Currency`
`ingressPrice` - `Currency`
`egressPrice` - `Currency`
`baseRPCPrice` - `Currency`
`sectorAccessPrice` - `Currency`
`storagePrice` - `Currency`
`collateralMultiplier` - `Float`

Example

{
  "contractPrice": "USD",
  "ingressPrice": "USD",
  "egressPrice": "USD",
  "baseRPCPrice": "USD",
  "sectorAccessPrice": "USD",
  "storagePrice": "USD",
  "collateralMultiplier": 987.65
}

Types

PublicKey

Description

A ed25519 public key | Pattern: ^ed25519:[0-9a-fA-F]{64}$

Example

PublicKey

Types

RHPData

Fields

Field Name	Description
`ingress` - `Int`	The number of bytes received by the host
`egress` - `Int`	The number of bytes sent by the host

Example

{"ingress": 123, "egress": 123}

Types

RHPPriceTableRequestInput

Fields

Input Field	Description
`hostKey` - `String`
`siamuxAddr` - `String`
`timeout` - `String`

Example

{
  "hostKey": "xyz789",
  "siamuxAddr": "xyz789",
  "timeout": "abc123"
}

Types

RHPScanRequestInput

Fields

Input Field	Description
`hostKey` - `String`
`hostIP` - `String`
`timeout` - `String`

Example

{
  "hostKey": "xyz789",
  "hostIP": "abc123",
  "timeout": "xyz789"
}

Types

RHPScanResponse

Fields

Field Name	Description
`ping` - `DurationMS`
`scanError` - `String`
`settings` - `HostV2Settings`
`priceTable` - `HostPriceTable`

Example

{
  "ping": DurationMS,
  "scanError": "abc123",
  "settings": HostV2Settings,
  "priceTable": HostPriceTable
}

Types

RedundancySettings

Fields

Field Name	Description
`minShards` - `Int`	The number of data shards a piece of an object gets erasure-coded into \| Minimum: 1
`totalShards` - `Int`	The number of total data shards a piece of an object gets erasure-coded into \| Minimum: 2

Example

{"minShards": 123, "totalShards": 123}

Types

RedundancySettingsInput

Fields

Input Field	Description
`minShards` - `Int`	The number of data shards a piece of an object gets erasure-coded into \| Minimum: 1. Default = `null`
`totalShards` - `Int`	The number of total data shards a piece of an object gets erasure-coded into \| Minimum: 2. Default = `null`

Example

{"minShards": 123, "totalShards": 987}

Types

RegisterWebHookRequestInput

Fields

Input Field	Description
`callbackURL` - `String`
`scopes` - `[String!]`

Example

{
  "callbackURL": "abc123",
  "scopes": ["xyz789"]
}

Types

Registry

Fields

Field Name	Description
`entries` - `Int`
`maxEntries` - `Int`
`reads` - `Int`
`writes` - `Int`

Example

{"entries": 987, "maxEntries": 987, "reads": 987, "writes": 123}

Types

RescanResponse

Fields

Field Name	Description
`startIndex` - `ChainIndex`	types.ChainIndex
`index` - `ChainIndex`	types.ChainIndex
`startTime` - `DateTime`
`error` - `String`

Example

{
  "startIndex": ChainIndex,
  "index": ChainIndex,
  "startTime": "2007-12-03T10:15:30Z",
  "error": "abc123"
}

Types

ResizeVolumeRequestInput

Fields

Input Field	Description
`maxSectors` - `Int`

Example

{"maxSectors": 987}

Types

Revenue

Fields

Field Name	Description
`rpc` - `Currency`
`storage` - `Currency`
`ingress` - `Currency`
`egress` - `Currency`
`registryRead` - `Currency`
`registryWrite` - `Currency`

Example

{
  "rpc": "USD",
  "storage": "USD",
  "ingress": "USD",
  "egress": "USD",
  "registryRead": "USD",
  "registryWrite": "USD"
}

Types

RevenueMetrics

Fields

Field Name	Description
`potential` - `Revenue`
`earned` - `Revenue`

Example

{
  "potential": Revenue,
  "earned": Revenue
}

Types

RevertUpdate

Fields

Field Name	Description
`update` - `JSON`	consensus.RevertUpdate
`state` - `JSON`	consensus.State
`block` - `Block`	types.Block

Example

{"update": {}, "state": {}, "block": Block}

Types

RevisionNumber

Description

The revision number of the contract

Example

RevisionNumber

Types

SatisfiedPolicy

Fields

Field Name	Description
`policy` - `JSON`
`signature` - `[Signature!]`
`preimages` - `[String!]`

Example

{
  "policy": {},
  "signature": [Signature],
  "preimages": ["abc123"]
}

Types

SatisfiedPolicyInput

Fields

Input Field	Description
`policy` - `String`
`signature` - `[String!]`
`preimages` - `[String!]`

Example

{
  "policy": "abc123",
  "signature": ["xyz789"],
  "preimages": ["xyz789"]
}

Types

SearchHostsRequestInput

Fields

Input Field	Description
`offset` - `Int`
`limit` - `Int`
`autopilotID` - `String`
`filterMode` - `String`
`usabilityMode` - `String`
`addressContains` - `String`
`keyIn` - `[String!]`

Example

{
  "offset": 987,
  "limit": 987,
  "autopilotID": "xyz789",
  "filterMode": "xyz789",
  "usabilityMode": "abc123",
  "addressContains": "xyz789",
  "keyIn": ["xyz789"]
}

Types

Sector

Fields

Field Name	Description
`contracts` - `JSON`
`latestHost` - `PublicKey`
`root` - `Hash256`

Example

{
  "contracts": {},
  "latestHost": PublicKey,
  "root": Hash256
}

Types

SectorInput

Fields

Input Field	Description
`contracts` - `String`
`latestHost` - `String`
`root` - `String`

Example

{
  "contracts": "abc123",
  "latestHost": "xyz789",
  "root": "xyz789"
}

Types

SettingsID

Description

A 16-byte unique identifier represented as a hex string.

Example

SettingsID

Types

Severity

Values

Enum Value	Description
`INFO`	Indicates that the alert is informational.
`WARNING`	Indicates that the alert is a warning.
`ERROR`	Indicates that the alert is an error.
`CRITICAL`	Indicates that the alert is critical.

Example

"INFO"

Types

SiacoinElement

Fields

Field Name	Description
`value` - `Currency`	The amount of Siacoins in the output
`address` - `Address`
`id` - `SiacoinOutputID`	The ID of the element
`maturityHeight` - `Int`	The block height when the output matures

Example

{
  "value": "USD",
  "address": Address,
  "id": SiacoinOutputID,
  "maturityHeight": 123
}

Types

SiacoinElementInput

Fields

Input Field	Description
`value` - `String`	The amount of Siacoins in the output. Default = `null`
`address` - `String`
`id` - `String`	The ID of the element. Default = `null`
`maturityHeight` - `Int`	The block height when the output matures. Default = `null`

Example

{
  "value": "xyz789",
  "address": "abc123",
  "id": "xyz789",
  "maturityHeight": 987
}

Types

SiacoinInput

Fields

Field Name	Description
`parentID` - `SiacoinOutputID`	The ID of the output being spent
`unlockConditions` - `UnlockConditions`	The unlock conditions required to spend the output

Example

{
  "parentID": SiacoinOutputID,
  "unlockConditions": UnlockConditions
}

Types

SiacoinInputInput

Fields

Input Field	Description
`parentID` - `String`	The ID of the output being spent. Default = `null`
`unlockConditions` - `UnlockConditionsInput`	The unlock conditions required to spend the output. Default = `null`

Example

{
  "parentID": "xyz789",
  "unlockConditions": UnlockConditionsInput
}

Types

SiacoinOutput

Fields

Field Name	Description
`value` - `Currency`	The amount of Siacoins in the output
`address` - `Address`

Example

{
  "value": "USD",
  "address": Address
}

Types

SiacoinOutputID

Description

Unique identifier for a Siacoin output.

Example

SiacoinOutputID

Types

SiacoinOutputInput

Fields

Input Field	Description
`value` - `String`	The amount of Siacoins in the output. Default = `null`
`address` - `String`

Example

{
  "value": "xyz789",
  "address": "xyz789"
}

Types

SiafundElement

Fields

Field Name	Description
`id` - `SiafundOutputID`	The ID of the element
`stateElement` - `StateElement`	The state of the element
`siafundOutput` - `SiafundOutput`	The output of the element
`claimStart` - `Currency`	value of SiafundTaxRevenue when element was created

Example

{
  "id": SiafundOutputID,
  "stateElement": StateElement,
  "siafundOutput": SiafundOutput,
  "claimStart": "USD"
}

Types

SiafundElementInput

Fields

Input Field	Description
`id` - `String`	The ID of the element. Default = `null`
`stateElement` - `StateElementInput`	The state of the element. Default = `null`
`siafundOutput` - `SiafundOutputInput`	The output of the element. Default = `null`
`claimStart` - `String`	value of SiafundTaxRevenue when element was created. Default = `null`

Example

{
  "id": "xyz789",
  "stateElement": StateElementInput,
  "siafundOutput": SiafundOutputInput,
  "claimStart": "abc123"
}

Types

SiafundInput

Fields

Field Name	Description
`parentID` - `SiafundOutputID`	The ID of the parent Siafund output being spent.
`unlockConditions` - `UnlockConditions`	The conditions required to unlock the parent Siafund output.
`claimAddress` - `Address`	The address receiving the Siacoin claim generated by the Siafund output.

Example

{
  "parentID": SiafundOutputID,
  "unlockConditions": UnlockConditions,
  "claimAddress": Address
}

Types

SiafundInputInput

Fields

Input Field	Description
`parentID` - `String`	The ID of the parent Siafund output being spent. Default = `null`
`unlockConditions` - `UnlockConditionsInput`	The conditions required to unlock the parent Siafund output. Default = `null`
`claimAddress` - `String`	The address receiving the Siacoin claim generated by the Siafund output. Default = `null`

Example

{
  "parentID": "abc123",
  "unlockConditions": UnlockConditionsInput,
  "claimAddress": "xyz789"
}

Types

SiafundOutput

Fields

Field Name	Description
`value` - `Int`	The amount of Siafund in the output.
`address` - `Address`	The address receiving the Siafund.

Example

{"value": 987, "address": Address}

Types

SiafundOutputID

Description

Unique identifier for a Siafund output.

Example

SiafundOutputID

Types

SiafundOutputInput

Fields

Input Field	Description
`value` - `Int`	The amount of Siafund in the output. Default = `null`
`address` - `String`	The address receiving the Siafund. Default = `null`

Example

{"value": 987, "address": "xyz789"}

Types

Signature

Description

A ed25519 signature | Pattern: [0-9a-fA-F]{64}

Example

Signature

Types

Slab

Fields

Field Name	Description
`health` - `Float`	Minimum: 0 \| Maximum: 1
`key` - `EncryptionKey`
`minShards` - `Int`	The number of data shards the slab is split into \| Minimum: 1 \| Maximum: 255
`shards` - `[Sector!]`	List of sectors

Example

{
  "health": 123.45,
  "key": EncryptionKey,
  "minShards": 123,
  "shards": [Sector]
}

Types

SlabBuffer

Fields

Field Name	Description
`contractSet` - `String`	Contract set that be buffer will be uploaded to
`complete` - `Boolean`	Whether the slab buffer is complete and ready to upload
`filename` - `String`	Name of the buffer on disk
`size` - `Int`	Size of the buffer
`maxSize` - `Int`	Maximum size of the buffer
`locked` - `Boolean`	Whether the slab buffer is locked for uploading

Example

{
  "contractSet": "abc123",
  "complete": true,
  "filename": "xyz789",
  "size": 987,
  "maxSize": 123,
  "locked": true
}

Types

SlabInput

Fields

Input Field	Description
`health` - `Float`	Minimum: 0 \| Maximum: 1. Default = `null`
`key` - `String`
`minShards` - `Int`	The number of data shards the slab is split into \| Minimum: 1 \| Maximum: 255. Default = `null`
`shards` - `[SectorInput!]`	List of sectors. Default = `null`

Example

{
  "health": 123.45,
  "key": "xyz789",
  "minShards": 123,
  "shards": [SectorInput]
}

Types

SlabSlice

Fields

Field Name	Description
`health` - `Float`	Minimum: 0 \| Maximum: 1
`key` - `EncryptionKey`
`minShards` - `Int`	The number of data shards the slab is split into \| Minimum: 1 \| Maximum: 255
`shards` - `[Sector!]`	List of sectors
`offset` - `Int`
`limit` - `Int`

Example

{
  "health": 987.65,
  "key": EncryptionKey,
  "minShards": 987,
  "shards": [Sector],
  "offset": 987,
  "limit": 987
}

Types

SlabSliceInput

Fields

Input Field	Description
`health` - `Float`	Minimum: 0 \| Maximum: 1. Default = `null`
`key` - `String`
`minShards` - `Int`	The number of data shards the slab is split into \| Minimum: 1 \| Maximum: 255. Default = `null`
`shards` - `[SectorInput!]`	List of sectors. Default = `null`
`offset` - `Int`
`limit` - `Int`

Example

{
  "health": 123.45,
  "key": "abc123",
  "minShards": 123,
  "shards": [SectorInput],
  "offset": 123,
  "limit": 987
}

Types

SortDirection

Values

Enum Value	Description
`ASC`
`DESC`

Example

"ASC"

Types

SortInput

Fields

Input Field	Description
`field` - `String!`
`direction` - `SortDirection!`

Example

{"field": "abc123", "direction": "ASC"}

Types

Specifier

Description

// A Specifier is a fixed-size, 0-padded identifier

Example

Specifier

Types

StateElement

Fields

Field Name	Description
`leafIndex` - `Int!`	The index of the element in the Merkle tree
`merkleProof` - `[Hash256!]`	The Merkle proof demonstrating the inclusion of the leaf

Example

{"leafIndex": 123, "merkleProof": [Hash256]}

Types

StateElementInput

Fields

Input Field	Description
`leafIndex` - `Int!`	The index of the element in the Merkle tree
`merkleProof` - `[String!]`	The Merkle proof demonstrating the inclusion of the leaf. Default = `null`

Example

{
  "leafIndex": 987,
  "merkleProof": ["abc123"]
}

Types

StateResponse

Fields

Field Name	Description
`version` - `String`
`commit` - `String`
`os` - `String`
`buildTime` - `DateTime`
`startTime` - `DateTime`
`indexMode` - `IndexMode`

Example

{
  "version": "xyz789",
  "commit": "xyz789",
  "os": "xyz789",
  "buildTime": "2007-12-03T10:15:30Z",
  "startTime": "2007-12-03T10:15:30Z",
  "indexMode": "PERSONAL"
}

Types

Storage

Fields

Field Name	Description
`totalSectors` - `Int`
`physicalSectors` - `Int`
`lostSectors` - `Int`
`contractSectors` - `Int`
`tempSectors` - `Int`
`reads` - `Int`
`writes` - `Int`
`sectorCacheHits` - `Int`
`sectorCacheMisses` - `Int`

Example

{
  "totalSectors": 987,
  "physicalSectors": 987,
  "lostSectors": 987,
  "contractSectors": 987,
  "tempSectors": 987,
  "reads": 987,
  "writes": 123,
  "sectorCacheHits": 987,
  "sectorCacheMisses": 987
}

Types

StorageProof

Fields

Field Name	Description
`parentID` - `FileContractID`	The ID of the file contract being proven.
`leaf` - `String`	The selected leaf from the Merkle tree of the file's data.
`proof` - `[Hash256!]`	The Merkle proof demonstrating the inclusion of the leaf.

Example

{
  "parentID": FileContractID,
  "leaf": "abc123",
  "proof": [Hash256]
}

Types

StorageProofInput

Fields

Input Field	Description
`parentID` - `String`	The ID of the file contract being proven. Default = `null`
`leaf` - `String`	The selected leaf from the Merkle tree of the file's data. Default = `null`
`proof` - `[String!]`	The Merkle proof demonstrating the inclusion of the leaf. Default = `null`

Example

{
  "parentID": "abc123",
  "leaf": "xyz789",
  "proof": ["xyz789"]
}

Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example

"xyz789"

Types

SystemDirResponse

Fields

Field Name	Description
`path` - `String`
`totalBytes` - `Int`
`freeBytes` - `Int`
`directories` - `[String!]`

Example

{
  "path": "xyz789",
  "totalBytes": 123,
  "freeBytes": 123,
  "directories": ["abc123"]
}

Types

Transaction

Fields

Field Name	Description
`siacoinInputs` - `[SiacoinInput!]`	List of Siacoin inputs used in the transaction.
`siacoinOutputs` - `[SiacoinOutput!]`	List of Siacoin outputs created by the transaction.
`fileContracts` - `[FileContract!]`	List of file contracts created by the transaction.
`fileContractRevisions` - `[FileContractRevision!]`	List of revisions to existing file contracts included in the transaction.
`storageProofs` - `[StorageProof!]`	List of storage proofs asserting the storage of data for file contracts.
`siafundInputs` - `[SiafundInput!]`	List of Siafund inputs spent in the transaction.
`siafundOutputs` - `[SiafundOutput!]`	List of Siafund outputs created by the transaction.
`minerFees` - `[Currency!]`	List of miner fees included in the transaction.
`arbitraryData` - `[String!]`	Arbitrary binary data included in the transaction.
`signatures` - `[TransactionSignature!]`	List of cryptographic signatures verifying the transaction.

Example

{
  "siacoinInputs": [SiacoinInput],
  "siacoinOutputs": [SiacoinOutput],
  "fileContracts": [FileContract],
  "fileContractRevisions": [FileContractRevision],
  "storageProofs": [StorageProof],
  "siafundInputs": [SiafundInput],
  "siafundOutputs": [SiafundOutput],
  "minerFees": ["USD"],
  "arbitraryData": ["xyz789"],
  "signatures": [TransactionSignature]
}

Types

TransactionID

Description

Unique identifier for a transaction.

Example

TransactionID

Types

TransactionInput

Fields

Input Field	Description
`siacoinInputs` - `[SiacoinInputInput!]`	List of Siacoin inputs used in the transaction. Default = `null`
`siacoinOutputs` - `[SiacoinOutputInput!]`	List of Siacoin outputs created by the transaction. Default = `null`
`fileContracts` - `[FileContractInput!]`	List of file contracts created by the transaction. Default = `null`
`fileContractRevisions` - `[FileContractRevisionInput!]`	List of revisions to existing file contracts included in the transaction. Default = `null`
`storageProofs` - `[StorageProofInput!]`	List of storage proofs asserting the storage of data for file contracts. Default = `null`
`siafundInputs` - `[SiafundInputInput!]`	List of Siafund inputs spent in the transaction. Default = `null`
`siafundOutputs` - `[SiafundOutputInput!]`	List of Siafund outputs created by the transaction. Default = `null`
`minerFees` - `[String!]`	List of miner fees included in the transaction. Default = `null`
`arbitraryData` - `[String!]`	Arbitrary binary data included in the transaction. Default = `null`
`signatures` - `[TransactionSignatureInput!]`	List of cryptographic signatures verifying the transaction. Default = `null`

Example

{
  "siacoinInputs": [SiacoinInputInput],
  "siacoinOutputs": [SiacoinOutputInput],
  "fileContracts": [FileContractInput],
  "fileContractRevisions": [FileContractRevisionInput],
  "storageProofs": [StorageProofInput],
  "siafundInputs": [SiafundInputInput],
  "siafundOutputs": [SiafundOutputInput],
  "minerFees": ["abc123"],
  "arbitraryData": ["xyz789"],
  "signatures": [TransactionSignatureInput]
}

Types

TransactionSignature

Fields

Field Name	Description
`parentID` - `Hash256`	The ID of the transaction being signed
`publicKeyIndex` - `Int`	The index of the public key used to sign the transaction
`timelock` - `Int`	The block height at which the outputs in the transaction can be spent
`coveredFields` - `CoveredFields`	Indicates which fields of the transaction are covered by the signature
`signature` - `Signature`	The signature of the transaction

Example

{
  "parentID": Hash256,
  "publicKeyIndex": 123,
  "timelock": 987,
  "coveredFields": CoveredFields,
  "signature": Signature
}

Types

TransactionSignatureInput

Fields

Input Field	Description
`parentID` - `String`	The ID of the transaction being signed. Default = `null`
`publicKeyIndex` - `Int`	The index of the public key used to sign the transaction. Default = `null`
`timelock` - `Int`	The block height at which the outputs in the transaction can be spent. Default = `null`
`coveredFields` - `CoveredFieldsInput`	Indicates which fields of the transaction are covered by the signature. Default = `null`
`signature` - `String`	The signature of the transaction. Default = `null`

Example

{
  "parentID": "abc123",
  "publicKeyIndex": 123,
  "timelock": 123,
  "coveredFields": CoveredFieldsInput,
  "signature": "abc123"
}

Types

TxpoolBroadcastRequestInput

Fields

Input Field	Description
`transactions` - `[TransactionInput!]`	[]types.Transaction. Default = `null`
`v2transactions` - `[V2TransactionInput!]`	[]types.V2Transaction. Default = `null`

Example

{
  "transactions": [TransactionInput],
  "v2transactions": [V2TransactionInput]
}

Types

TxpoolTransactionsResponse

Fields

Field Name	Description
`transactions` - `[Transaction!]`	[]types.Transaction
`v2transactions` - `[V2Transaction!]`	[]types.V2Transaction

Example

{
  "transactions": [Transaction],
  "v2transactions": [V2Transaction]
}

Types

UnhealthySlab

Fields

Field Name	Description
`key` - `EncryptionKey`	Encryption key object (object.EncryptionKey)
`health` - `Float`

Example

{"key": EncryptionKey, "health": 123.45}

Types

UnhealthySlabsResponse

Fields

Field Name	Description
`slabs` - `[UnhealthySlab!]`	List of unhealthy slabs

Example

{"slabs": [UnhealthySlab]}

Types

UnlockConditions

Fields

Field Name	Description
`timelock` - `Int`	The block height at which the outputs can be spent
`publicKeys` - `[UnlockKey!]`
`signaturesRequired` - `Int`	The number of signatures required to spend the output

Example

{
  "timelock": 987,
  "publicKeys": [UnlockKey],
  "signaturesRequired": 987
}

Types

UnlockConditionsInput

Fields

Input Field	Description
`timelock` - `Int`	The block height at which the outputs can be spent. Default = `null`
`publicKeys` - `[UnlockKeyInput!]`
`signaturesRequired` - `Int`	The number of signatures required to spend the output. Default = `null`

Example

{
  "timelock": 123,
  "publicKeys": [UnlockKeyInput],
  "signaturesRequired": 987
}

Types

UnlockKey

Fields

Field Name	Description
`algorithm` - `Specifier`	A fixed 16-byte array that specifies the algorithm used to generatethe key
`key` - `String`	A 32-byte key represented as a hex-encoded string. Must be exactly64 characters long, containing only hexadecimal digits \| Pattern: ^[a-fA-F0-9]{64}$

Example

{
  "algorithm": Specifier,
  "key": "abc123"
}

Types

UnlockKeyInput

Fields

Input Field	Description
`algorithm` - `String`	A fixed 16-byte array that specifies the algorithm used to generatethe key. Default = `null`
`key` - `String`	A 32-byte key represented as a hex-encoded string. Must be exactly64 characters long, containing only hexadecimal digits \| Pattern: ^[a-fA-F0-9]{64}$. Default = `null`

Example

{
  "algorithm": "abc123",
  "key": "abc123"
}

Types

UpdateAllowlistRequestInput

Fields

Input Field	Description
`add` - `[String!]`
`remove` - `[String!]`
`clear` - `Boolean`

Example

{
  "add": ["abc123"],
  "remove": ["abc123"],
  "clear": false
}

Types

UpdateBlocklistRequestInput

Fields

Input Field	Description
`add` - `[String!]`
`remove` - `[String!]`
`clear` - `Boolean`

Example

{
  "add": ["abc123"],
  "remove": ["abc123"],
  "clear": true
}

Types

UpdateVolumeRequestInput

Fields

Input Field	Description
`readOnly` - `Boolean`

Example

{"readOnly": false}

Types

UploadObjectOptionsInput

Fields

Input Field	Description
`minShards` - `Int`
`totalShards` - `Int`
`contractSet` - `String`
`contentLength` - `Int`
`mimeType` - `String`
`metadata` - `String`	ObjectUserMetadata. Default = `null`

Example

{
  "minShards": 123,
  "totalShards": 987,
  "contractSet": "abc123",
  "contentLength": 123,
  "mimeType": "xyz789",
  "metadata": "xyz789"
}

Types

UploadObjectResponse

Fields

Field Name	Description
`etag` - `String`	ETag of the uploaded object

Example

{"etag": "abc123"}

Types

UploadParams

Fields

Field Name	Description
`consensusState` - `ConsensusState`
`gougingSettings` - `GougingSettings`
`redundancySettings` - `RedundancySettings`
`transactionFee` - `Currency`
`currentHeight` - `Int`	Current block height
`contractSet` - `String`	Contract set identifier
`uploadPacking` - `Boolean`	Whether upload packing is enabled

Example

{
  "consensusState": ConsensusState,
  "gougingSettings": GougingSettings,
  "redundancySettings": RedundancySettings,
  "transactionFee": "USD",
  "currentHeight": 123,
  "contractSet": "abc123",
  "uploadPacking": false
}

Types

UploadSectorRequestInput

Fields

Input Field	Description
`contractID` - `String`	Contract ID for the upload. Default = `null`
`root` - `String`	Root hash of the sector. Default = `null`

Example

{
  "contractID": "abc123",
  "root": "abc123"
}

Types

UploadStatsResponse

Fields

Field Name	Description
`avgSlabUploadSpeedMbps` - `Float`
`avgOverdrivePct` - `Float`
`healthyUploaders` - `Int`
`numUploaders` - `Int`
`uploadersStats` - `[UploaderStats!]`

Example

{
  "avgSlabUploadSpeedMbps": 123.45,
  "avgOverdrivePct": 987.65,
  "healthyUploaders": 987,
  "numUploaders": 987,
  "uploadersStats": [UploaderStats]
}

Types

UploadedPackedSlabInput

Fields

Input Field	Description
`bufferID` - `Int`	ID of the buffer. Default = `null`
`shards` - `[SectorInput!]`

Example

{"bufferID": 987, "shards": [SectorInput]}

Types

UploaderStats

Fields

Field Name	Description
`hostKey` - `PublicKey`
`avgSectorUploadSpeedMbps` - `Float`

Example

{"hostKey": PublicKey, "avgSectorUploadSpeedMbps": 123.45}

Types

Usage

Fields

Field Name	Description
`rpc` - `Currency`
`storage` - `Currency`
`egress` - `Currency`
`ingress` - `Currency`
`registryRead` - `Currency`
`registryWrite` - `Currency`
`accountFunding` - `Currency`
`riskedCollateral` - `Currency`

Example

{
  "rpc": "USD",
  "storage": "USD",
  "egress": "USD",
  "ingress": "USD",
  "registryRead": "USD",
  "registryWrite": "USD",
  "accountFunding": "USD",
  "riskedCollateral": "USD"
}

Types

V2BlockData

Fields

Field Name	Description
`height` - `Int`	The height of the block
`commitment` - `Hash256`
`transactions` - `[V2Transaction!]`

Example

{
  "height": 123,
  "commitment": Hash256,
  "transactions": [V2Transaction]
}

Types

V2BlockDataInput

Fields

Input Field	Description
`height` - `Int`	The height of the block. Default = `null`
`commitment` - `String`
`transactions` - `[V2TransactionInput!]`

Example

{
  "height": 123,
  "commitment": "abc123",
  "transactions": [V2TransactionInput]
}

Types

V2FileContract

Fields

Field Name	Description
`capacity` - `Int`
`filesize` - `Int`
`fileMerkleRoot` - `Hash256`
`proofHeight` - `Int`
`expirationHeight` - `Int`
`renterOutput` - `SiacoinOutput`
`hostOutput` - `SiacoinOutput`
`missedHostValue` - `Currency`
`totalCollateral` - `Currency`
`renterPublicKey` - `PublicKey`
`hostPublicKey` - `PublicKey`
`revisionNumber` - `RevisionNumber`
`renterSignature` - `Signature`
`hostSignature` - `Signature`

Example

{
  "capacity": 987,
  "filesize": 987,
  "fileMerkleRoot": Hash256,
  "proofHeight": 987,
  "expirationHeight": 987,
  "renterOutput": SiacoinOutput,
  "hostOutput": SiacoinOutput,
  "missedHostValue": "USD",
  "totalCollateral": "USD",
  "renterPublicKey": PublicKey,
  "hostPublicKey": PublicKey,
  "revisionNumber": RevisionNumber,
  "renterSignature": Signature,
  "hostSignature": Signature
}

Types

V2FileContractElement

Fields

Field Name	Description
`id` - `FileContractID`	The ID of the element
`stateElement` - `StateElement`	The state of the element
`v2FileContract` - `V2FileContract`

Example

{
  "id": FileContractID,
  "stateElement": StateElement,
  "v2FileContract": V2FileContract
}

Types

V2FileContractElementInput

Fields

Input Field	Description
`id` - `String`	The ID of the element. Default = `null`
`stateElement` - `StateElementInput`	The state of the element. Default = `null`
`v2FileContract` - `V2FileContractInput`

Example

{
  "id": "xyz789",
  "stateElement": StateElementInput,
  "v2FileContract": V2FileContractInput
}

Types

V2FileContractInput

Fields

Input Field	Description
`capacity` - `Int`
`filesize` - `Int`
`fileMerkleRoot` - `String`
`proofHeight` - `Int`
`expirationHeight` - `Int`
`renterOutput` - `SiacoinOutputInput`
`hostOutput` - `SiacoinOutputInput`
`missedHostValue` - `String`
`totalCollateral` - `String`
`renterPublicKey` - `String`
`hostPublicKey` - `String`
`revisionNumber` - `String`
`renterSignature` - `String`
`hostSignature` - `String`

Example

{
  "capacity": 987,
  "filesize": 123,
  "fileMerkleRoot": "abc123",
  "proofHeight": 987,
  "expirationHeight": 123,
  "renterOutput": SiacoinOutputInput,
  "hostOutput": SiacoinOutputInput,
  "missedHostValue": "abc123",
  "totalCollateral": "abc123",
  "renterPublicKey": "xyz789",
  "hostPublicKey": "abc123",
  "revisionNumber": "abc123",
  "renterSignature": "xyz789",
  "hostSignature": "xyz789"
}

Types

V2FileContractResolution

Fields

Field Name	Description
`parent` - `V2FileContractElement`
`resolution` - `JSON`

Example

{"parent": V2FileContractElement, "resolution": {}}

Types

V2FileContractResolutionInput

Fields

Input Field	Description
`parent` - `V2FileContractElementInput`
`resolution` - `String`

Example

{
  "parent": V2FileContractElementInput,
  "resolution": "xyz789"
}

Types

V2FileContractRevision

Fields

Field Name	Description
`parent` - `V2FileContractElement`
`revision` - `V2FileContract`

Example

{
  "parent": V2FileContractElement,
  "revision": V2FileContract
}

Types

V2FileContractRevisionInput

Fields

Input Field	Description
`parent` - `V2FileContractElementInput`
`revision` - `V2FileContractInput`

Example

{
  "parent": V2FileContractElementInput,
  "revision": V2FileContractInput
}

Types

V2SiacoinInput

Fields

Field Name	Description
`parent` - `SiacoinElement`
`satisfiedPolicy` - `SatisfiedPolicy`

Example

{
  "parent": SiacoinElement,
  "satisfiedPolicy": SatisfiedPolicy
}

Types

V2SiacoinInputInput

Fields

Input Field	Description
`parent` - `SiacoinElementInput`
`satisfiedPolicy` - `SatisfiedPolicyInput`

Example

{
  "parent": SiacoinElementInput,
  "satisfiedPolicy": SatisfiedPolicyInput
}

Types

V2SiafundInput

Fields

Field Name	Description
`parent` - `SiafundElement`
`claimAddress` - `Address`
`satisfiedPolicy` - `SatisfiedPolicy`

Example

{
  "parent": SiafundElement,
  "claimAddress": Address,
  "satisfiedPolicy": SatisfiedPolicy
}

Types

V2SiafundInputInput

Fields

Input Field	Description
`parent` - `SiafundElementInput`
`claimAddress` - `String`
`satisfiedPolicy` - `SatisfiedPolicyInput`

Example

{
  "parent": SiafundElementInput,
  "claimAddress": "xyz789",
  "satisfiedPolicy": SatisfiedPolicyInput
}

Types

V2Transaction

Fields

Field Name	Description
`siacoinInputs` - `[V2SiacoinInput!]`
`siacoinOutputs` - `[SiacoinOutput!]`
`siafundInputs` - `[V2SiafundInput!]`
`siafundOutputs` - `[SiafundOutput!]`
`fileContracts` - `[V2FileContract!]`
`fileContractRevisions` - `[V2FileContractRevision!]`
`fileContractResolutions` - `[V2FileContractResolution!]`
`attestations` - `[Attestation!]`
`arbitraryData` - `[String!]`
`newFoundationAddress` - `Address`
`minerFee` - `Currency`

Example

{
  "siacoinInputs": [V2SiacoinInput],
  "siacoinOutputs": [SiacoinOutput],
  "siafundInputs": [V2SiafundInput],
  "siafundOutputs": [SiafundOutput],
  "fileContracts": [V2FileContract],
  "fileContractRevisions": [V2FileContractRevision],
  "fileContractResolutions": [V2FileContractResolution],
  "attestations": [Attestation],
  "arbitraryData": ["abc123"],
  "newFoundationAddress": Address,
  "minerFee": "USD"
}

Types

V2TransactionInput

Fields

Input Field	Description
`siacoinInputs` - `[V2SiacoinInputInput!]`
`siacoinOutputs` - `[SiacoinOutputInput!]`
`siafundInputs` - `[V2SiafundInputInput!]`
`siafundOutputs` - `[SiafundOutputInput!]`
`fileContracts` - `[V2FileContractInput!]`
`fileContractRevisions` - `[V2FileContractRevisionInput!]`
`fileContractResolutions` - `[V2FileContractResolutionInput!]`
`attestations` - `[AttestationInput!]`
`arbitraryData` - `[String!]`
`newFoundationAddress` - `String`
`minerFee` - `String`

Example

{
  "siacoinInputs": [V2SiacoinInputInput],
  "siacoinOutputs": [SiacoinOutputInput],
  "siafundInputs": [V2SiafundInputInput],
  "siafundOutputs": [SiafundOutputInput],
  "fileContracts": [V2FileContractInput],
  "fileContractRevisions": [V2FileContractRevisionInput],
  "fileContractResolutions": [
    V2FileContractResolutionInput
  ],
  "attestations": [AttestationInput],
  "arbitraryData": ["xyz789"],
  "newFoundationAddress": "abc123",
  "minerFee": "xyz789"
}

Types

VerifySectorResponse

Fields

Field Name	Description
`sectorReference` - `JSON`
`error` - `String`

Example

{"sectorReference": {}, "error": "abc123"}

Types

Volume

Fields

Field Name	Description
`id` - `Int`	Unique identifier for the volume
`localPath` - `String`	Local filesystem path of the volume
`usedSectors` - `Int`	Number of sectors currently in use
`totalSectors` - `Int`	Total number of sectors available
`readOnly` - `Boolean`	Whether the volume is read-only
`available` - `Boolean`	Whether the volume is currently available

Example

{
  "id": 987,
  "localPath": "abc123",
  "usedSectors": 123,
  "totalSectors": 123,
  "readOnly": false,
  "available": true
}

Types

VolumeMeta

Fields

Field Name	Description
`id` - `Int`	Unique identifier for the volume
`localPath` - `String`	Local filesystem path of the volume
`usedSectors` - `Int`	Number of sectors currently in use
`totalSectors` - `Int`	Total number of sectors available
`readOnly` - `Boolean`	Whether the volume is read-only
`available` - `Boolean`	Whether the volume is currently available
`failedReads` - `Int`	Number of failed read operations
`failedWrites` - `Int`	Number of failed write operations
`successfulReads` - `Int`	Number of successful read operations
`successfulWrites` - `Int`	Number of successful write operations
`status` - `String`	Current status of the volume
`errors` - `[String!]`	List of error messages

Example

{
  "id": 987,
  "localPath": "xyz789",
  "usedSectors": 123,
  "totalSectors": 123,
  "readOnly": true,
  "available": true,
  "failedReads": 123,
  "failedWrites": 123,
  "successfulReads": 123,
  "successfulWrites": 123,
  "status": "abc123",
  "errors": ["abc123"]
}

Types

Wallet

Fields

Field Name	Description
`id` - `Int`
`name` - `String`
`description` - `String`
`dateCreated` - `DateTime`
`lastUpdated` - `DateTime`
`metadata` - `JSON`

Example

{
  "id": 123,
  "name": "xyz789",
  "description": "abc123",
  "dateCreated": "2007-12-03T10:15:30Z",
  "lastUpdated": "2007-12-03T10:15:30Z",
  "metadata": {}
}

Types

WalletEvent

Fields

Field Name	Description
`id` - `Hash256`	Unique identifier for the event
`index` - `ChainIndex`	Chain index where event occurred
`type` - `String`	Type of event
`data` - `JSON`	Event-specific data
`maturityHeight` - `Int`	Block height when event matures
`timestamp` - `DateTime`	Time event occurred
`relevant` - `[Address!]`	Relevant addresses

Example

{
  "id": Hash256,
  "index": ChainIndex,
  "type": "xyz789",
  "data": {},
  "maturityHeight": 987,
  "timestamp": "2007-12-03T10:15:30Z",
  "relevant": [Address]
}

Types

WalletFundRequestInput

Fields

Input Field	Description
`transaction` - `TransactionInput`
`amount` - `String`
`changeAddress` - `String`

Example

{
  "transaction": TransactionInput,
  "amount": "abc123",
  "changeAddress": "abc123"
}

Types

WalletFundResponse

Fields

Field Name	Description
`transaction` - `Transaction`	types.Transaction
`toSign` - `[Hash256!]`
`dependsOn` - `[Transaction!]`	[]types.Transaction

Example

{
  "transaction": Transaction,
  "toSign": [Hash256],
  "dependsOn": [Transaction]
}

Types

WalletFundSFRequestInput

Fields

Input Field	Description
`transaction` - `TransactionInput`	types.Transaction. Default = `null`
`amount` - `Int`
`changeAddress` - `String`	types.Address. Default = `null`
`claimAddress` - `String`	types.Address. Default = `null`

Example

{
  "transaction": TransactionInput,
  "amount": 123,
  "changeAddress": "xyz789",
  "claimAddress": "abc123"
}

Types

WalletMetrics

Fields

Field Name	Description
`balance` - `Currency`
`immatureBalance` - `Currency`

Example

{
  "balance": "USD",
  "immatureBalance": "USD"
}

Types

WalletRedistributeRequestInput

Fields

Input Field	Description
`amount` - `String`
`outputs` - `Int`

Example

{"amount": "xyz789", "outputs": 987}

Types

WalletReleaseRequestInput

Fields

Input Field	Description
`siacoinOutputs` - `[String!]`	[]types.SiacoinOutputID. Default = `null`
`siafundOutputs` - `[String!]`	[]types.SiafundOutputID. Default = `null`

Example

{
  "siacoinOutputs": ["xyz789"],
  "siafundOutputs": ["abc123"]
}

Types

WalletReserveRequestInput

Fields

Input Field	Description
`siacoinOutputs` - `[String!]`	List of Siacoin output IDs to reserve. Default = `null`
`siafundOutputs` - `[String!]`	List of Siafund output IDs to reserve. Default = `null`
`duration` - `String`	Duration to reserve the outputs for. Default = `null`

Example

{
  "siacoinOutputs": ["xyz789"],
  "siafundOutputs": ["abc123"],
  "duration": "abc123"
}

Types

WalletResponse

Fields

Field Name	Description
`scanHeight` - `Int`
`address` - `Address`
`spendable` - `Currency`
`confirmed` - `Currency`
`unconfirmed` - `Currency`
`immature` - `Currency`

Example

{
  "scanHeight": 123,
  "address": Address,
  "spendable": "USD",
  "confirmed": "USD",
  "unconfirmed": "USD",
  "immature": "USD"
}

Types

WalletSendRequestInput

Fields

Input Field	Description
`address` - `String`
`amount` - `String`
`subtractMinerFee` - `Boolean`
`useUnconfirmed` - `Boolean`

Example

{
  "address": "abc123",
  "amount": "xyz789",
  "subtractMinerFee": false,
  "useUnconfirmed": true
}

Types

WalletSendSiacoinsRequestInput

Fields

Input Field	Description
`address` - `String`
`amount` - `String`
`subtractMinerFee` - `Boolean`

Example

{
  "address": "xyz789",
  "amount": "xyz789",
  "subtractMinerFee": false
}

Types

WalletSignRequestInput

Fields

Input Field	Description
`transaction` - `TransactionInput`
`toSign` - `[String!]`
`coveredFields` - `CoveredFieldsInput`

Example

{
  "transaction": TransactionInput,
  "toSign": ["abc123"],
  "coveredFields": CoveredFieldsInput
}

Types

WalletUpdateRequestInput

Fields

Input Field	Description
`name` - `String`
`description` - `String`
`metadata` - `String`	json.RawMessage. Default = `null`

Example

{
  "name": "xyz789",
  "description": "abc123",
  "metadata": "abc123"
}

Types

Webhook

Fields

Field Name	Description
`module` - `String!`
`event` - `String!`
`url` - `String!`
`headers` - `JSON`

Example

{
  "module": "abc123",
  "event": "xyz789",
  "url": "xyz789",
  "headers": {}
}

Types

WebhookEventInput

Fields

Input Field	Description
`module` - `String`	The module that triggered the event. Default = `null`
`event` - `String`	The type of event that occurred. Default = `null`
`data` - `String`	Event-specific data payload. Default = `null`

Example

{
  "module": "abc123",
  "event": "xyz789",
  "data": "xyz789"
}

Types

WebhookInput

Fields

Input Field	Description
`module` - `String!`
`event` - `String!`
`url` - `String!`
`headers` - `String`

Example

{
  "module": "xyz789",
  "event": "abc123",
  "url": "abc123",
  "headers": "abc123"
}

Types

WebhookQueueInfo

Fields

Field Name	Description
`url` - `String`	The URL of the webhook
`size` - `Int`	The number of events in the queue

Example

{"url": "abc123", "size": 123}

Types

WebhookResponse

Fields

Field Name	Description
`webhooks` - `[Webhook!]`	List of registered webhooks
`queues` - `[WebhookQueueInfo!]`	Information about webhook event queues

Example

{
  "webhooks": [Webhook],
  "queues": [WebhookQueueInfo]
}

Types

WorkerStateResponse

Fields

Field Name	Description
`version` - `String`	The version of the build
`commit` - `String`	The commit hash of the build
`os` - `String`	The operating system of the build
`buildTime` - `DateTime`	The build time of the build
`id` - `String`
`startTime` - `DateTime`

Example

{
  "version": "abc123",
  "commit": "xyz789",
  "os": "xyz789",
  "buildTime": "2007-12-03T10:15:30Z",
  "id": "abc123",
  "startTime": "2007-12-03T10:15:30Z"
}

Documentation by Anvil SpectaQL