You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/data-streams/architecture.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -122,7 +122,7 @@ Read the [Getting Started](/data-streams/getting-started) guide to learn how to
122
122
123
123
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.
124
124
125
-
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/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.
125
+
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.
Copy file name to clipboardExpand all lines: src/content/data-streams/developer-responsibilities.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,8 +84,8 @@ Developers implementing Chainlink Data Streams are solely responsible for instit
84
84
-**Code dependencies and imports:** Developers are responsible for ensuring the quality, reliability, and security of any dependencies or imported packages that they use with Chainlink Data Streams, and review and audit these dependencies and packages.
85
85
-**Implementing Contingency Logic:** In extreme circumstances, including situations beyond the control of Chainlink node operators, Chainlink Data Streams may experience periods of unavailability or performance degradation. When a WebSocket connection is dropped, user systems must manage reconnections effectively. Developers are responsible for creating contingency plans tailored to their specific application needs, such as:
86
86
- Implementing the [Data Streams Architecture](/data-streams/architecture),
87
-
- Adopting an [active-active](/data-streams/architecture#active-active-multi-site-deployment) deployment strategy and [configuring the SDK](/data-streams/reference/go-sdk#config-struct) to support multiple concurrent WebSocket connections,
88
-
- Retrieving any potentially missing reports via the [REST API](/data-streams/reference/interface-api).
87
+
- Adopting an [active-active](/data-streams/architecture#active-active-multi-site-deployment) deployment strategy and [configuring the SDK](/data-streams/reference/data-streams-api/go-sdk#config-struct) to support multiple concurrent WebSocket connections,
88
+
- Retrieving any potentially missing reports via the [REST API](/data-streams/reference/data-streams-api/interface-api).
89
89
90
90
### Additional Considerations on Data Usage and Verification
Copy file name to clipboardExpand all lines: src/content/data-streams/index.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,9 +77,9 @@ You can access Chainlink Data Streams through SDKs and APIs, allowing you to bui
77
77
78
78
Access data directly through REST APIs or WebSocket connections using our SDKs:
79
79
80
-
-**[Go SDK](/data-streams/reference/go-sdk)** - Full-featured SDK with comprehensive examples
81
-
-**[Rust SDK](/data-streams/reference/rust-sdk)** - High-performance SDK for Rust applications
82
-
-**[REST API](/data-streams/reference/interface-api)** or **[WebSocket](/data-streams/reference/interface-ws)** - Direct access to Data Streams endpoints
80
+
-**[Go SDK](/data-streams/reference/data-streams-api/go-sdk)** - Full-featured SDK with comprehensive examples
81
+
-**[Rust SDK](/data-streams/reference/data-streams-api/rust-sdk)** - High-performance SDK for Rust applications
82
+
-**[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
83
84
84
### Getting started
85
85
@@ -89,7 +89,7 @@ Access data directly through REST APIs or WebSocket connections using our SDKs:
89
89
90
90
1. Try the API: Follow our [hands-on tutorial](/data-streams/tutorials/api-go) to fetch and decode your first report.
91
91
92
-
1. Implement Verification: Add [onchain verification](/data-streams/reference/onchain-verification) to ensure data authenticity in your smart contracts.
92
+
1. Implement Verification: Add [onchain verification](/data-streams/reference/data-streams-api/onchain-verification) to ensure data authenticity in your smart contracts.
Copy file name to clipboardExpand all lines: src/content/data-streams/reference/candlestick-api/index.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ import DataStreams from "@features/data-streams/common/DataStreams.astro"
12
12
13
13
<DataStreamssection="dsNotes" />
14
14
15
-
The Candlestick API is designed and implemented to satisfy the [TradingView implementation spec](https://www.tradingview.com/broker-api-docs/rest-api-spec/#tag/Data-Integration), the industry standard for sharing open-high-low-close (OHLC) aggregated trading data.
15
+
The Candlestick API is designed and implemented to satisfy [TradingView data integration specifications](https://www.tradingview.com/broker-api-docs/rest-api-spec/#tag/Data-Integration), the industry standard for sharing open-high-low-close (OHLC) aggregated trading data.
16
16
17
17
Alignment with the TradingView spec allows for TradingView integration and direct customer access to prices without resorting to consuming and decoding reports for non-transactional use cases, like dashboards, analytics platforms, portfolio trackers, research tools, and more.
Copy file name to clipboardExpand all lines: src/content/data-streams/reference/data-streams-api/authentication/go-examples.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@ import DataStreams from "@features/data-streams/common/DataStreams.astro"
15
15
16
16
Below are complete examples for authenticating with the Data Streams API in Go. Each example shows how to properly generate the required headers and make a request.
17
17
18
-
To learn more about the Data Streams API authentication, see the [Data Streams Authentication](/data-streams/reference/authentication) page.
18
+
To learn more about the Data Streams API authentication, see the [Data Streams Authentication](/data-streams/reference/data-streams-api/authentication) page.
19
19
20
-
**Note**: The Data Streams SDKs handle authentication automatically. If you're using the [Go SDK](/data-streams/reference/go-sdk) or [Rust SDK](/data-streams/reference/rust-sdk), you don't need to implement the authentication logic manually.
20
+
**Note**: The Data Streams SDKs handle authentication automatically. If you're using the [Go SDK](/data-streams/reference/data-streams-api/go-sdk) or [Rust SDK](/data-streams/reference/data-streams-api/rust-sdk), you don't need to implement the authentication logic manually.
21
21
22
22
## API Authentication Example
23
23
@@ -223,7 +223,7 @@ While this example demonstrates the authentication mechanism, production applica
223
223
-**Error types**: Define custom error types for better error handling
224
224
-**Testing**: Add unit tests for HMAC generation and integration tests
225
225
226
-
For production use, consider using the [Go SDK](/data-streams/reference/go-sdk) which handles authentication automatically and provides built-in fault tolerance.
226
+
For production use, consider using the [Go SDK](/data-streams/reference/data-streams-api/go-sdk) which handles authentication automatically and provides built-in fault tolerance.
227
227
228
228
## WebSocket Authentication Example
229
229
@@ -508,4 +508,4 @@ While this example already includes many production-ready features (keepalive, t
508
508
-**Health checks**: Expose WebSocket connection status for monitoring systems
509
509
-**Testing**: Add unit tests for HMAC generation and mock WebSocket server for integration tests
510
510
511
-
For production use, consider using the [Go SDK](/data-streams/reference/go-sdk) which handles authentication automatically and provides built-in fault tolerance for streaming connections.
511
+
For production use, consider using the [Go SDK](/data-streams/reference/data-streams-api/go-sdk) which handles authentication automatically and provides built-in fault tolerance for streaming connections.
"Learn about the REST API Interface": "/data-streams/reference/interface-api",
12
-
"Learn about the WebSocket Interface": "/data-streams/reference/interface-ws",
13
-
"Explore the Go SDK": "/data-streams/reference/go-sdk",
14
-
"Explore the Rust SDK": "/data-streams/reference/rust-sdk",
11
+
"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",
13
+
"Explore the Go SDK": "/data-streams/reference/data-streams-api/go-sdk",
14
+
"Explore the Rust SDK": "/data-streams/reference/data-streams-api/rust-sdk",
15
15
}
16
16
isIndex: true
17
17
---
@@ -26,8 +26,9 @@ This page explains how to authenticate with the Chainlink Data Streams API, cove
26
26
27
27
<Asidetype="note"title="Data Streams SDKs">
28
28
The Data Streams SDKs handle authentication automatically. If you're using the [Go
29
-
SDK](/data-streams/reference/go-sdk) or [Rust SDK](/data-streams/reference/rust-sdk), you don't need to implement the
30
-
authentication logic manually.
29
+
SDK](/data-streams/reference/data-streams-api/go-sdk) or [Rust
30
+
SDK](/data-streams/reference/data-streams-api/rust-sdk), you don't need to implement the authentication logic
31
+
manually.
31
32
</Aside>
32
33
33
34
## Authentication Requirements
@@ -114,10 +115,10 @@ Even for GET requests and WebSocket connections, you need to include a body hash
114
115
115
116
Below are complete examples for authenticating with the Data Streams API in various languages. Each example shows how to properly generate the required headers and make a request.
Copy file name to clipboardExpand all lines: src/content/data-streams/reference/data-streams-api/authentication/javascript-examples.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@ import DataStreams from "@features/data-streams/common/DataStreams.astro"
15
15
16
16
Below are complete examples for authenticating with the Data Streams API in JavaScript, using Node.js. Each example shows how to properly generate the required headers and make a request.
17
17
18
-
To learn more about the Data Streams API authentication, see the [Data Streams Authentication](/data-streams/reference/authentication) page.
18
+
To learn more about the Data Streams API authentication, see the [Data Streams Authentication](/data-streams/reference/data-streams-api/authentication) page.
19
19
20
-
**Note**: The Data Streams SDKs handle authentication automatically. If you're using the [Go SDK](/data-streams/reference/go-sdk) or [Rust SDK](/data-streams/reference/rust-sdk), you don't need to implement the authentication logic manually.
20
+
**Note**: The Data Streams SDKs handle authentication automatically. If you're using the [Go SDK](/data-streams/reference/data-streams-api/go-sdk) or [Rust SDK](/data-streams/reference/data-streams-api/rust-sdk), you don't need to implement the authentication logic manually.
Copy file name to clipboardExpand all lines: src/content/data-streams/reference/data-streams-api/authentication/rust-examples.mdx
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@ import DataStreams from "@features/data-streams/common/DataStreams.astro"
15
15
16
16
Below are complete examples for authenticating with the Data Streams API in Rust. Each example shows how to properly generate the required headers and make a request.
17
17
18
-
To learn more about the Data Streams API authentication, see the [Data Streams Authentication](/data-streams/reference/authentication) page.
18
+
To learn more about the Data Streams API authentication, see the [Data Streams Authentication](/data-streams/reference/data-streams-api/authentication) page.
19
19
20
-
**Note**: The Data Streams SDKs handle authentication automatically. If you're using the [Go SDK](/data-streams/reference/go-sdk) or [Rust SDK](/data-streams/reference/rust-sdk), you don't need to implement the authentication logic manually.
20
+
**Note**: The Data Streams SDKs handle authentication automatically. If you're using the [Go SDK](/data-streams/reference/data-streams-api/go-sdk) or [Rust SDK](/data-streams/reference/data-streams-api/rust-sdk), you don't need to implement the authentication logic manually.
21
21
22
22
## API Authentication Example
23
23
@@ -229,7 +229,7 @@ While this example demonstrates the authentication mechanism, production applica
229
229
-**Resource management**: Implement graceful shutdown for long-running connections
230
230
-**Testing**: Add unit tests for HMAC generation and integration tests for API calls
231
231
232
-
For production use, consider using the [Rust SDK](/data-streams/reference/rust-sdk) which handles authentication automatically and provides built-in fault tolerance.
232
+
For production use, consider using the [Rust SDK](/data-streams/reference/data-streams-api/rust-sdk) which handles authentication automatically and provides built-in fault tolerance.
233
233
234
234
## WebSocket Authentication Example
235
235
@@ -530,4 +530,4 @@ While this example demonstrates WebSocket authentication, production application
530
530
-**Graceful shutdown**: Properly close WebSocket connections with close frames
531
531
-**Testing**: Add tests for connection handling and message parsing
532
532
533
-
For production use, consider using the [Rust SDK](/data-streams/reference/rust-sdk) which handles authentication automatically and provides built-in fault tolerance.
533
+
For production use, consider using the [Rust SDK](/data-streams/reference/data-streams-api/rust-sdk) which handles authentication automatically and provides built-in fault tolerance.
Copy file name to clipboardExpand all lines: src/content/data-streams/reference/data-streams-api/authentication/typescript-examples.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@ import DataStreams from "@features/data-streams/common/DataStreams.astro"
15
15
16
16
Below are complete examples for authenticating with the Data Streams API in TypeScript, using Node.js. Each example shows how to properly generate the required headers and make a request.
17
17
18
-
To learn more about the Data Streams API authentication, see the [Data Streams Authentication](/data-streams/reference/authentication) page.
18
+
To learn more about the Data Streams API authentication, see the [Data Streams Authentication](/data-streams/reference/data-streams-api/authentication) page.
19
19
20
-
**Note**: The Data Streams SDKs handle authentication automatically. If you're using the [Go SDK](/data-streams/reference/go-sdk) or [Rust SDK](/data-streams/reference/rust-sdk), you don't need to implement the authentication logic manually.
20
+
**Note**: The Data Streams SDKs handle authentication automatically. If you're using the [Go SDK](/data-streams/reference/data-streams-api/go-sdk) or [Rust SDK](/data-streams/reference/data-streams-api/rust-sdk), you don't need to implement the authentication logic manually.
0 commit comments