Skip to content

Commit 5ef9836

Browse files
dev-distdev-dist
committed
updates
1 parent bd8bcad commit 5ef9836

File tree

2 files changed

+51
-16
lines changed

2 files changed

+51
-16
lines changed

‎src/config/sidebar.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@ export const SIDEBAR: Partial<Record<Sections, SectionEntry[]>> = {
434434
url: "data-streams/reference/overview",
435435
},
436436
{
437-
title: "Data Streams API",
437+
title: "Data Streams Reference",
438438
url: "data-streams/reference/data-streams-api",
439439
children: [
440440
{

‎src/content/data-streams/reference/overview.mdx‎

Lines changed: 50 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,65 @@ metadata:
99
keywords: ["Data Streams", "API Reference", "SDK", "WebSocket", "REST API", "Integration Guide"]
1010
---
1111

12-
Chainlink Data Streams offers two distinct APIs for accessing low-latency market data. Choose the API that best fits your use case.
12+
Chainlink Data Streams offers two distinct solutions for accessing low-latency market data. Choose the solution that best fits your use case.
1313

14-
### Which API should I use?
14+
### Which solution should I use?
1515

16-
| Feature | [Data Streams API](/data-streams/reference/data-streams-api) | [Candlestick API](/data-streams/reference/candlestick-api) |
17-
| ----------------------- | ------------------------------------------------------------ | ---------------------------------------------------------- |
18-
| **Primary Use Case** | **Onchain** consumption by smart contracts | **Offchain** analytics, charting, dashboards |
19-
| **Data Format** | Signed, verifiable data reports | Aggregated OHLC (candlestick) data |
20-
| **Interfaces** | REST API & WebSocket | REST API (including a streaming endpoint) |
21-
| **Authentication** | HMAC Signature | JWT (token-based) |
22-
| **Cryptographic Proof** | ✅ Yes (`fullReport` blob) | ❌ No |
16+
| Feature | [Data Streams API](#data-streams-api) | [Candlestick API](#candlestick-api) |
17+
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
18+
| **Primary Use Case** | **Onchain** consumption by smart contracts | **Offchain** analytics, charting, dashboards |
19+
| **Data Format** | Signed, verifiable data reports | Aggregated OHLC (candlestick) data |
20+
| **Interfaces** | SDKs ([Go](/data-streams/reference/data-streams-api/go-sdk), [Rust](/data-streams/reference/data-streams-api/rust-sdk)), [REST API](/data-streams/reference/data-streams-api/interface-api) & [WebSocket](/data-streams/reference/data-streams-api/interface-ws) | [REST API](/data-streams/reference/candlestick-api) (including a [streaming endpoint](/data-streams/reference/candlestick-api#get-streaming-price-updates)) |
21+
| **Authentication** | [HMAC Signature](data-streams/reference/data-streams-api/authentication) (automatic with SDKs) | [JWT](/data-streams/reference/candlestick-api#authorize-and-get-token) (token-based) |
22+
| **Cryptographic Proof** | ✅ Yes (See [Verification methods](#verification)) | ❌ No |
2323

2424
---
2525

26-
### Data Streams API
26+
## Data Streams API
2727

28-
Use the [Data Streams API](/data-streams/reference/data-streams-api) for applications that require high-frequency, verifiable data for **onchain** execution. It provides access to cryptographically signed data reports that can be verified and used by smart contracts. This API is designed for applications that depend on low-latency, tamper-proof data.
28+
The [Data Streams API](/data-streams/reference/data-streams-api) provides cryptographically signed, verifiable data reports designed for **onchain** consumption by smart contracts. This comprehensive solution offers multiple integration paths to support applications that require low-latency, tamper-proof data.
2929

30-
**[View the Data Streams API Reference](/data-streams/reference/data-streams-api/interface-api)**
30+
### Integration Methods
31+
32+
#### SDKs (Recommended)
33+
34+
- [Go SDK](/data-streams/reference/data-streams-api/go-sdk) - Native Go language integration
35+
- [Rust SDK](/data-streams/reference/data-streams-api/rust-sdk) - Native Rust language integration
36+
37+
#### Direct API Access
38+
39+
- [REST API](/data-streams/reference/data-streams-api/interface-api) - HTTP-based interface for simple integrations
40+
- [WebSocket](/data-streams/reference/data-streams-api/interface-ws) - Real-time data streaming via WebSocket connection
41+
42+
#### Authentication
43+
44+
- [Authentication Guides](/data-streams/reference/data-streams-api/authentication) - HMAC signature implementation examples (not required when using SDKs)
45+
46+
#### Verification
47+
48+
##### EVM chains
49+
50+
- [Onchain report data verification](/data-streams/reference/data-streams-api/onchain-verification) - Verify the authenticity of received data on EVM chains
51+
52+
##### Solana
53+
54+
- [Verify reports using the onchain integration method](/data-streams/tutorials/solana-onchain-report-verification) - Verify reports directly within your Solana program
55+
- [Verify reports using the offchain integration method](/data-streams/tutorials/solana-offchain-report-verification) - Verify reports client-side using the Rust SDK
56+
57+
**[View the Data Streams API Reference →](/data-streams/reference/data-streams-api)**
3158

3259
---
3360

34-
### Candlestick API
61+
## Candlestick API
62+
63+
The [Candlestick API](/data-streams/reference/candlestick-api) provides historical and real-time OHLC (Open-High-Low-Close) data designed for **offchain** applications. Built to TradingView data integration specifications, it's optimized for analytics, charting, and dashboard applications.
64+
65+
### Integration Methods
66+
67+
Currently, the Candlestick API is accessible via a [REST API](/data-streams/reference/candlestick-api), including a [streaming endpoint](/data-streams/reference/candlestick-api#get-streaming-price-updates) for real-time data.
68+
69+
### Authentication
3570

36-
Use the [Candlestick API](/data-streams/reference/candlestick-api) for **offchain** applications. It provides historical open-high-low-close (OHLC) data and real-time price updates in a format compatible with the [TradingView data integration specification](https://www.tradingview.com/broker-api-docs/rest-api-spec/#tag/Data-Integration). This is ideal for building dashboards, analytics platforms, portfolio trackers, and research tools.
71+
- [Authentication Endpoint](/data-streams/reference/candlestick-api#authorize-and-get-token) - JWT token-based authentication
3772

38-
**[View the Candlestick API Reference](/data-streams/reference/candlestick-api)**
73+
**[View the Candlestick API Reference →](/data-streams/reference/candlestick-api)**

0 commit comments

Comments
 (0)