API v1 docs

The API is authenticated via URL parameter to decrease implementation difficulty for low-code or no-code users, such as BotGhost users.

The API base URL will always be https://api.meltfinance.org.

Get the current Bitcoin price

GET /v1/btcprice

{
  "status": "success",
  "message": "97498.37"
}

This endpoint does not require an API key.

Get account balance

GET /v1/balance?apikey=YOUR_API_KEY

{
  "balance": 2317800,
  "balance_satoshi": 3782497370000,
  "btc_balance": 3782500000,
  "status": "success"
}

{
  "status": "error",
  "message": "Invalid API key."
}

Here, the balance is the USD value, balance_satoshi is the millisatoshi value, and btc_balance is the regular satoshi value.

Get account info

GET /v1/info?apikey=YOUR_API_KEY

{
  "username": "dyntech",
  "lnurlp": "LNURL1DP68GURN8GHJ7MT9D36XV6FWW3HHQTEWWAJKCMPDDDHX7AMW9AKXUATJD3CZ7EREDE6X2CMGWMZDJE",
  "status": "success"
}

{
  "status": "error",
  "message": "Invalid API key."
}

lnurlp stands for LNURL-Pay, which is an alternate representation of a Lightning address. It is recommended to present this to wallets with QR code scanning capabilities as it is more currently widespread.

Get account transactions

GET /v1/transactions?apikey=YOUR_API_KEY&limit=500

[
  {
    "amount": 5125000,
    "bolt11": "lnbc51250n1pn56qunpp5wgnjc47qm6lflm4w6p4a8dujzjyds94489dssalw92du7gslr3gqdpqf4jkcapqge5kuctwvdjjq6twwehkjcm9cqzzsxqyp2xqsp5pyhc8l4jm36q3kchjufmkl23w6y3z40y4l8sqa3f8x6ggjtwc4us9qxpqysgq78z8crgzd820g4shdfgr353vqej8vgs9kc4hg2rl82kratvvw05yw4weav4s5p69vmruvt4u604hdxgjcmmk3gjhr3gxe8e6gpegdqsq4uqzjm",
    "checking_id": "72272c57c0debe9feeaed06bd3b7921488d816b5395b0877ee2a9bcf221f1c50",
    "expiry": 1733143635,
    "extra": {
      "wallet_fiat_amount": 5,
      "wallet_fiat_currency": "USD",
      "wallet_fiat_rate": 1025
    },
    "fee": 0,
    "memo": "Melt Finance invoice",
    "payment_hash": "72272c57c0debe9feeaed06bd3b7921488d816b5395b0877ee2a9bcf221f1c50",
    "pending": false,
    "preimage": "0000000000000000000000000000000000000000000000000000000000000000",
    "time": 1733100435,
    "wallet_id": "d22dd27b694a479d8fa045513da83ef9",
    "webhook": null,
    "webhook_status": null
  }
]

{
  "status": "error",
  "message": "Invalid API key."
}

This endpoint will normally return ALL of your transactions. The provided JSON is only a record of an invoice being paid. It is recommended to test your app extensively if it needs this endpoint's data. To limit the amount of data your app receives, use the optional limit parameter to add an upper cap.

Create invoice

GET /v1/invoices/create?apikey=YOUR_API_KEY&amount=69420&currency=sat&memo=Sigma%20Payment

{
  "message": "lnbcExampleInvoice",
  "status": "success"
}

{
  "status": "error",
  "message": "Invalid API key."
}

The currency parameter is optional, and can be either sat or USD. memo is also optional but highly recommended.

Pay invoice

GET /v1/invoices/pay?apikey=YOUR_API_KEY&invoice=YOUR_INVOICE_HERE

{
  "status": "success",
  "message": "Invoice paid successfully!"
}

{
  "status": "error",
  "message": "Invalid API key."
}

{
  "status": "error",
  "message": "ERROR_DETAILS_HERE"
}

Decode invoice

GET /v1/invoices/decode?invoice=YOUR_INVOICE_HERE

{
  'currency': 'bc',
  'amount_msat': 69420000,
  'date': 1728970332,
  'signature': '756bb5cf22e66b201ec3244c7e3a787a4254003edba16e2c03543a84425ceae9144c109fbaac325e5f3d9a8897b159779bf3225d7062d0c817cb2142ec2be8a6',
  'payment_hash': '0e3877bb7e8362f904cc70ca14daac4722eef1757f065ad1cedaffd204626a78',
  'payment_secret': '0278f95396c2a5593572d3f2afd01824acc8e11717dba3e04a109d025e33adc2',
  'description': 'Invoice by skibidirizzler',
  'expiry': 43200,
  'features': {
      'var_onion_optin': 'required',
      'payment_secret': 'required',
      'basic_mpp': 'supported',
      'option_route_blinding': 'supported'
  },
  'min_final_cltv_expiry': 80,
  'payee': '027230e7207075b18b089399c4244ca4b45f5e629108ef020f6812aba67037a499'
  }

{
  "status": "error",
  "message": "ERROR_DETAILS_HERE"
}

This endpoint does not require an API key. The returned amount_msat is of millisatoshis. Unless you are an experienced developer, the other fields may not be of big importance to you.

Pay LNURL or LN address

GET /v1/lnurl/pay?apikey=YOUR_API_KEY&object=YOUR_LNURL_HERE&amount=69420&memo=MEMO_HERE

{
  "status": "success",
  "message": "Invoice paid successfully!"
}

{
  "status": "error",
  "message": "Invalid API key."
}

{
  "status": "error",
  "message": "ERROR_DETAILS_HERE"
}

The memo parameter is optional.

Withdraw from a LNURLw

GET /v1/lnurl/withdraw?apikey=YOUR_API_KEY&lnurl=YOUR_LNURLW_HERE

{
  "status": "success",
  "message": "LNURLw processed"
}

{
  "status": "error",
  "message": "Invalid API key."
}

{
  "status": "error",
  "message": "ERROR_DETAILS_HERE"
}

LNURLw (lnurl-withdraw) is a type of LNURL that allows the user to receive a certain amount of money from the recipient. One of its many current uses is to allow Slice users to receive their browsing earnings.

PreviousWebhook docs

Last updated 8 months ago