Skip to content

Commit d91dd30

Browse files
committed
initial polish/edits
1 parent 57ece83 commit d91dd30

File tree

19 files changed

+374
-343
lines changed

19 files changed

+374
-343
lines changed

src/content/data-streams/architecture.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Read the [Getting Started](/data-streams/getting-started) guide to learn how to
123123

124124
Active-active is a system configuration strategy where redundant systems remain active simultaneously to serve requests. Incoming requests are distributed across all active resources and load-balanced to provide high availability, scalability, and fault tolerance. This strategy is the opposite of active-passive where a secondary system remains inactive until the primary system fails.
125125

126-
The Data Streams API services use an active-active setup as a highly available and resilient architecture across multiple distributed and fully isolated origins. This setup ensures that the services are operational even if one origin fails, which provides robust fault tolerance and high availability. This configuration applies to both the [REST API](/data-streams/reference/data-streams-api/interface-api) and the [WebSocket API](/data-streams/reference/data-streams-api/interface-ws). A global load balancer seamlessly manages the system to provide automated and transparent failovers. For advanced use cases, the service publishes available origins using HTTP headers, which enables you to interact directly with specific origin locations if necessary.
126+
The Data Streams API services use an active-active setup as a highly available and resilient architecture across multiple distributed and fully isolated origins. This setup ensures that the services are operational even if one origin fails, which provides robust fault tolerance and high availability. This configuration applies to both the [REST API](/data-streams/reference/data-streams-api/interface-api) and the [WebSocket API](/data-streams/reference/interface-ws). A global load balancer seamlessly manages the system to provide automated and transparent failovers. For advanced use cases, the service publishes available origins using HTTP headers, which enables you to interact directly with specific origin locations if necessary.
127127

128128
### Active-Active Setup
129129

src/content/data-streams/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Access data directly through REST APIs or WebSocket connections using our SDKs:
8080

8181
- **[Go SDK](/data-streams/reference/data-streams-api/go-sdk)** - Full-featured SDK with comprehensive examples
8282
- **[Rust SDK](/data-streams/reference/data-streams-api/rust-sdk)** - High-performance SDK for Rust applications
83-
- **[REST API](/data-streams/reference/data-streams-api/interface-api)** or **[WebSocket](/data-streams/reference/data-streams-api/interface-ws)** - Direct access to Data Streams endpoints
83+
- **[REST API](/data-streams/reference/data-streams-api/interface-api)** or **[WebSocket](/data-streams/reference/interface-ws)** - Direct access to Data Streams endpoints
8484

8585
### Getting started
8686

src/content/data-streams/reference/data-streams-api/authentication/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ metadata:
99
whatsnext:
1010
{
1111
"Learn about the REST API Interface": "/data-streams/reference/data-streams-api/interface-api",
12-
"Learn about the WebSocket Interface": "/data-streams/reference/data-streams-api/interface-ws",
12+
"Learn about the WebSocket Interface": "/data-streams/reference/interface-ws",
1313
"Explore the Go SDK": "/data-streams/reference/data-streams-api/go-sdk",
1414
"Explore the Rust SDK": "/data-streams/reference/data-streams-api/rust-sdk",
1515
}
@@ -132,7 +132,7 @@ When working with the Data Streams API, the most common authentication issues in
132132
For complete information on all possible error responses:
133133

134134
- [REST API Error Response Codes](/data-streams/reference/data-streams-api/interface-api#error-response-codes)
135-
- [WebSocket Error Response Codes](/data-streams/reference/data-streams-api/interface-ws#error-response-codes)
135+
- [WebSocket Error Response Codes](/data-streams/reference/interface-ws#error-response-codes)
136136

137137
## Troubleshooting Authentication
138138

src/content/data-streams/reference/data-streams-api/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import DataStreams from "@features/data-streams/common/DataStreams.astro"
1616
### API Interfaces
1717

1818
- [REST API](/data-streams/reference/data-streams-api/interface-api) - HTTP-based interface for simple integrations
19-
- [WebSocket](/data-streams/reference/data-streams-api/interface-ws) - Real-time data streaming via WebSocket connection
19+
- [WebSocket](/data-streams/reference/interface-ws) - Real-time data streaming via WebSocket connection
2020

2121
### SDK Integration
2222

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ Chainlink Data Streams offers two distinct solutions for accessing low-latency m
1313

1414
### Which solution should I use?
1515

16-
| Feature | [Data Streams API](#data-streams-api) | [Candlestick API](#candlestick-api) |
17-
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
18-
| **Primary Use Case** | Low-latency data for smart contracts | OHLC data for analytics, charting, and 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 |
16+
| Feature | [Data Streams API](#data-streams-api) | [Candlestick API](#candlestick-api) |
17+
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
18+
| **Primary Use Case** | Low-latency data for smart contracts | OHLC data for analytics, charting, and 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/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

@@ -37,7 +37,7 @@ The [Data Streams API](/data-streams/reference/data-streams-api) provides crypto
3737
#### Direct API Access
3838

3939
- [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
40+
- [WebSocket](/data-streams/reference/interface-ws) - Real-time data streaming via WebSocket connection
4141

4242
#### Authentication
4343

0 commit comments

Comments
 (0)