Sign in
worker

Get a worker account

Returns the account the worker maintains with the specified host for payment.

get/worker/account/{hostkey}

Path parameters

hostkeystring required

A ed25519 public key

The host's public key

Response

Successfully retrieved worker account

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 3 of the 50 revisions of this API.6

  • fede87b22e1c2See the full diff
    • ○

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

      response-property-all-of-added

    • ○

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

      response-property-all-of-removed

  • 922f156353c91See the full diff
    • ○

      api tag worker added

      api-tag-added

  • f062c35d8f473See the full diff
    • ○

      api tag worker removed

      api-tag-removed

    • ○

      added PublicKey to the id response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed AccountID from the id response property allOf list for the response status 200

      response-property-all-of-removed

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