Download OpenAPI specification:Download
LndhubX is a Lightning Bitcoin bank that allows users to swap into synthetic fiat and back.
Learn more about the project on Github: https://github.com/kolliderhq/lndhubx
{- "ln_network_max_fee": "string",
- "ln_network_fee_margin": "string",
- "reserve_ratio": "string",
- "external_tx_fee": "string",
- "internal_tx_fee": "string"
}
This creates a new unique user on LndhubX.
username | string A unique username. |
password | string A unique strong password. |
OK
{- "username": "string",
- "password": "string"
}
{- "username": "string"
}
This will log a user and in an return the JWT tokens.
username | string A unique username. |
password | string A unique strong password. |
Returns an object of accounts.
{- "username": "string",
- "password": "string"
}
{- "access_token": "string",
- "refresh_token": "string"
}
amount required | integer The amount of the specified currency. NOTE BTC is not denominated in Sats but in BTC. |
currency | string The currency you want to deposit. |
meta | string Some optional meta data to include in the invoice. |
account_id | string If you want to generate the invoice for a specific account otherwise your default account is used. |
OK
{- "payment_request": "string",
- "amount": "string",
- "account_id": "string",
- "meta": "string",
- "rate": "string",
- "currency": "string"
}
This will pay an invoice. Internal payments are possible but no self payments.
payment_request | string The LN payment request to be paid. |
OK
{- "payment_request": "string"
}
{- "success": true,
- "currency": "string",
- "payment_request": "string",
- "fee": "string",
- "error": "string"
}
This will swap any two currencies with each other.
from_currency | string The currency you want to sell. |
to_currency | string The currency you wan to buy. |
amount | string The amount you want to swap. |
OK
{- "from_currency": "string",
- "to_currency": "string",
- "amount": "string"
}
{- "amount": "string",
- "from": "string",
- "to": "string",
- "valid_until": 0,
- "rate": "string",
- "quote_id": 0,
- "error": "string"
}
from_currency required | string The currency you want to sell. |
to_currency required | string The currency you want to buy. |
amount required | integer The amount you want to swap. Note BTC is denominated in BTC not Sats. |
OK
{- "amount": "string",
- "from": "string",
- "to": "string",
- "valid_until": 0,
- "rate": "string",
- "quote_id": 0,
- "error": "string"
}