Skip to content

Stop Host Mode for an address

POST
/time/stop

Closes the open orders of the address and moves it to the inactive state. The used-cycle counter is reset and remaining ordered cycles are not carried over. No new energy is delegated until the address is switched on again with /time/order or /time/infinitystart.

The address itself stays registered in Host Mode together with its callback_url — to remove it entirely use /time/delete.

Stopping is always available, regardless of your balance.

Authorizations

ApiKeyAuth

API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.

Type
API Key (header: X-API-KEY)

Request Body

application/json
JSON
{
  
"api_key": "string",
  
"address": "TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE"
}

Responses

Success is code: 0. Errors with HTTP 200: -1 — authentication, address format or a database error; -4 — the address is not in Host Mode under your account; -7 — the mode is already off. application/json: schema: { $ref: '#/components/schemas/HostEnvelope' } examples: ok: summary: 'Stopped' value: code: 0 msg: Host mode stopped successfully, closed 1 order(s) data: address: TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE orders_closed: 1 status: inactive timestamp: '2026-07-13T05:30:15.123456' alreadyStopped: summary: 'Was already off' value: { code: -7, msg: Host mode is already inactive, data: null }

application/json
JSON
{
  
"code": 0,
  
"msg": "Host mode stopped successfully, closed 1 order(s)",
  
"data": {
  
  
"address": "TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE",
  
  
"orders_closed": 1,
  
  
"status": "inactive",
  
  
"timestamp": "2026-07-13T05:30:15.123456"
  
}
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI