Skip to content

Commit a443913

Browse files
committed
relative links -> absolute links
1 parent 07745a4 commit a443913

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

src/content/data-streams/reference/report-schema-overview.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -15,53 +15,53 @@ import ReportSchemaTabs from "@features/data-streams/common/ReportSchemaTabs.ast
1515

1616
Below is a summary of all available Data Streams report schemas, their main use cases, and key fields.
1717

18-
| Report Schema | Version | Use Case / Purpose | Key Fields |
19-
| :------------------------------------------------------------ | :----------------------------------------- | :---------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------- |
20-
| [Cryptocurrency](#cryptocurrency-report-schema) | [View schema (v3)](./report-schema-v3) | Crypto price streams | `price`, `bid`, `ask` |
21-
| [DEX State Price](#dex-state-price-report-schema) | [View schema (v3)](./report-schema-v3-dex) | DEX state crypto price streams | `price`, `bid`, `ask` (All fields equal; [details](../concepts/dex-state-price-streams#how-to-use-dex-state-price-streams)) |
22-
| [Exchange Rate](#exchange-rate-report-schema) | [View schema (v7)](./report-schema-v7) | Tokenized asset exchange rates | `exchangeRate` |
23-
| [Real World Asset (RWA)](#real-world-asset-rwa-report-schema) | [View schema (v8)](./report-schema-v8) | Real World Asset (RWA) price streams | `midPrice`, `marketStatus`, `lastUpdateTimestamp` |
24-
| [Net Asset Value (NAV)](#net-asset-value-nav-report-schema) | [View schema (v9)](./report-schema-v9) | Net Asset Value (NAV) streams | `aum`, `navPerShare`, `navDate`, `ripcord` |
25-
| [Backed xStock](#backed-xstock-report-schema) | [View schema (v10)](./report-schema-v10) | Tokenized stocks and backed asset streams | `price`, `tokenizedPrice`, `marketStatus`, `currentMultiplier`, `newMultiplier` |
18+
| Report Schema | Version | Use Case / Purpose | Key Fields |
19+
| :------------------------------------------------------------ | :--------------------------------------------------------------- | :---------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------- |
20+
| [Cryptocurrency](#cryptocurrency-report-schema) | [View schema (v3)](/data-streams/reference/report-schema-v3) | Crypto price streams | `price`, `bid`, `ask` |
21+
| [DEX State Price](#dex-state-price-report-schema) | [View schema (v3)](/data-streams/reference/report-schema-v3-dex) | DEX state crypto price streams | `price`, `bid`, `ask` (All fields equal; [details](/data-streams/concepts/dex-state-price-streams#how-to-use-dex-state-price-streams)) |
22+
| [Exchange Rate](#exchange-rate-report-schema) | [View schema (v7)](/data-streams/reference/report-schema-v7) | Tokenized asset exchange rates | `exchangeRate` |
23+
| [Real World Asset (RWA)](#real-world-asset-rwa-report-schema) | [View schema (v8)](/data-streams/reference/report-schema-v8) | Real World Asset (RWA) price streams | `midPrice`, `marketStatus`, `lastUpdateTimestamp` |
24+
| [Net Asset Value (NAV)](#net-asset-value-nav-report-schema) | [View schema (v9)](/data-streams/reference/report-schema-v9) | Net Asset Value (NAV) streams | `aum`, `navPerShare`, `navDate`, `ripcord` |
25+
| [Backed xStock](#backed-xstock-report-schema) | [View schema (v10)](/data-streams/reference/report-schema-v10) | Tokenized stocks and backed asset streams | `price`, `tokenizedPrice`, `marketStatus`, `currentMultiplier`, `newMultiplier` |
2626

2727
## Cryptocurrency Report Schema
2828

29-
[Chainlink Cryptocurrency Reports](./report-schema-v3) provide market data for digital assets, supporting high-frequency, onchain use cases. Each report includes a consensus mid price (`price`), as well as simulated bid (`bid`) and ask (`ask`) prices that estimate the impact of buying or selling at a specified liquidity depth. These values help protocols and applications understand current market conditions and potential slippage for larger trades.
29+
[Chainlink Cryptocurrency Reports](/data-streams/reference/report-schema-v3) provide market data for digital assets, supporting high-frequency, onchain use cases. Each report includes a consensus mid price (`price`), as well as simulated bid (`bid`) and ask (`ask`) prices that estimate the impact of buying or selling at a specified liquidity depth. These values help protocols and applications understand current market conditions and potential slippage for larger trades.
3030

31-
For a deeper explanation of how liquidity-weighted bid and ask prices work, see [Liquidity-Weighted Bid-Ask Prices (LWBA)](../concepts/liquidity-weighted-prices).
31+
For a deeper explanation of how liquidity-weighted bid and ask prices work, see [Liquidity-Weighted Bid-Ask Prices (LWBA)](/data-streams/concepts/liquidity-weighted-prices).
3232

3333
## DEX State Price Report Schema
3434

35-
[Chainlink DEX State Price Reports](./report-schema-v3-dex) are designed for assets that derive most or all of their liquidity from decentralized exchanges (DEXs). Unlike standard crypto price streams, these reports use onchain market data to reflect the unique conditions of AMM pools and DEX-dominant tokens. In this report, the `price`, `bid`, and `ask` fields are all equal, representing the execution price a trader would receive based on the current state of onchain liquidity pools, rather than order-book mechanics. This approach enables accurate, real-time pricing, even for long-tail or newly launched tokens in low-volume environments.
35+
[Chainlink DEX State Price Reports](/data-streams/reference/report-schema-v3-dex) are designed for assets that derive most or all of their liquidity from decentralized exchanges (DEXs). Unlike standard crypto price streams, these reports use onchain market data to reflect the unique conditions of AMM pools and DEX-dominant tokens. In this report, the `price`, `bid`, and `ask` fields are all equal, representing the execution price a trader would receive based on the current state of onchain liquidity pools, rather than order-book mechanics. This approach enables accurate, real-time pricing, even for long-tail or newly launched tokens in low-volume environments.
3636

3737
[The DEX State Price methodology](/data-streams/concepts/dex-state-price-streams#high-level-outline-of-the-dex-state-price-methodology) aggregates data from multiple DEX pools, applies volume and TVL-based weighting, and uses filters to reduce manipulation and smooth volatility. Users should be aware of the specific risks inherent to DeFi, such as smart contract vulnerabilities, bridge dependencies, and external price manipulation. It is important to review [risk mitigation guidance](/data-streams/concepts/dex-state-price-streams#risk-mitigation) and adjust protocol parameters accordingly when integrating DEX State Price Reports.
3838

39-
For more details on the methodology and risk considerations, see [DEX State Price Streams](../concepts/dex-state-price-streams).
39+
For more details on the methodology and risk considerations, see [DEX State Price Streams](/data-streams/concepts/dex-state-price-streams).
4040

4141
## Exchange Rate Report Schema
4242

43-
[Chainlink Exchange Rate Data Streams](./report-schema-v7) provide tamper-proof access to the exchange rate of tokenized assets, delivered over the low latency, high frequency Chainlink Data Streams infrastructure. Exchange rates typically read directly from onchain smart contracts. These exchange rates generally have a single calculating agent: the issuing protocol. This report is designed specifically for Exchange Rate feeds and reports one main value: the exchange rate (`exchangeRate`).
43+
[Chainlink Exchange Rate Data Streams](/data-streams/reference/report-schema-v7) provide tamper-proof access to the exchange rate of tokenized assets, delivered over the low latency, high frequency Chainlink Data Streams infrastructure. Exchange rates typically read directly from onchain smart contracts. These exchange rates generally have a single calculating agent: the issuing protocol. This report is designed specifically for Exchange Rate feeds and reports one main value: the exchange rate (`exchangeRate`).
4444

4545
While the Data Streams architecture is designed to deliver updates at least once per second, the exchange rate itself is often updated only once per day by the data source, in line with standard market practices. Data Streams ensures that any Exchange Rate update, whenever it occurs, is captured and made available immediately and at low latency, allowing seamless integration into onchain applications alongside other real-time data streams.
4646

4747
## Real World Asset (RWA) Report Schema
4848

49-
[Chainlink RWA Data Streams](./report-schema-v8) provide fresh, reliable, and accurate financial market data for real-world assets, enabling DeFi users to gain onchain exposure to physical assets. Each report includes a staleness measure (`lastUpdateTimestamp`), consensus median price (`midPrice`) and market status (`marketStatus`).
49+
[Chainlink RWA Data Streams](/data-streams/reference/report-schema-v8) provide fresh, reliable, and accurate financial market data for real-world assets, enabling DeFi users to gain onchain exposure to physical assets. Each report includes a staleness measure (`lastUpdateTimestamp`), consensus median price (`midPrice`) and market status (`marketStatus`).
5050

51-
RWA assets trade on traditional exchanges during [market hours](../market-hours). These market hours vary by asset class and can be subject to unexpected halts, pauses and other behaviors affecting traditional markets. For this reason, this class of Data Streams contains a market hours flag and a staleness measure to equip our users to handle these events correctly. It is critical that users implement correct safeguards on their end to pause markets, add more conservative risk caps, or do whatever else is appropriate for their application.
51+
RWA assets trade on traditional exchanges during [market hours](/data-streams/market-hours). These market hours vary by asset class and can be subject to unexpected halts, pauses and other behaviors affecting traditional markets. For this reason, this class of Data Streams contains a market hours flag and a staleness measure to equip our users to handle these events correctly. It is critical that users implement correct safeguards on their end to pause markets, add more conservative risk caps, or do whatever else is appropriate for their application.
5252

5353
## Net Asset Value (NAV) Report Schema
5454

55-
[Chainlink NAV Data Streams](./report-schema-v9) provide real-time, tamper-proof access to the Net Asset Value (`navPerShare`) of tokenized assets, funds, or portfolios, delivered over the low latency, high frequency Chainlink Data Streams infrastructure. Each report includes NAV per share (`navPerShare`), NAV date (`navDate`), assets under management (`aum`), and ripcord status (`ripcord`). The ripcord is set to true (`1`) by the asset issuer when the consumer should ignore the value being sent (for cases such as maintenance, upstream data source outages, etc). The feed data will remain stale until the ripcord returns false (`0`).
55+
[Chainlink NAV Data Streams](/data-streams/reference/report-schema-v9) provide real-time, tamper-proof access to the Net Asset Value (`navPerShare`) of tokenized assets, funds, or portfolios, delivered over the low latency, high frequency Chainlink Data Streams infrastructure. Each report includes NAV per share (`navPerShare`), NAV date (`navDate`), assets under management (`aum`), and ripcord status (`ripcord`). The ripcord is set to true (`1`) by the asset issuer when the consumer should ignore the value being sent (for cases such as maintenance, upstream data source outages, etc). The feed data will remain stale until the ripcord returns false (`0`).
5656

5757
NAV is a fundamental financial metric that represents the value of an investment vehicle such as a mutual fund or ETF and is calculated as the total assets minus the total liabilities.
5858

5959
Data Streams ensures that any NAV update, whenever it occurs, is captured and made available immediately and at low latency, allowing for seamless integration with onchain applications alongside other real-time data streams. Although the NAV value may not change frequently, Data Streams provides the most recent NAV as soon as it is published by the source.
6060

6161
## Backed xStock Report Schema
6262

63-
[Chainlink Backed xStock Data Streams](./report-schema-v10) provide fresh, reliable, and accurate financial market data for Tokenized Equities such as [xStock](https://xstocks.com/us) assets, enabling DeFi users to gain onchain exposure to tokenized stocks. These Streams are a unique product provided by Chainlink Labs for partners such as xStocks. They combine data from our US equity Data Streams with data from the tokenization service, which enables users to correctly handle corporate actions affecting the underlying equities. Each report includes the staleness measure (`lastUpdateTimestamp`), consensus mid price (`price`), market status (`marketStatus`), current multiplier (`currentMultiplier`, the number of underlying shares each xStock is redeemable for), new multiplier (`newMultiplier`, the future number of shares after a scheduled corporate action), activation date/time of the corporate action (`activationDateTime`) and the tokenized price if available on primary or secondary markets (`tokenizedPrice`).
63+
[Chainlink Backed xStock Data Streams](/data-streams/reference/report-schema-v10) provide fresh, reliable, and accurate financial market data for Tokenized Equities such as [xStock](https://xstocks.com/us) assets, enabling DeFi users to gain onchain exposure to tokenized stocks. These Streams are a unique product provided by Chainlink Labs for partners such as xStocks. They combine data from our US equity Data Streams with data from the tokenization service, which enables users to correctly handle corporate actions affecting the underlying equities. Each report includes the staleness measure (`lastUpdateTimestamp`), consensus mid price (`price`), market status (`marketStatus`), current multiplier (`currentMultiplier`, the number of underlying shares each xStock is redeemable for), new multiplier (`newMultiplier`, the future number of shares after a scheduled corporate action), activation date/time of the corporate action (`activationDateTime`) and the tokenized price if available on primary or secondary markets (`tokenizedPrice`).
6464

65-
The underlying US equities trade on traditional exchanges during [market hours](../market-hours). These market hours depend per asset class and can be subject to unexpected halts, pauses and other behaviors affecting traditional markets. For this reason, this class of Data Streams contains a market hours flag and a staleness measure to equip our users to handle these events correctly. It is critical that users implement correct safeguards on their end to pause markets, add more conservative risk caps, or implement other measures appropriate for their application.
65+
The underlying US equities trade on traditional exchanges during [market hours](/data-streams/market-hours). These market hours depend per asset class and can be subject to unexpected halts, pauses and other behaviors affecting traditional markets. For this reason, this class of Data Streams contains a market hours flag and a staleness measure to equip our users to handle these events correctly. It is critical that users implement correct safeguards on their end to pause markets, add more conservative risk caps, or implement other measures appropriate for their application.
6666

67-
[The schema](./report-schema-v10) is designed specifically for tokenized equities such as xStocks and contains data from the Chainlink US equities streams, combined with data provided by the tokenizer to properly handle corporate actions. With this enhanced data users are able to handle expected and unexpected market events such as pauses, halts and market off hours. The tokenization provider layers in data around the `currentMultiplier`, the `newMultiplier` and the `activationDateTime` of the new multiplier to handle corporate actions.
67+
[The schema](/data-streams/reference/report-schema-v10) is designed specifically for tokenized equities such as xStocks and contains data from the Chainlink US equities streams, combined with data provided by the tokenizer to properly handle corporate actions. With this enhanced data users are able to handle expected and unexpected market events such as pauses, halts and market off hours. The tokenization provider layers in data around the `currentMultiplier`, the `newMultiplier` and the `activationDateTime` of the new multiplier to handle corporate actions.

0 commit comments

Comments
 (0)