{
  "info": {
    "description": "Machine-readable index of xrpldashboard's LIVE read-only surface. Every endpoint listed here is publicly served today; every response either is or will be wrapped in the ProofAnnotationEnvelope schema (MCP tools today; HTTP read-only API when it lands). Free for humans and identified agents at reasonable volume \u2014 no accounts, no API keys, no payment rails. See /methodology#for-ai-agents for the full contract, and docs/AGENT_TIER_DESIGN.md in the source repo for the design behind this surface. Independent project \u2014 not affiliated with Ripple, the XRP Ledger Foundation, any exchange, or with xrpdashboard.com (note: missing 'L' \u2014 that's a separate XRP portfolio product).",
    "contact": {
      "name": "xrpldashboard",
      "url": "https://xrpldashboard.com/contact",
      "email": "contact@xrpldashboard.com"
    },
    "license": {
      "name": "MIT (source); data derived from public XRPL and Ethereum ledgers",
      "url": "https://github.com/Enkryptedx/xrpldashboard/blob/main/LICENSE"
    },
    "x-agent-tier-freshness": {
      "last_verified": "2026-09-26",
      "source_of_truth": "app.py:LAST_VERIFIED_AGENT_TIER_METHODOLOGY",
      "note": "Bump the constant whenever the OpenAPI spec, llms.txt, or agents.json shape changes. Three surfaces refresh from one edit."
    },
    "x-mcp-tools": {
      "server_name": "xrpldashboard-mcp",
      "server_version": "2.0.0",
      "protocol": "MCP (Model Context Protocol) \u2014 stdio + streamable HTTP",
      "documentation": "https://xrpldashboard.com/methodology#for-ai-agents",
      "design_doc": "https://github.com/Enkryptedx/xrpldashboard/blob/main/docs/AGENT_TIER_DESIGN.md",
      "envelope_schema_ref": "#/components/schemas/ProofAnnotationEnvelope",
      "tool_count": 19,
      "tools": [
        {
          "name": "get_ledger_stats",
          "source": "local_rippled",
          "freshness": "\u2264 5min",
          "batch": "ledger-primitives",
          "description": "Return the last-validated ledger stats (index, close time, server state, load factor, complete range, build). Wrapped in the xrpldashboard proof envelope; envelope source is derived from the actual URL host (`local_rippled` for loopback / private LAN, `remote_rippled:<host>` otherwise) \u2014 never hardcoded.",
          "inputSchema": {
            "properties": {},
            "title": "get_ledger_statsArguments",
            "type": "object"
          }
        },
        {
          "name": "get_amendment_status",
          "source": "local_rippled",
          "freshness": "\u2264 30min",
          "batch": "ledger-primitives",
          "description": "Return the current amendments state (enabled / in-flight / superseded / unrecognized-enabled) with `cross_check_status` derived from the responding node's feature-RPC vs Amendments ledger-object concurrence. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {},
            "title": "get_amendment_statusArguments",
            "type": "object"
          }
        },
        {
          "name": "get_unl_status",
          "source": "local_rippled",
          "freshness": "\u2264 30min",
          "batch": "ledger-primitives",
          "description": "Return the current UNL composition (both published lists, overlap, expiry-days). Honest-partial when a list fetch fails. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {},
            "title": "get_unl_statusArguments",
            "type": "object"
          }
        },
        {
          "name": "get_whale_events",
          "source": "local_rippled_stream_capture",
          "freshness": "\u2264 5min",
          "batch": "value-flows",
          "description": "Return the last N XRP-denominated whale events + tagged-watchlist events (trustset excluded). Same feed the homepage globe pulse reads. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {
              "limit": {
                "default": 25,
                "title": "Limit",
                "type": "integer"
              }
            },
            "title": "get_whale_eventsArguments",
            "type": "object"
          }
        },
        {
          "name": "get_whale_watchlist",
          "source": "local_rippled_stream_capture",
          "freshness": "\u2264 5min",
          "batch": "value-flows",
          "description": "Return the last N tagged-watchlist events (type='tagged'), floored at TAGGED_XRP_FLOOR_DROPS for XRP-denominated rows. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {
              "limit": {
                "default": 25,
                "title": "Limit",
                "type": "integer"
              }
            },
            "title": "get_whale_watchlistArguments",
            "type": "object"
          }
        },
        {
          "name": "get_rlusd_supply",
          "source": "neon_postgres",
          "freshness": "\u2264 5min",
          "batch": "value-flows",
          "description": "Return the current cross-chain RLUSD supply (Ethereum + XRPL) from the same PG mirror /rlusd reads. Honest-partial when either chain errored. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {},
            "title": "get_rlusd_supplyArguments",
            "type": "object"
          }
        },
        {
          "name": "get_rlusd_flow_24h",
          "source": "neon_postgres",
          "freshness": "finalized_only",
          "batch": "value-flows",
          "description": "Return the last finalized 24h XRPL net-change from rlusd_supply_history. freshness_contract='finalized_only' is the machine-readable form of the R1/R2 finalized-window rule. cross_check_status derived from stored vs supply-diff pair. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {},
            "title": "get_rlusd_flow_24hArguments",
            "type": "object"
          }
        },
        {
          "name": "get_amm_pool",
          "source": "neon_postgres",
          "freshness": "daily",
          "batch": "amm-tokens",
          "description": "Return the single ranked-pool row for one AMM account from the amm_ranked_pools snapshot. Raises when the account is absent (unranked, below thresholds, or newer than the last snapshot). Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {
              "amm_account": {
                "title": "Amm Account",
                "type": "string"
              }
            },
            "required": [
              "amm_account"
            ],
            "title": "get_amm_poolArguments",
            "type": "object"
          }
        },
        {
          "name": "get_amm_top_by_tvl",
          "source": "neon_postgres",
          "freshness": "daily",
          "batch": "amm-tokens",
          "description": "Return the top-N ranked AMM pools by tvl_usd from the same snapshot /pools reads. NULL-tvl rows sort last. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {
              "limit": {
                "default": 10,
                "title": "Limit",
                "type": "integer"
              }
            },
            "title": "get_amm_top_by_tvlArguments",
            "type": "object"
          }
        },
        {
          "name": "get_token_attestation",
          "source": "neon_postgres",
          "freshness": "daily",
          "batch": "amm-tokens",
          "description": "Return the attestation tier (verified / self-described / null) for one (currency, issuer) pair. Data payload includes `dispute_contact_url` \u2014 first tool to name a third party. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {
              "currency": {
                "title": "Currency",
                "type": "string"
              },
              "issuer": {
                "title": "Issuer",
                "type": "string"
              }
            },
            "required": [
              "currency",
              "issuer"
            ],
            "title": "get_token_attestationArguments",
            "type": "object"
          }
        },
        {
          "name": "get_rwa_families",
          "source": "neon_postgres",
          "freshness": "daily",
          "batch": "amm-tokens",
          "description": "Return every rwa_family row with attributed pool count. Data payload includes `dispute_contact_url`. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {},
            "title": "get_rwa_familiesArguments",
            "type": "object"
          }
        },
        {
          "name": "get_rwa_pools",
          "source": "neon_postgres",
          "freshness": "daily",
          "batch": "amm-tokens",
          "description": "Return every attributed RWA pool with provenance + TVL. Data payload includes `dispute_contact_url`. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {},
            "title": "get_rwa_poolsArguments",
            "type": "object"
          }
        },
        {
          "name": "get_mpt_snapshot",
          "source": "neon_postgres",
          "freshness": "daily",
          "batch": "amm-tokens",
          "description": "Return the MPT snapshot dict (issuances / by_class / total). Not third-party-naming \u2014 no dispute_contact_url. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {},
            "title": "get_mpt_snapshotArguments",
            "type": "object"
          }
        },
        {
          "name": "get_signed_snapshot",
          "source": "signed_snapshot_walker",
          "freshness": "daily",
          "batch": "signed-snapshot",
          "description": "Return the Ed25519-signed daily snapshot for `date_str` (ISO YYYY-MM-DD) wrapped in the proof envelope. Absence raises \u2014 the walker has not produced this date yet, or the date predates the chain start.",
          "inputSchema": {
            "properties": {
              "date_str": {
                "title": "Date Str",
                "type": "string"
              }
            },
            "required": [
              "date_str"
            ],
            "title": "get_signed_snapshotArguments",
            "type": "object"
          }
        },
        {
          "name": "verify_snapshot_signature",
          "source": "signed_snapshot.verify_envelope+pinned_pubkey",
          "freshness": "\u2264 5min",
          "batch": "signed-snapshot",
          "description": "Stateless verification: re-derive the leaf hash, check the Ed25519 signature against the pinned pubkey, check the audit path against the claimed chain root. Accepts full MCP envelope or bare signed payload. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {
              "envelope": {
                "additionalProperties": true,
                "title": "Envelope",
                "type": "object"
              }
            },
            "required": [
              "envelope"
            ],
            "title": "verify_snapshot_signatureArguments",
            "type": "object"
          }
        },
        {
          "name": "get_tokens",
          "source": "token_category_current+token_facts",
          "freshness": "\u2264 30min",
          "batch": "broad-surfaces",
          "description": "Return the top-N tokens by trades_30d, joined against attestation tier + warning flags. Mirrors /tokens.json's data path (token_category_current JOIN token_facts). Third-party- naming \u2014 data payload includes `dispute_contact_url`. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {
              "limit": {
                "default": 100,
                "title": "Limit",
                "type": "integer"
              }
            },
            "title": "get_tokensArguments",
            "type": "object"
          }
        },
        {
          "name": "get_whales",
          "source": "whales_summary",
          "freshness": "\u2264 5min",
          "batch": "broad-surfaces",
          "description": "Return the whales_summary rollup cells (per-tier \u00d7 per-filter body metadata). Mirrors /whales.json. Live stream on wss://wss.xrpldashboard.com \u2014 this tool returns generation stats + body length, not the live payload. Third-party-naming \u2014 data payload includes `dispute_contact_url`. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {},
            "title": "get_whalesArguments",
            "type": "object"
          }
        },
        {
          "name": "get_pools",
          "source": "rank_amms_walker+amm_tvl_recorder",
          "freshness": "\u2264 30min",
          "batch": "broad-surfaces",
          "description": "Return AMM pools ranked by TVL, broader list contract than get_amm_top_by_tvl (default limit=50 vs 10). Mirrors /pools.json. Same source snapshot (amm_ranked_pools). Third-party-naming \u2014 data payload includes `dispute_contact_url`. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {
              "limit": {
                "default": 50,
                "title": "Limit",
                "type": "integer"
              }
            },
            "title": "get_poolsArguments",
            "type": "object"
          }
        },
        {
          "name": "get_amendments",
          "source": "amendments_state+amendments_network_votes",
          "freshness": "daily",
          "batch": "broad-surfaces",
          "description": "Return the amendments block with per-amendment vote tallies. Mirrors /amendments.json. Distinct from get_amendment_status (state-only) \u2014 this tool adds live vote counts vs UNL-threshold per amendment. Not third-party-naming. Wrapped in the proof envelope.",
          "inputSchema": {
            "properties": {},
            "title": "get_amendmentsArguments",
            "type": "object"
          }
        }
      ],
      "status": "Public beta, no end date set, at https://mcp.xrpldashboard.com/mcp \u2014 server publicly reachable (streamable HTTP, MCP protocol 2025-06-18, 19 read-only tools, no auth, 600 tool calls/hour/session enforced). Backed by our own xrpld node. Listed in the Anthropic MCP Registry (server id com.xrpldashboard/xrpldashboard-mcp, DNS-verified namespace, listed 2026-08-05) and Smithery (listed 2026-08-05). See mcp_server.py + mcp_tools_*.py in the source repo for implementation."
    },
    "title": "xrpldashboard \u2014 Agent Tier (read-only)",
    "version": "v1"
  },
  "externalDocs": {
    "description": "Full methodology, per-surface freshness contracts, and the four-layer truth audit design.",
    "url": "https://xrpldashboard.com/methodology"
  },
  "servers": [
    {
      "url": "https://xrpldashboard.com",
      "description": "Production"
    }
  ],
  "tags": [
    {
      "name": "discovery",
      "description": "Discovery-layer surfaces \u2014 how agents find this site's machine-readable contracts."
    },
    {
      "name": "signed-snapshots",
      "description": "Tamper-evident daily Ed25519-signed database snapshots. Verify locally against the pinned public key."
    },
    {
      "name": "documentation",
      "description": "OpenAPI JSON and Swagger UI for this spec itself."
    }
  ],
  "paths": {
    "/llms.txt": {
      "get": {
        "tags": [
          "discovery"
        ],
        "summary": "llmstxt.org site directory",
        "description": "Markdown-formatted site directory following the llmstxt.org convention. Every URL listed resolves to a live public surface.",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/markdown": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/.well-known/agents.json": {
      "get": {
        "tags": [
          "discovery"
        ],
        "summary": "Agent-discovery manifest (Wildcard-AI flavor)",
        "description": "Site identity, rate limits, trust surfaces, and the proof-annotation envelope agents should expect. Status booleans stay honest \u2014 each flips to true only after the corresponding surface responds.",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/.well-known/security.txt": {
      "get": {
        "tags": [
          "discovery"
        ],
        "summary": "Security disclosure contact",
        "description": "RFC 9116 security.txt.",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/robots.txt": {
      "get": {
        "tags": [
          "discovery"
        ],
        "summary": "Crawler directives",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/sitemap.xml": {
      "get": {
        "tags": [
          "discovery"
        ],
        "summary": "XML sitemap (curated public routes + per-MPT detail pages)",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/xml": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/.well-known/snapshots/chain.json": {
      "get": {
        "tags": [
          "signed-snapshots"
        ],
        "summary": "Chain-linked list of daily signed snapshots",
        "description": "Each entry is chain-linked to the previous day, giving a tamper-evident audit trail across the full snapshot history.",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/amendments/{date}.json": {
      "get": {
        "tags": [
          "signed-snapshots"
        ],
        "summary": "Signed amendment tallies for a specific date (YYYY-MM-DD) \u2014 machine twin of /amendments/<date>",
        "description": "The day's signed leaf (leaf_hash, chain_root, signature, audit path, verifier verdict) with its amendments_block tallies, plus the day's majority events and roll-call counts \u2014 the latter two labeled NOT inside the leaf. Unsigned/gap days return 200 with a notice and no tallies; dates before the first leaf or in the future return 404.",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      },
      "parameters": [
        {
          "name": "date",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string",
            "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
          },
          "description": "UTC calendar date, YYYY-MM-DD."
        }
      ]
    },
    "/.well-known/snapshots/{date}.json": {
      "get": {
        "tags": [
          "signed-snapshots"
        ],
        "summary": "Ed25519-signed snapshot for a specific date (YYYY-MM-DD)",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      },
      "parameters": [
        {
          "name": "date",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string",
            "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
          },
          "description": "UTC calendar date, YYYY-MM-DD."
        }
      ]
    },
    "/.well-known/snapshots/pubkey.pem": {
      "get": {
        "tags": [
          "signed-snapshots"
        ],
        "summary": "Ed25519 public key for snapshot verification",
        "description": "Pin locally. Verify snapshot signatures against this key.",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/x-pem-file": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/.well-known/snapshots/pubkey.json": {
      "get": {
        "tags": [
          "signed-snapshots"
        ],
        "summary": "Same public key as pubkey.pem in machine-friendly JSON (hex + base64)",
        "description": "Generic HTTP clients frequently choke on application/x-pem-file. This endpoint returns the raw 32-byte Ed25519 public key in hex and base64 encodings plus the SHA-256 fingerprint, without requiring the client to parse PEM.",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/.well-known/anchors.json": {
      "get": {
        "tags": [
          "signed-snapshots"
        ],
        "summary": "Machine-readable index of on-ledger XRPL anchor transactions",
        "description": "For each anchor: number, date, tx hash, ledger index, close time, chain_root, decoded memo, block-explorer URLs, and a chain.json cross-check (roots_match). The Proof Page in machine form.",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      }
    },
    "/check.json": {
      "get": {
        "tags": [
          "read-api"
        ],
        "summary": "Typed triage for XRPL addresses, tokens, URLs, or pasted text",
        "description": "Live HTTP API surface. `?q=` accepts an XRPL r-address, a token identifier (currency+issuer), a URL, or free-text. The response `data` field is typed by input kind: `wallet`, `token`, `url`, or `message`. Each capability entry carries `source_label` (the origin RPC / on-ledger object the capability was derived from) and `checked_at_utc` (ISO timestamp). Full envelope shape (top-level `proof` object like MCP tools use) is a build item in progress \u2014 today's response provides per-field provenance instead. identified verified-bot rate limit 300/hour.",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "read-api"
        ],
        "summary": "Same as GET; POST body accepts free-text or JSON with a `q` field",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        }
      },
      "parameters": [
        {
          "name": "q",
          "in": "query",
          "required": false,
          "schema": {
            "type": "string"
          },
          "description": "Input to triage: r-address, currency+issuer, URL, or free text."
        }
      ]
    }
  },
  "openapi": "3.0.3",
  "components": {
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "Error code"
          },
          "status": {
            "type": "string",
            "description": "Error name"
          },
          "message": {
            "type": "string",
            "description": "Error message"
          },
          "errors": {
            "type": "object",
            "description": "Errors",
            "additionalProperties": {}
          }
        },
        "additionalProperties": false
      },
      "PaginationMetadata": {
        "type": "object",
        "properties": {
          "total": {
            "type": "integer",
            "description": "Total number of items."
          },
          "total_pages": {
            "type": "integer",
            "description": "Total number of pages."
          },
          "first_page": {
            "type": "integer",
            "description": "First available page number."
          },
          "last_page": {
            "type": "integer",
            "description": "Last available page number."
          },
          "page": {
            "type": "integer",
            "description": "Current page number."
          },
          "previous_page": {
            "type": "integer",
            "description": "Previous page number."
          },
          "next_page": {
            "type": "integer",
            "description": "Next page number."
          }
        },
        "additionalProperties": false
      },
      "ProofAnnotationEnvelope": {
        "type": "object",
        "description": "Standard response envelope. Every MCP tool response is wrapped in this shape via mcp_server.wrap_envelope(). The `proof` block carries source, freshness, and cross-check metadata that lets agents verify the payload against ledger truth without a support ticket.",
        "required": [
          "data",
          "proof",
          "server"
        ],
        "properties": {
          "data": {
            "description": "Tool-specific payload. Shape varies per tool."
          },
          "proof": {
            "type": "object",
            "required": [
              "source",
              "as_of",
              "freshness_contract",
              "methodology_url",
              "cross_check_status",
              "honest_partial"
            ],
            "properties": {
              "source": {
                "type": "string",
                "description": "Data source identifier.",
                "examples": [
                  "local_rippled",
                  "neon_postgres",
                  "ethereum_1rpc",
                  "local_rippled_stream_capture"
                ]
              },
              "as_of": {
                "type": "string",
                "format": "date-time",
                "description": "ISO 8601 UTC timestamp for when the payload was materialized."
              },
              "freshness_contract": {
                "type": "string",
                "enum": [
                  "\u2264 5min",
                  "\u2264 30min",
                  "daily",
                  "finalized_only"
                ],
                "description": "The declared freshness bound for this payload. `finalized_only` means the tool refuses to serve partial-day rows (R1/R2 rule)."
              },
              "claims_ref": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "CLAIMS.yaml claim id where one exists. `null` when the datum isn't a public claim."
              },
              "methodology_url": {
                "type": "string",
                "format": "uri",
                "description": "Deep link to the /methodology section describing this source."
              },
              "cross_check_status": {
                "type": "string",
                "enum": [
                  "agree",
                  "disagree",
                  "not_applicable"
                ],
                "description": "Result of the tool's internal cross-check (where one is defined; `not_applicable` otherwise)."
              },
              "honest_partial": {
                "type": "boolean",
                "description": "True when the tool served a partial result because a dependency was unavailable. Always accompanied by `scope_note`."
              },
              "scope_note": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Required when honest_partial=True. Names exactly which slice is missing."
              }
            }
          },
          "server": {
            "type": "object",
            "required": [
              "name",
              "version",
              "public_key_fingerprint",
              "docs"
            ],
            "properties": {
              "name": {
                "type": "string",
                "examples": [
                  "xrpldashboard-mcp"
                ]
              },
              "version": {
                "type": "string",
                "examples": [
                  "1.0.0"
                ]
              },
              "public_key_fingerprint": {
                "type": "string",
                "description": "SHA-256 fingerprint of the signed-snapshot public key. Pin locally for tamper detection."
              },
              "docs": {
                "type": "string",
                "format": "uri"
              }
            }
          }
        }
      }
    }
  }
}