Skip to content
PlutusShield
Live on Cardano Preview testnet

Open data API

Everything the products, claims, book and oracle pages show is also published as plain JSON, plus a sample portfolio cover plan with shareable /plan deep-link params, so dashboards, aggregators and partner protocols can read PlutusShield without a wallet, a key, or our UI.

← Back to site
DocsOpen data API

Datasets#

Static files on the same host as the site, served by GitHub Pages with CORS open to any origin. The site rebuilds them from the public deployment records and chain snapshots on every deploy; this page was built Sun, 18 Oct 2026 19:59:15 UTC.

Open data endpoints
EndpointWhat it holdsNowPage
/api/v1/index.jsonThis list of datasets, with the schema version, networks and when the site was built.6 datasets/docs/api
/api/v1/products.jsonEvery cover product: status (live or priced), premium currencies, trigger, claim model, base rate, and for live products the deployed pool parameters and capital.3 products/products
/api/v1/claims.jsonEvery decided claim across Cardano Preview and Midnight Preprod with each transaction, committee votes, Settle signers, refused Settle attempts, and the lowest live oracle reading against the depeg trigger.6 decided claims/claims
/api/v1/book.jsonEvery Preview pool with its open risk-tier scorecard answers, risk multiplier, tranches (capital, active cover, free capacity, utilization) and key transactions.3 pools/book
/api/v1/oracle.jsonThe USDM peg readings published to the Preview oracle feeds, newest first, with each transaction and the depeg trigger they are judged against.64 publishes/oracle
/api/v1/plan.jsonHow to price a portfolio with planCover() and share it as a /plan deep link (encodePlanShare / decodePlanShare), plus a sample planned portfolio priced at build time against the live Preview tranche snapshot.11 sample policies/plan

The envelope#

Every file has the same wrapper, so a reader can refuse data it does not understand before it reads data. The schema string only changes on a breaking change; new fields can appear inside data without one.

plutusshield.open-data/v1
{
  "schema": "plutusshield.open-data/v1",
  "dataset": "claims",                      // index | products | claims | book | oracle | plan
  "generatedAt": "2026-10-18T19:59:15.361Z",   // one build time for all files
  "networks": { "cardano": "preview", "midnight": "preprod" },
  "testnetOnly": true,
  "audited": false,
  "source": "https://github.com/Kshot3000/PlutusShield",
  "page": "https://kshot3000.github.io/PlutusShield/claims/",
  "data": { ... }
}

Reading it#

From a shell:

curl + jq
curl -s https://kshot3000.github.io/PlutusShield/api/v1/claims.json | jq '.data.stats'
curl -s https://kshot3000.github.io/PlutusShield/api/v1/oracle.json | jq '.data.latest'

From TypeScript, the SDK fetches a dataset and checks its envelope (schema, dataset, networks, testnet and not-audited flags) before handing it back, and throws with the reason when anything is off:

@plutusshield/sdk
import { fetchOpenData } from "@plutusshield/sdk";

const claims = await fetchOpenData("https://kshot3000.github.io/PlutusShield", "claims");
console.log(claims.data.stats.paidLovelace);   // "125000000" style base-unit string

Cover plan#

/api/v1/plan.json shows how to price a portfolio with planCover() and share it as a /plan deep link (encodePlanShare / decodePlanShare: query params c, d, and one x=label|product|amount|protectPct per exposure). The example object is the same LP + lender preset the planner opens with, priced at build time against the live Preview tranche snapshot — a static illustration, not a live quote.

deep link
open https://kshot3000.github.io/PlutusShield/plan/?$(curl -s https://kshot3000.github.io/PlutusShield/api/v1/plan.json | jq -r '.data.example.shareQuery')

Activity feed#

To follow PlutusShield instead of polling it, subscribe to the Atom feed at /feed.xml in any feed reader, or point a Discord, Telegram or Slack feed bot at it. It carries one entry per decided claim (6 now) and per refused Settle (1), plus the newest 24 live oracle publishes (24 in this build), each linking to its policy or the oracle page and to the transaction on Cardanoscan Preview or the Midnight Preprod explorer.

Entry ids are stable tag: URIs, so a reader never shows the same claim twice after a rebuild, and entries are categorised by kind (claim, refused-settle, oracle), product and chain. The SDK's buildAtomFeed refuses a feed with a duplicate id, a relative link or a non-UTC time, and the post-build check refuses a malformed feed.xml.

curl
curl -s https://kshot3000.github.io/PlutusShield/feed.xml | grep -o '<title>[^<]*' | head

Field notes#

  • Amounts are base-unit strings (lovelace, or USDC micro-units with the tranche's decimals), so nothing loses precision in JSON.
  • Times are ISO 8601 in UTC. Oracle readings are basis points of the 1.00 peg (10000 = exactly on peg); the depeg trigger is triggerBps.
  • Transactions carry both the hash and an explorer URL: Cardanoscan Preview for Cardano, the Midnight Preprod explorer for Midnight. Commitments and member keys are never given explorer links.
  • Products list premiumCurrencies a buyer can pay in today (ADA, USDC) separately from plannedCurrencies. A product with status: "priced" has a quote URL and no buy URL.
  • Nothing private is in these files: no holder keys, no coverage openings, no evidence. They are the same public records the pages render.

Limits#