Server API

Reference guide for the BitEscrow Server API.

Endpoint	Description
/api/server/keys	Fetch the latest server pubkeys.
/api/server/policy	Fetch the policy of the server.
/api/server/status	Fetch the status of the server.

---

Notice any mistakes, or something missing? Please let us know!
You can submit an issue here: Submit Issue

---

Get Server Keys

Fetch the latest server pubkeys in rotaion.

Request Format

method   : 'GET'
endpoint : '/api/keys'

Response Interface

interface ServerKeyResponse {
  data : {
    pubkeys : string[]
  }
}

---

Get Server Policy

Fetch the policies and terms of the escrow server.

Related Interfaces:

• ServerPolicy

Request Format

method   : 'GET'
endpoint : '/api/policy'

Response Interface

interface ServerPolicyResponse {
  data : {
    policy : ServerPolicy
  }
}

---

Get Server Status

Fetch the current status of the server.

Request Format

method   : 'GET'
endpoint : '/api/status'

Response Interface

interface ServerStatusResponse {
  data : {
    status : string
  }
}