---
agentTools:
  projectIndex: https://synonym.readme.io/llms.txt
---

# LN URL connect to node

LNURL Connect

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Blocktank is a Lightning Network service provider (LSP) with various services that aim to make Lightning Network better.",
    "version": "1.0.0",
    "title": "Blocktank"
  },
  "tags": [
    {
      "name": "LNURL",
      "description": "LNURL endpoitns"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "samples-enabled": true,
    "samples-languages": [
      "curl"
    ],
    "proxy-enabled": true
  },
  "paths": {
    "/lnurl/channel": {
      "get": {
        "tags": [
          "LNURL"
        ],
        "summary": "LN URL connect to node",
        "description": "LNURL Connect",
        "operationId": "lnurlConnect",
        "parameters": [
          {
            "in": "query",
            "name": "order_id",
            "description": "Required for LNURL connect",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "k1",
            "description": "Required for LNURL callback",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "remote_id",
            "description": "Required for LNURL callback. Remote node address of form node_key@ip_address:port_number. IP address and port number is optional",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "LNURL connect ",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LNURLConnect"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://blocktank.synonym.to/api/v1"
    }
  ],
  "components": {
    "schemas": {
      "LNURLConnect": {
        "type": "object",
        "properties": {
          "k1": {
            "type": "string",
            "description": "order id"
          },
          "tag": {
            "type": "string",
            "default": "channelRequest"
          },
          "callback": {
            "type": "string",
            "description": "A second-level URL which would initiate an OpenChannel message from target LN node"
          },
          "uri": {
            "type": "string",
            "description": "Blocktank node info"
          },
          "status": {
            "type": "string",
            "description": "Response status",
            "enum": [
              "OK",
              "ERROR"
            ]
          },
          "reason": {
            "type": "string",
            "description": "Error reason"
          }
        }
      }
    }
  },
  "_id": {
    "buffer": {
      "0": 97,
      "1": 136,
      "2": 141,
      "3": 121,
      "4": 248,
      "5": 94,
      "6": 228,
      "7": 0,
      "8": 42,
      "9": 196,
      "10": 77,
      "11": 96
    }
  }
}
```