This namespace contains endpoints to retrieve statistics on Lightning Network. We provide certain metrics such as the number of channel, nodes and network capacity from lightning network. For more detailed information, please refer to the description of each metric.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/cryptoquant:cryptoquant-btc-lightning-statistics-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 1.3.0
title: CryptoQuant Data BTC Lightning Statistics API
termsOfService: https://cryptoquant.com/terms-of-service
contact:
name: API Support
email: contact@cryptoquant.com
description: The CryptoQuant Data API provides simple and powerful endpoints to get information on general transaction data and aggregate on-chain statistics straight from the blockchain. The API root endpoint URL is `https://api.cryptoquant.com/v1/`.
servers:
- url: https://api.cryptoquant.com/v1
description: Default server
tags:
- name: BTC Lightning Statistics
description: 'This namespace contains endpoints to retrieve statistics on Lightning Network. We provide certain metrics such as the number of channel, nodes and network capacity from lightning network.
For more detailed information, please refer to the description of each metric.'
paths:
/btc/lightning/stats-in-total:
get:
tags:
- BTC Lightning Statistics
summary: BTC Lightning Statistics
description: 'Lightning Network Statistics contains various metrics which are calculated from lightning network.
### Supported Stats
| Stas | Description |
|----------------------------------|--------------------------------------------------------|
| `network_capacity` | The total network capacity (sum of balances available across all lightning payment channels) (BTC) |
| `network_capacity_usd` | The total network capacity (sum of balances available across all lightning payment channels) (USD) |
| `capacity_per_channel_mean` | The average channel capacity (BTC) |
| `capacity_per_channel_mean_usd` | The average channel capacity (USD) |
| `capacity_per_node_mean` | The average node capacity (BTC) |
| `capacity_per_node_mean_usd` | The average node capacity (USD) |
| `number_of_node` | The total number of available nodes (Number) |
| `number_of_channel` | The total number of available payment channels (Number) |
| `channel_per_node_mean` | The average number of channels per node (Number) |
| `node_age_days` | The average day of duration of nodes (Number) |
| `channel_age_days` | The average day of duration of channels (Number) |
| `base_fee_median` | The median base fee of transactions (Sat) |
| `base_fee_median_usd` | The median base fee of transactions (USD) |
| `fee_rate_median` | The median fee rates of transactions (Sat) |
| `fee_rate_median_usd` | The median fee rates of transactions (USD) |
### Supported Windows
| Supported Windows |
|-------------------|
| `hour`, `day*` |
> (*) Default'
operationId: getBTCLightningNetworkStatsInTotal
parameters:
- description: Currently, we support `day` and `hour`.
explode: false
in: query
name: window
schema:
type: string
default: day
style: form
example: day
- description: This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.
explode: false
in: query
name: from
required: false
schema:
type: string
style: form
example: 20191001T100000
- description: This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.
explode: false
in: query
name: to
required: false
schema:
type: string
style: form
example: 20191001T103025
- description: The maximum number of entries to return before the latest data point (or before `to` if specified). This field ranges from 1 to 100,000.
explode: false
in: query
name: limit
required: false
schema:
type: integer
default: 100
minimum: 1
maximum: 100000
style: form
example: 100
- description: A format type about return message type. Supported formats are json, csv.
explode: false
in: query
name: format
required: false
schema:
type: string
default: json
style: form
example: json
x-codeSamples:
- lang: Shell
source: 'curl -X GET "https://api.cryptoquant.com/v1/btc/lightning/stats-in-total?window=day&limit=2" \
-H "Authorization: Bearer <YOUR_API_KEY>"'
- lang: JavaScript
source: "fetch(\"https://api.cryptoquant.com/v1/btc/lightning/stats-in-total?window=day&limit=2\", { headers: { \"Authorization\": \"Bearer <YOUR_API_KEY>\"} })\n .then(response => response.json())\n .then(data => console.log(data))"
- lang: NodeJS
source: "require('axios')\n .get(\"https://api.cryptoquant.com/v1/btc/lightning/stats-in-total?window=day&limit=2\", { headers: { Authorization: 'Bearer <YOUR_API_KEY>' } })\n .then(response => console.log(response))"
- lang: Ruby
source: 'require ''net/http''
uri = URI("https://api.cryptoquant.com/v1/btc/lightning/stats-in-total?window=day&limit=2")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer <YOUR_API_KEY>"
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.body'
- lang: Python
source: 'import requests
headers = {''Authorization'': ''Bearer <YOUR_API_KEY>''}
url = "https://api.cryptoquant.com/v1/btc/lightning/stats-in-total?window=day&limit=2"
print(requests.get(url, headers=headers).json())'
responses:
'200':
description: BTC Lightning Network Stats
content:
application/json:
schema:
type: object
required:
- status
- result
properties:
status:
type: object
description: The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.
properties:
code:
type: integer
format: int32
description: HTTP status code
message:
type: string
description: Text description of the error or success.
required:
- code
- message
result:
type: object
required:
- window
- data
properties:
window:
type: string
description: The size of window. It can be day or hour, and it depends on the user request.
data:
type: array
items:
type: object
required:
- date
- network_capacity
- network_capacity_usd
- capacity_per_channel_mean
- capacity_per_channel_mean_usd
- capacity_per_node_mean
- capacity_per_node_mean_usd
- number_of_node
- number_of_channel
- channel_per_node_mean
- node_age_days
- channel_age_days
- base_fee_median
- base_fee_median_usd
- fee_rate_median
- fee_rate_median_usd
properties:
date:
type: string
description: The date and time formatted as YYYY-MM-DD HH:MM:SS (UTC time). This field only appears when window=block is used.
network_capacity:
type: number
description: The total network capacity (sum of balances available across all lightning payment channels) (BTC)
network_capacity_usd:
type: number
description: The total network capacity (sum of balances available across all lightning payment channels) (USD)
capacity_per_channel_mean:
type: number
description: The average channel capacity (BTC)
capacity_per_channel_mean_usd:
type: number
description: The average channel capacity (USD)
capacity_per_node_mean:
type: number
description: The average node capacity (BTC)
capacity_per_node_mean_usd:
type: number
description: The average node capacity (USD)
number_of_node:
type: integer
description: The total number of available nodes (Number)
number_of_channel:
type: integer
description: The total number of available payment channels (Number)
channel_per_node_mean:
type: number
description: The average number of channels per node (Number)
node_age_days:
type: number
description: The average day of duration of nodes (Number)
channel_age_days:
type: number
description: The average day of duration of channels (Number)
base_fee_median:
type: number
description: The median base fee of transactions (Sat)
base_fee_median_usd:
type: number
description: The median base fee of transactions (USD)
fee_rate_median:
type: number
description: The median fee rates of transactions (Sat)
fee_rate_median_usd:
type: number
description: The median fee rates of transactions (USD)
example:
status:
code: 200
message: success
result:
window: day
data:
- datetime: '2019-10-02'
metric_type: tx_count
metric_unit: number
result:
network_capacity: null
network_capacity_usd: null
capacity_per_channel_mean: null
capacity_per_channel_mean_usd: null
capacity_per_node_mean: null
capacity_per_node_mean_usd: null
number_of_node: null
number_of_channel: null
channel_per_node_mean: null
node_age_days: null
channel_age_days: null
base_fee_median: null
base_fee_median_usd: null
fee_rate_median: null
fee_rate_median_usd: null
security:
- AccessToken: []
components:
securitySchemes:
AccessToken:
type: http
scheme: bearer
bearerFormat: JWT
description: 'For each API request, include this HTTP header:
`Authorization` with the `Bearer <YOUR_API_KEY>`. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required.
You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please [upgrade your plan](https://cryptoquant.com/pricing) to Professional or Premium plan. You''ll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription.'
QueryParameter:
type: apiKey
name: api_key
in: query
description: 'For each API reqeust, include `api_key` parameter.
You must request with your access token in query parameter in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please [upgrade your plan](https://cryptoquant.com/pricing) to Professional or Premium plan. You''ll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription.
If you are using Excel, you can use the `api_key` parameter to request with your access token to return data either in `json` or `csv`.'
x-tagGroups:
- name: Discovery
tags:
- Available Endpoints
- Supported Stablecoin List
- Supported ERC20 List
- Supported Alt List
- name: Bitcoin
tags:
- BTC Entity Status
- BTC Exchange Flows
- BTC Flow Indicator
- BTC Market Indicator
- BTC Network Indicator
- BTC Miner Flows
- BTC Inter Entity Flows
- BTC Fund Data
- BTC Market Data
- BTC Miner Data
- BTC Network Data
- BTC Mempool Statistics
- BTC Lightning Statistics
- name: Ethereum
tags:
- ETH Entity Status
- ETH Exchange Flows
- ETH Flow Indicator
- ETH Market Indicator
- ETH 2.0
- ETH Fund Data
- ETH Market Data
- ETH Network Data
- name: XRP
tags:
- XRP Entity Status
- XRP Entity Flows
- XRP Flow Indicator
- XRP Market Data
- XRP Network Data
- XRP Network Indicator
- XRP Dex Data
- XRP AMM Data
- name: TRX
tags:
- TRX Market Data
- TRX Network Data
- TRX DEFI
- name: Stablecoin
tags:
- Stablecoin Entity Status
- Stablecoin Exchange Flows
- Stablecoin Flow Indicator
- Stablecoin Market Data
- Stablecoin Network Data
- name: ERC20
tags:
- ERC20 Entity Status
- ERC20 Exchange Flows
- ERC20 Flow Indicator
- ERC20 Market Data
- ERC20 Network Data
- name: Alt
tags:
- Alt Market Data
- name: Utilities
tags:
- Latency
x-provenance:
method: harvested
publisher: CryptoQuant
source: https://docs.cryptoquant.com/openapi/v1.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)