The /v1 REST API

Get node type, peer list, and route metadata for this node.

Get UTXO balances for one or more addresses.

Repeat the `address` query parameter for multiple addresses; use `POST /v1/balances/query` instead for large batches.

# Repeat ?address= for each address you want
curl -sS "https://mempool.lineage.to/v1/balances?address=<address>"

{
  "balance": {
    "address_list": {
      "<address>": [
        {
          "out_point": { "n": 0, "t_hash": "g59cbf95982cff737ba0b067ff6d467d" },
          "value": { "Token": 720720000 }
        }
      ]
    },
    "total": { "tokens": 720720000, "items": {} }
  }
}

Batch-lookup UTXO balances for one or more addresses.

Create an item asset.

On a mempool node, this signs and submits the item-asset creation transaction directly (`script_public_key`/`public_key`/`signature` are required) and returns `201` with the created asset. On a user node, this injects a creation request for the node to construct and sign itself, and returns `202`.

Get the total and issued token supply.

curl -sS "https://mempool.lineage.to/v1/supply"

{
  "total": 360360000000000000,
  "issued": 90103919694881008
}

Construct one or more transactions and submit them to the mempool.

Get mempool status for one or more transactions.

Repeat the `hash` query parameter for multiple hashes; use `POST /v1/transactions/status:query` instead for large batches.

Batch-lookup mempool status for one or more transactions.

Get a single blockchain DB entry by its raw storage key.

Batch-lookup blockchain DB entries by raw storage key.

Keys with no stored entry are omitted from the response rather than erroring.

Batch-lookup stored blocks by number.

Block numbers with no stored block are omitted from the response rather than erroring; repeat the `num` query parameter for multiple numbers.

Get a single stored block by number.

Get the most recently stored block.

curl -sS "https://storage.lineage.to/v1/blocks/latest"

{
  "block": {
    "block": {
      "header": {
        "b_num": 5373,
        "previous_hash": "b004f3a8a053ed469b77b7afc3060714fe7edc188d5f70e7f7fdf8813db32d42e",
        "difficulty": [34, 0, 0, 1],
        "nonce_and_mining_tx_hash": [[45, 0, 0, 0], "g08bf5101e59b01ef9300b8f9311f226"],
        "seed_value": [49, 52, 57, 55, "… truncated …"]
      },
      "transactions": ["g08bf5101e59b01ef9300b8f9311f226"]
    }
  }
}

Get the latest block received for mining.

Make a payment, by address or by ip.

Both kinds first check the wallet passphrase. For `kind=address`, the node constructs and signs the payment (`UserApi::make_payment`); a construction failure (`success=false`) is reported as `422`, otherwise the constructed payment is queued for sending (`SendNextPayment`) and its `tx_hash` returned. For `kind=ip`, the `address` field is parsed as a socket address and the payment is sent directly to that peer (`MakeIpPayment`); no `tx_hash` is available for this path.

# amount is in raw token units (1 LNGX = 72,072,000)
curl -sS -X POST "https://miner.lineage.to/v1/payments" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "address",
    "address": "<recipient-address>",
    "amount": 720720000,
    "passphrase": "<wallet-passphrase>"
  }'

{
  "to_address": "<recipient-address>",
  "amount": { "kind": "token", "amount": 720720000 },
  "tx_hash": "g59cbf95982cff737ba0b067ff6d467d"
}

Get this node's outgoing (constructed-and-sent) transactions.

An empty wallet with no outgoing transactions yet returns an empty list rather than an error, unlike the legacy handler (which surfaced the "no key in the DB yet" case as a `500`).

Get balance and transaction info for this node's wallet.

curl -sS "https://miner.lineage.to/v1/wallet"

{
  "running_total": 141133.02058814795,
  "running_total_tokens": 10171739059829,
  "available_total_tokens": 9915312269729,
  "locked_total_tokens": 256426790100,
  "item_total": {},
  "addresses": {
    "0033315ca62a2ae88bada214f0308e77552f43bff4c0724b7b0b12110255cb1f": [
      {
        "out_point": { "n": 0, "t_hash": "g3cf6b82adceece76bb8f3f62dba5e61" },
        "value": { "Token": 2590174402 }
      }
    ]
  }
}

Generate and return a new payment address for this node's wallet.

Export this node's known key-pairs.

Sensitive: this returns private keys. Protect this route with an api-key entry.

Import key-pairs into this node's wallet, then request a running-total refresh from the UTXO set for the imported addresses.

Change this node's wallet passphrase.

Request a running-total refresh from the UTXO set for this node's wallet.

Ask a peer to send this user node a donation.

`address` is parsed as a socket address and a `RequestDonation` event is injected for the node to send the request itself; no response payload is returned.

Deserialize one or more hex-encoded transactions, without submitting them to the mempool. Stateless; not tied to any node's mempool or wallet.

Serialize one or more transactions to hex-encoded bytes, without submitting them to the mempool. Stateless; not tied to any node's mempool or wallet.