Ghost API

Documentation on our Ghost API endpoints

Queries

Get a Ghost Payment, which includes the preimage to settle the HTLC.

See it in the Apollo Explorer here (opens in a new tab).

query GetGhostPayment($input: GhostPaymentInput!) {
  getGhostPayment(input: $input) {
    payment_amount
    preimage
  }
}

{
  "input": {
    "payment_hash": string,
    "signature": string
  }
}

See it in the Apollo Explorer here (opens in a new tab).

mutation ClaimGhostAddress($address: String) {
  claimGhostAddress(address: $address) {
    username
  }
}

Note: only paid users are able to provide a custom address. Free users are assigned a uniqely generated address.

{
  "address": string | null
}