Sign in
bus

Get all accounts

Returns all accounts.

get/bus/accounts

Query parameters

ownerstring

The owner of the account. This is usually the id of the worker that maintains the account.

Response

Successfully retrieved accounts

idstring

The account's ID

cleanShutdownboolean

Whether the account has been cleanly shutdown. If not, the account will require a sync with the host.

hostKeystring

The host's public key

balancestring

The account's balance as expected by the worker

driftstring

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.

ownerstring

The owner of the account that manages it. This is the id of the worker that maintains the account.

requiresSyncboolean

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.

Changes

Changed in 4 of the 50 revisions of this API.16

  • fede87b22e1c2See the full diff
    • ○

      added AccountID to the items/id response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed PublicKey from the items/id response property allOf list for the response status 200

      response-property-all-of-removed

  • 922f156353c93See the full diff
    • ○

      api tag bus added

      api-tag-added

    • ○

      added the new optional query request parameter owner

      new-optional-request-parameter

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

  • d9b66ab404191See the full diff
    • ○

      endpoint added

      endpoint-added

  • f062c35d8f471See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 99 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog