Skip to Content
YieldAPI Reference

Rails API Reference

Programmatic access to operational data and insights for your Rails Lightning node setup.

Endpoints

Rails provides two key APIs:

Rails GraphQL API

The Rails-specific API for querying information related to your node setup, performance, and earnings.

LND API

Direct access to the underlying Lightning Network Daemon for node-level operations.

Authentication

Include your API key in the request header:

Authorization: Bearer [API_KEY]

Create an API key at account.amboss.tech/settings/api-keys . See the Developer docs for detailed authentication instructions.

Use Cases

The Rails API enables you to:

  • Query node performance metrics and earnings data
  • Integrate Rails data into custom dashboards or automation workflows
  • Monitor channel health and liquidity deployment programmatically
  • Build custom tooling on top of your Rails node operations